Return current CU system summary
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.
Returns coverage counts for current and retained institution profiles. Financial totals cover current filers; retained totals are separately identified. A period parameter asserts the selected product or analytics release period. 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.
bearerApiKeyAuthorizationBearer <CUWIREDATA_API_KEY>Send as Authorization: Bearer <CUWIREDATA_API_KEY>. Keys must have tier data_access.
platform_release_id?stringPin the current platform artifact release. A mismatch returns 409. Reuse the X-CUWire-Release response header.
release_id?stringReuse 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?stringOptional selected-release period assertion for product/analytics views; mismatch returns 409. Not a historical range selector and not used by reported view.
^\d{4}-Q[1-4]$view?stringOmit for the configured default. Explicit product and analytics views require their enabled approved reader.
"product""analytics"current_report?"1"Include the separately published current individual reports with an explicitly pinned historical product.
"1"current_release_id?stringPin data.current_release.id across current-report requests. Pair with release_id for pagination; mismatch returns 409.
Current system summary
application/json- response
ok*unknowntrace_id*stringdata*curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-cu-summary' \ -H "Authorization: Bearer $SLOE_API_KEY"{ "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_credit_unions": 0, "current_filing_credit_unions": 0, "last_known_credit_unions": 0, "total_members": 0, "last_known_members": 0, "total_assets_usd": 0, "total_loans_usd": 0, "total_shares_usd": 0, "last_known_assets_usd": 0, "last_known_loans_usd": 0, "last_known_shares_usd": 0, "financial_totals_scope": "string", "coverage": {}, "current_release": { "id": "string", "period": "string", "coverage": {} }, "complete_quarter": true }}API reference
Generated from Sloe’s published OpenAPI contract.
Return a paginated institution list GET
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.