Read institution financial history
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.
Retained profile lineage plus latest filing, ordered by period. Includes native source charter and JOIN_NUMBER; not a historical industry population. 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.
bearerApiKeyAuthorizationBearer <CUWIREDATA_API_KEY>Send as Authorization: Bearer <CUWIREDATA_API_KEY>. Keys must have tier data_access.
charter*stringNCUA charter number.
^[1-9]\d*$from_period?stringInclusive historical range boundary.
^\d{4}-Q[1-4]$through_period?stringInclusive historical range boundary.
^\d{4}-Q[1-4]$release_id?stringPin the approved product release returned by data.release.id.
^product-[a-f0-9]{24}$period?stringMust match the selected product release; not a historical range filter.
^\d{4}-Q[1-4]$platform_release_id?stringPin the current platform artifact release. A mismatch returns 409. Reuse the X-CUWire-Release response header.
current_report?"1"Include the separately published current individual reports with an explicitly pinned historical product.
"1"current_release_id?stringPin data.current_release.id across current-report requests. Pair with release_id for pagination; mismatch returns 409.
Read institution financial history
application/json- response
ok*unknowntrace_id*stringdata*curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-history?charter=1367' \ -H "Authorization: Bearer $SLOE_API_KEY"{ "ok": true, "trace_id": "string", "data": { "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" }, "results": [ { "period": "string", "source_charter": "string", "source_join_number": "string", "source_release_id": "string", "assets_usd": 0, "total_loans_usd": 0, "total_shares_usd": 0, "net_worth_usd": 0, "members": 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, "unavailable_metrics": [ "string" ] } ], "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 }, "history_scope": "retained_institution_history", "available_periods": [ "string" ], "count": 0, "metric_definitions": { "a": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "l": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "s": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "m": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "nw": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "nwr": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "roa": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "dq": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "co": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "lts": { "metric": "string", "account": "string", "accounts": [ "string" ], "source_accounts": [ "string" ], "formula": "string", "meaning": "string", "unit": "string", "period_basis": "string", "status": "string", "aggregation": "string", "delivered_decimal_places": 0 }, "rounding": "string", "population": "string", "identity": "string", "unavailable": "string" }, "current_release": { "id": "string", "period": "string", "coverage": {} } }}Search branch and office locations GET
All licensed office records, including unmapped offices. Office source dates and financial periods are separate; missing source is not zero offices.
Compare up to five institutions GET
Existing named institution details on one approved release. Current and last-known filings retain their own periods; not_found lists missing charters. 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.