sloe/ developers
API reference

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.

GET
/api/cuwiredata-branches

All licensed office records, including unmapped offices. Office source dates and financial periods are separate; missing source is not zero offices.

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^[1-9]\d*$
state?string

Two-letter state or territory code.

Match^[A-Z]{2}$
city?string

Exact case-insensitive city name.

limit?integer

Maximum results per request.

Range1 <= value <= 200
Default50
offset?integer

Zero-based continuation offset. A nonzero value requires the documented release pin.

Range0 <= value <= 100000
Default0
release_id?string

Pin the approved product release returned by data.release.id.

Match^product-[a-f0-9]{24}$
period?string

Must match the selected product release; not a historical range filter.

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

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

Response Body

Search branch and office locations

application/json
  1. response
ok*unknown
trace_id*string
data*
Example Request
curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-branches' \  -H "Authorization: Bearer $SLOE_API_KEY"
Example Response
{  "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    }  }}