sloe/ developers
API reference

Return one current institution profile

Published REST contract · Bearer authentication · Download OpenAPI

Response examples are generated from the schema and contain placeholders; they are not live institution records. Run requests from your server with your own Data Access key.

GET
/api/cuwiredata-institution

Returns one current or retained institution profile from the selected release, preserving its filing period. Financial views include balances, ratios, benchmark percentiles, capitalization, branch summary and history. The explicit reported view instead returns original source field strings. Default financial reads include published current individual reports when enabled. release identifies the immutable historical product; current_release identifies the newer report layer. An explicit release_id alone or period keeps historical behavior. Missing current reports retain their own last-known period. Current list continuations require both release_id and current_release_id.

Authorization

bearerApiKey
headerAuthorizationBearer <CUWIREDATA_API_KEY>

Send as Authorization: Bearer <CUWIREDATA_API_KEY>. Keys must have tier data_access.

Query Parameters

charter*string

NCUA charter number.

Match^\d+$
platform_release_id?string

Pin the current platform artifact release. A mismatch returns 409. Reuse the X-CUWire-Release response header.

release_id?string

Reuse data.release.id to pin subsequent requests. Product and analytics views accept an older approved release by exact ID; unavailable IDs return503. Artifact delivery returns 409 on a changed release. The reported view accepts its source release ID; unavailable source releases return 503.

period?string

Optional selected-release period assertion for product/analytics views; mismatch returns 409. Not a historical range selector and not used by reported view.

Match^\d{4}-Q[1-4]$
view?string

Omit for the configured default. Explicit product and analytics views require their enabled approved reader. The reported view returns original source field strings with source provenance.

Value in"product""analytics""reported"
current_report?"1"

Include the separately published current individual reports with an explicitly pinned historical product.

Value in"1"
current_release_id?string

Pin data.current_release.id across current-report requests. Pair with release_id for pagination; mismatch returns 409.

Response Body

Institution profile

application/json
  1. response
ok*unknown
trace_id*string
data*|
Example Request
curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-institution?charter=1367' \  -H "Authorization: Bearer $SLOE_API_KEY"
Example Response
{  "ok": true,  "trace_id": "string",  "data": {    "institution": {      "charter": "string",      "name": "string",      "city": "string",      "state": "string",      "charter_type": "string",      "asset_tier": "string",      "asset_tier_label": "string",      "website": "string",      "health": "string",      "field_of_membership": "string",      "data_status": "string",      "profile_url": "string",      "app_url": "string",      "health_method": "string",      "period": "string",      "health_period": "string",      "as_of_date": "2019-08-24",      "source": "string",      "current": true    },    "balances": {      "assets_usd": 0,      "total_loans_usd": 0,      "total_shares_usd": 0,      "net_worth_usd": 0,      "real_estate_loans_usd": 0,      "auto_loans_usd": 0,      "credit_card_loans_usd": 0,      "commercial_loans_usd": 0,      "member_business_loans_usd": 0,      "allowance_for_loan_losses_usd": 0,      "certificates_usd": 0,      "money_market_shares_usd": 0,      "regular_shares_usd": 0,      "share_drafts_usd": 0    },    "performance": {      "net_income_usd": 0,      "interest_income_usd": 0,      "interest_expense_usd": 0,      "net_interest_income_usd": 0,      "fee_income_usd": 0,      "noninterest_income_usd": 0,      "noninterest_expense_usd": 0,      "provision_for_loan_losses_usd": 0,      "operating_expense_usd": 0    },    "ratios": {      "net_worth_ratio_pct": 0,      "return_on_assets_pct": 0,      "delinquency_ratio_pct": 0,      "net_charge_off_ratio_pct": 0,      "loan_to_share_ratio_pct": 0,      "net_interest_margin_pct": 0,      "cost_of_funds_pct": 0,      "fee_income_ratio_pct": 0,      "efficiency_ratio_pct": 0    },    "capitalization": {      "classification": "string",      "standard_classification": "string",      "new_credit_union_classification": "string",      "classification_rule": "string",      "classification_basis": "string",      "net_worth_ratio_call_report_pct": 0,      "risk_based_capital_ratio_pct": 0,      "uninsured_secondary_capital_usd": 0,      "subordinated_debt_included_in_net_worth_usd": 0,      "subordinated_debt_total_usd": 0,      "subordinated_debt_less_than_one_year_usd": 0,      "subordinated_debt_one_to_three_years_usd": 0,      "subordinated_debt_greater_than_three_years_usd": 0,      "rbc_subordinated_debt_usd": 0,      "cculr_elected": true,      "source_accounts": {},      "classification_source_account": "string",      "classification_is_regulatory_determination": true    },    "ratio_benchmarks": [      {        "key": "string",        "label": "string",        "category": "string",        "source_key": "string",        "value": 0,        "percentile": 0      }    ],    "branches": {      "count": 0,      "states": [        "string"      ]    },    "history": [      {        "period": "string",        "assets_usd": 0,        "total_loans_usd": 0,        "total_shares_usd": 0,        "net_worth_ratio_pct": 0,        "return_on_assets_pct": 0,        "delinquency_ratio_pct": 0,        "net_charge_off_ratio_pct": 0,        "loan_to_share_ratio_pct": 0,        "members": 0,        "net_worth_usd": 0      }    ],    "metric_definitions": {      "property1": "string",      "property2": "string"    },    "release": {      "id": "string",      "period": "string",      "metric_version": "string",      "source": "string",      "manifest_sha256": "string",      "implementation_sha256": "string",      "component_releases": {},      "metric_definitions": {        "property1": "string",        "property2": "string"      },      "coverage": {},      "validation": {},      "source_releases": {},      "verified_fields": [        "string"      ],      "history_scope": "string",      "limitation": "string",      "source_sha256": "string",      "source_url": "string",      "archive_url": "string"    },    "provenance": {},    "coverage": {},    "current_release": {      "id": "string",      "period": "string",      "coverage": {}    },    "members": 0  }}