sloe/ developers
API reference

Return a paginated institution list

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-institutions

Returns a bounded, filterable list from the licensed current-and-retained population of the selected release. Each row preserves its own filing period. Results use readable field names rather than internal compact codes. 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

q?string

Search charter, name, city, or state.

state?string
Match^[A-Z]{2}$
asset_tier?string
Value in"mega""large""mid""small""micro"
min_assets?number
max_assets?number
sort?string
Default"assets"
Value in"assets""members""name""net_worth_ratio""return_on_assets""delinquency""loan_to_share"
order?string
Default"desc"
Value in"asc""desc"
limit?integer
Range1 <= value <= 200
Default50
offset?integer
Range0 <= value
Default0
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.

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.

Value in"product""analytics"
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 list

application/json
  1. response
ok*unknown
trace_id*string
data*
Example Request
curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-institutions' \  -H "Authorization: Bearer $SLOE_API_KEY"
Example Response
{  "ok": true,  "trace_id": "string",  "data": {    "period": "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"    },    "as_of_date": "2019-08-24",    "source": "string",    "total": 0,    "limit": 1,    "offset": 0,    "results": [      {        "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,        "assets_usd": 0,        "net_worth_ratio_pct": 0,        "return_on_assets_pct": 0,        "delinquency_ratio_pct": 0,        "loan_to_share_ratio_pct": 0,        "members": 0,        "metric_availability": {          "unavailable_metrics": [            "string"          ],          "prior_dec": "string"        }      }    ],    "coverage": {},    "current_release": {      "id": "string",      "period": "string",      "coverage": {}    },    "population_scope": "string"  }}