# Documentation - [Build with Sloe Data](/docs): Credit union intelligence for agents, applications and the systems your team already uses. - [Make your first API call](/docs/quickstart): Read one institution with a Data Access key, then inspect the result. - [Access and authentication](/docs/authentication): Choose browser approval for research, or a licensed API key for your service. - Connect an agent - [Connect an agent](/docs/agents): Bring source-aware institution research into your existing harness. - [Connect Codex](/docs/agents/codex): Register Sloe’s hosted MCP server and approve browser access. - [Connect Claude](/docs/agents/claude): Add Sloe Data as a remote custom connector. - [Use a custom harness](/docs/agents/custom-harness): Connect through MCP, or wrap the licensed HTTP API in your own read tool. - [MCP tool catalog](/docs/agents/tools): A task map for the hosted connector’s 24 read-only tools. - Build an integration - [Build an integration](/docs/integrations): Use the licensed API behind your app, CRM or internal service. - [Your first verified download](/docs/integrations/first-download): Create a key, download a Parquet file and verify it before importing. - [Call Sloe from your backend](/docs/integrations/server-side): A small server-side client with input validation and explicit failures. - [Enrich CRM accounts](/docs/integrations/crm): Match by charter, retain provenance and keep the write step in your integration. - [Bulk delivery and file formats](/docs/integrations/bulk): Download a licensed quarterly package and verify what you received. - Understand the data - [Understand the data](/docs/data): Keep identity, time, units and evidence in your model. - [Periods, sources and releases](/docs/data/periods): Make “current” precise and keep historical reads reproducible. - [Pagination and consistency](/docs/data/pagination): Import all the pages from one coherent release. - [Coverage, missing values and precision](/docs/data/coverage): Preserve what the source establishes—and what it does not. - API reference - [API reference](/docs/reference): Generated from Sloe’s published OpenAPI contract. - [Return current CU system summary](/docs/reference/cu-summary): 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. - [Return a paginated institution list](/docs/reference/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. - [Return one current institution profile](/docs/reference/institution): Returns one current or retained institution profile from the selected release, preserving its filing period. Financial views include balances, ratios, benchmark percentiles, capitalization, branch summary and history. The explicit reported view instead returns original source field strings. 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. - [Search branch and office locations](/docs/reference/branches): All licensed office records, including unmapped offices. Office source dates and financial periods are separate; missing source is not zero offices. - [Read institution financial history](/docs/reference/history): 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 up to five institutions](/docs/reference/compare): 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. - [Compare an institution with its peer group](/docs/reference/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. - [Read native quarterly industry totals](/docs/reference/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. - [Search NCUA reported merger approvals and proposed notices](/docs/reference/mergers): Approved pairs report MAIR approval observations, not completed closings. Repeated monthly observations are retained under one charter-pair record. Proposed dates are member-vote dates. - [Search reviewed vendor relationships](/docs/reference/vendor-relationships): Dated first-party relationship evidence and reviewed technical inference. Inferred relationships identify a provider or platform family from public website fingerprints and do not establish a verified contract. Core-platform inference does not confirm the servicing provider. Reported in use is not independent current-contract verification. Empty results do not prove absence. Unreviewed research candidates and internal queues are excluded. - [Return quarterly data-feed metadata or issue a short-lived download broker link](/docs/reference/data-feed): Without a file parameter, returns the deployable manifest for a licensed quarterly feed. With file=archive or a package filename, returns a 302 redirect to a short-lived broker URL when backing storage is configured. - [Redeem a short-lived data-feed broker token](/docs/reference/data-feed-download): Normally reached through the Location header returned by /api/data-feed when a file is requested (curl -L redeems it in the same request). The token expires in 120 seconds by default, is single-use, and is bound to the customer of the requesting key: the same Authorization: Bearer key used for /api/data-feed is required here too. The broker rechecks the originating key, its bound customer, package release and any bound delivery revision, and refuses a second redemption of the same token. Current private packages redirect to a freshly signed storage URL; historical legacy packages retain their configured delivery. - Operate your integration - [Service, updates and support](/docs/support/service): What Data Access delivers, how updates reach you and where to get help. - [Errors, limits and retries](/docs/support/errors): Handle failures explicitly and keep imports recoverable. - [Security and network setup](/docs/support/security): Keep credentials on your server and understand the connection boundary. - [Contract and release history](/docs/support/releases): Published changes, coverage and how to keep imports compatible.