sloe/ developers
API reference

Read native quarterly industry totals

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-industry-trends

Native federally insured filers (CU_TYPE 1 and 2) in each quarter, with period-specific state. Includes institutions absent from the current roster. Exact balance sums are null when any contributing value is missing. Memberships are not unique people.

Authorization

bearerApiKey
headerAuthorizationBearer <CUWIREDATA_API_KEY>

Send as Authorization: Bearer <CUWIREDATA_API_KEY>. Keys must have tier data_access.

Query Parameters

from_period?string

Inclusive historical range boundary.

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

Inclusive historical range boundary.

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

Two-letter state or territory code.

Match^[A-Z]{2}$
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

Read native quarterly industry totals

application/json
  1. response
ok*unknown
trace_id*string
data*
Example Request
curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-industry-trends' \  -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": [      {        "period": "string",        "current_filing_credit_unions": 0,        "total_assets_usd": 0,        "total_loans_usd": 0,        "total_shares_usd": 0,        "total_net_worth_usd": 0,        "total_memberships": 0,        "available_counts": {          "property1": 0,          "property2": 0        },        "source_release_id": "string",        "source_manifest_sha256": "string"      }    ],    "endpoint_contract": "native-insured-industry-totals-v1",    "history_release_id": "string",    "history_manifest_sha256": "string",    "population": "native_federally_insured_filers_in_each_period",    "state": "string",    "metric_definitions": {      "property1": {        "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      },      "property2": {        "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      }    },    "membership_unit": "string",    "count": 0  }}