Data through Q2 2026 · 4,313 institutions
OptimaYield
Get started
Data through Q2 2026 · 4,313 institutions

Evidence API · v1

Build on published regulatory facts.

The stable v1 institution endpoint returns explicit version, freshness, attribution, pagination, null policy, publication boundary, and commercial-use metadata. Candidate intelligence is never represented as reviewed material.

Open API discovery
List governed reporting periodsGET /api/v1/periods

Stable v1 contract

List published banksGET /api/v1/banks

Stable v1 contract

q
string, max 100 chars
period
string, max 10 chars
page
integer, 1-, default 1
limit
integer, 1-100, default 20
sort
assets | asset-growth | deposits | loans | roa | roe | nim | capital | asset-quality | liquidity | brokered-deposits | loan-to-deposit | name
assets
all | 1-10 | 10-50 | 50-250 | 250+
state
string, max 2 chars
regulator
string, max 30 chars
charter
string, max 30 chars
peer
string, max 40 chars
Get one published bank by FDIC certificateGET /api/v1/banks/{certificate}

Stable v1 contract

certificate (required)
integer, 1-
period
string, max 10 chars
Legacy historyGET /api/banks/{certificate}/history

Legacy public route; migrate as versioned equivalents ship

Legacy filingsGET /api/sec/filings?cik=&form=

Legacy public route; migrate as versioned equivalents ship

Legacy intelligenceGET /api/intelligence/events?domain=&severity=

Legacy public route; migrate as versioned equivalents ship

OpenAPI 3.1 document (machine-readable source of the parameters above).

Public request

curl "https://www.optimayield.com/api/v1/banks?q=JPMorgan&limit=5"

The response includes API-Version, X-Data-Period, attribution and rate-limit headers. Invalid pagination uses the documented error envelope with the request ID.

Current boundaries

  • Public quota: 60 requests per 60 seconds, per client and route family (for example /api/banks/* or /api/v1/*); the legacy routes above are covered by the same limiter.
  • The current limiter is a best-effort abuse brake, not a distributed paid SLA.
  • Public facts need no key. Scoped keys, rotation, revocation, usage history and paid quotas remain unavailable until authenticated infrastructure is activated.
  • Commercial redistribution requires a written enterprise agreement.

API keys

Keys will be named, least-privilege scoped, rotatable and revocable. Usage and errors are recorded daily without storing request secrets.

Requested scopes

Secret values are shown exactly once after creation. This control remains disabled until authentication is configured.

v1stable public contract
60/minbest-effort public limit
Explicitfreshness and attribution
Review firstunreviewed intelligence excluded