sloe/ developers
API reference

Compare an institution with its peer group

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

Uses the existing current-and-retained latest-filing peer cohort, excluding the target. Defaults to its asset tier. Retained targets or fewer than three peers return available=false. 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^[1-9]\d*$
states?string

Comma-separated uppercase state codes.

asset_tiers?string

Comma-separated mega, large, mid, small, micro.

min_assets?string

Nonnegative exact decimal asset lower bound.

max_assets?string

Nonnegative exact decimal asset upper bound.

charter_type?string

Federal or state charter.

Value in"fcu""cu"
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.

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

Compare an institution with its peer group

application/json
  1. response
ok*unknown
trace_id*string
data*
Example Request
curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-peers?charter=1367' \  -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"    },    "available": true,    "unavailable_reason": "string",    "target": {      "charter": "string",      "name": "string",      "state": "string",      "asset_tier": "string",      "period": "string",      "current": true,      "net_worth_ratio_pct": 0,      "delinquency_ratio_pct": 0,      "return_on_assets_pct": 0,      "loan_to_share_ratio_pct": 0,      "net_charge_off_ratio_pct": 0,      "assets_usd": 0,      "memberships": 0    },    "peer_count": 0,    "population": {},    "metric_version": "string",    "metrics": {      "net_worth_ratio_pct": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      },      "delinquency_ratio_pct": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      },      "return_on_assets_pct": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      },      "loan_to_share_ratio_pct": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      },      "net_charge_off_ratio_pct": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      },      "assets_usd": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      },      "memberships": {        "label": "string",        "targetValue": 0,        "mean": 0,        "median": 0,        "p25": 0,        "p75": 0,        "min": 0,        "max": 0,        "percentileRank": 0,        "betterDirection": "higher",        "availableCount": 0,        "staleCount": 0,        "targetDisplay": "string"      }    },    "available_counts": {      "net_worth_ratio_pct": 0,      "delinquency_ratio_pct": 0,      "return_on_assets_pct": 0,      "loan_to_share_ratio_pct": 0,      "net_charge_off_ratio_pct": 0,      "assets_usd": 0,      "memberships": 0    },    "peers": [      {        "charter": "string",        "name": "string",        "state": "string",        "asset_tier": "string",        "period": "string",        "current": true,        "net_worth_ratio_pct": 0,        "delinquency_ratio_pct": 0,        "return_on_assets_pct": 0,        "loan_to_share_ratio_pct": 0,        "net_charge_off_ratio_pct": 0,        "assets_usd": 0,        "memberships": 0      }    ],    "returned_peers_limit": 50,    "current_release": {      "id": "string",      "period": "string",      "coverage": {}    }  }}