Search branch and office locations
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.
All licensed office records, including unmapped offices. Office source dates and financial periods are separate; missing source is not zero offices.
bearerApiKeyAuthorizationBearer <CUWIREDATA_API_KEY>Send as Authorization: Bearer <CUWIREDATA_API_KEY>. Keys must have tier data_access.
charter?stringNCUA charter number.
^[1-9]\d*$state?stringTwo-letter state or territory code.
^[A-Z]{2}$city?stringExact case-insensitive city name.
limit?integerMaximum results per request.
1 <= value <= 20050offset?integerZero-based continuation offset. A nonzero value requires the documented release pin.
0 <= value <= 1000000release_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.
Search branch and office locations
application/json- response
ok*unknowntrace_id*stringdata*curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-branches' \ -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": [ { "charter": "string", "institution_name": "string", "site_id": "string", "name": "string", "site": "string", "address": "string", "city": "string", "state": "string", "zip": "string", "phone": "string", "office_type": "string", "source_as_of": "string", "context_source_id": "string", "financial_period": "string", "office_ordinal": 0, "is_main_office": true, "current": true, "latitude": 0, "longitude": 0 } ], "total": 0, "offset": 0, "limit": 0, "next_offset": 0, "source": "string", "coverage": { "institutions": 0, "institutions_with_office_source": 0, "institutions_without_office_source": 0 } }}Return one current institution profile GET
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.
Read institution financial history GET
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.