Compare up to five institutions
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.
Existing named institution details on one approved release. Current and last-known filings retain their own periods; not_found lists missing charters. 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.
charters*stringOne to five distinct comma-separated charter numbers.
release_id?stringPin the approved product release returned by data.release.id.
^product-[a-f0-9]{24}$period?stringMust match the selected product release; not a historical range filter.
^\d{4}-Q[1-4]$platform_release_id?stringPin 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.
"1"current_release_id?stringPin data.current_release.id across current-report requests. Pair with release_id for pagination; mismatch returns 409.
Compare up to five institutions
application/json- response
ok*unknowntrace_id*stringdata*curl --fail-with-body --silent --show-error 'https://sloedata.com/api/cuwiredata-compare?charters=1367%2C1' \ -H "Authorization: Bearer $SLOE_API_KEY"{ "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" }, "comparison_scope": "licensed_current_and_retained_latest_filings", "results": [ { "institution": { "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 }, "balances": { "assets_usd": 0, "total_loans_usd": 0, "total_shares_usd": 0, "net_worth_usd": 0, "real_estate_loans_usd": 0, "auto_loans_usd": 0, "credit_card_loans_usd": 0, "commercial_loans_usd": 0, "member_business_loans_usd": 0, "allowance_for_loan_losses_usd": 0, "certificates_usd": 0, "money_market_shares_usd": 0, "regular_shares_usd": 0, "share_drafts_usd": 0 }, "performance": { "net_income_usd": 0, "interest_income_usd": 0, "interest_expense_usd": 0, "net_interest_income_usd": 0, "fee_income_usd": 0, "noninterest_income_usd": 0, "noninterest_expense_usd": 0, "provision_for_loan_losses_usd": 0, "operating_expense_usd": 0 }, "ratios": { "net_worth_ratio_pct": 0, "return_on_assets_pct": 0, "delinquency_ratio_pct": 0, "net_charge_off_ratio_pct": 0, "loan_to_share_ratio_pct": 0, "net_interest_margin_pct": 0, "cost_of_funds_pct": 0, "fee_income_ratio_pct": 0, "efficiency_ratio_pct": 0 }, "capitalization": { "classification": "string", "standard_classification": "string", "new_credit_union_classification": "string", "classification_rule": "string", "classification_basis": "string", "net_worth_ratio_call_report_pct": 0, "risk_based_capital_ratio_pct": 0, "uninsured_secondary_capital_usd": 0, "subordinated_debt_included_in_net_worth_usd": 0, "subordinated_debt_total_usd": 0, "subordinated_debt_less_than_one_year_usd": 0, "subordinated_debt_one_to_three_years_usd": 0, "subordinated_debt_greater_than_three_years_usd": 0, "rbc_subordinated_debt_usd": 0, "cculr_elected": true, "source_accounts": {}, "classification_source_account": "string", "classification_is_regulatory_determination": true }, "ratio_benchmarks": [ { "key": "string", "label": "string", "category": "string", "source_key": "string", "value": 0, "percentile": 0 } ], "branches": { "count": 0, "states": [ "string" ] }, "history": [ { "period": "string", "assets_usd": 0, "total_loans_usd": 0, "total_shares_usd": 0, "net_worth_ratio_pct": 0, "return_on_assets_pct": 0, "delinquency_ratio_pct": 0, "net_charge_off_ratio_pct": 0, "loan_to_share_ratio_pct": 0, "members": 0, "net_worth_usd": 0 } ], "metric_definitions": { "property1": "string", "property2": "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" }, "provenance": {}, "coverage": {}, "current_release": { "id": "string", "period": "string", "coverage": {} }, "members": 0 } ], "not_found": [ "string" ], "current_release": { "id": "string", "period": "string", "coverage": {} } }}Read institution financial history GET
Retained profile lineage plus latest filing, ordered by period. Includes native source charter and JOIN_NUMBER; not a historical industry population. 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.
Compare an institution with its peer group GET
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.