Skip to content
oneapi.finance API Reference

Changelog

This page records every notable change to the oneapi.finance public API. Bug fixes that do not change the wire format are recorded only when they affect customer-observable behavior.

Versioning policy

Path-based major versions: /v1, /v2, etc. We commit to:

  1. Maintain a major version for at least 24 months after its successor ships. Customers have a long, predictable migration window.
  2. Treat the rules in conventions as the contract. What counts as breaking is defined in API overview.
  3. Announce deprecations 90 days before they take effect. A deprecated field continues to be returned with the old shape; a deprecated endpoint continues to respond. New consumers receive the warning in the Deprecation and Sunset response headers.
  4. Never silently change a field’s units, type, or semantics. Any such change ships as a new field with a new name; the old field is deprecated then removed in the next major version.

Release notation

Releases are dated. We do not run a semver minor on the API itself, only on the client packages (oneapi-core Python, hand-written TypeScript).

Each entry uses one of the following tags:

  • Added — new endpoint, new optional field, new error code.
  • Changed — observable behavior change inside an existing endpoint that is not breaking by our policy.
  • Fixed — bug fix.
  • Deprecated — slated for removal in the next major version.
  • Removed — gone (only ever in a major-version bump).

2026-05-04 — Initial scaffold

Added

  • Initial public scaffold of the v1 API. All endpoints listed in the API reference are reachable.
  • /v1/quote — single and batched (up to 8 symbols).
  • /v1/time_series — intervals from 1min to 1month. Adjusted by default.
  • /v1/statistics — valuation, profitability, dividends.
  • /v1/profile — sector, industry, identifiers.
  • /v1/dividends — history per symbol with declaration, ex, record, payment dates.
  • /v1/splits — split history with ratio_from / ratio_to.
  • /v1/symbol_search — fuzzy lookup with hybrid trigram + vector ranking.
  • /v1/fx/time_series — daily FX history.
  • /v1/stocks — universe enumeration with cursor pagination.
  • /v1/usage — quota status, per-key and per-endpoint counters.
  • Standardized error envelope (code, message, status, details).
  • meta.source and meta.fetched_at on every quote and time-series response.
  • Bearer-token authentication (oa_live_*, oa_test_*).
  • GCRA per-minute and monthly quota enforcement.
  • Pydantic v2 models published in oneapi-core Python package.

This is the starting baseline for the v1 API. Subsequent dated entries below this one will record changes against this baseline.

What’s planned (non-binding)

The following are on the roadmap but not committed to a release date:

  • GET /v1/financials — full income, balance, cash-flow statements per period.
  • GET /v1/options/chain — equity option chains.
  • GET /v1/insider/transactions — Form 4 history.
  • Field-level provenance on /v1/statistics (meta.provenance).
  • Edge POPs in APAC (currently EU + US east).
  • Webhooks for corporate-action events.

See also