API reference overview

This is the canonical API reference. Every endpoint lives at https://api.oneapi.finance under the /v1 prefix and accepts a bearer token in the Authorization header. All responses are JSON.

Base URL

https://api.oneapi.finance

There is no separate sandbox host. Test-mode keys (oa_test_...) hit the same host and the same paths but are restricted as described in authentication.

Versioning

The current major version is v1. The version is part of the path (/v1/quote, not a header). Breaking changes get a new major version (/v2/...); we maintain /v1 for at least 24 months after /v2 ships.

What counts as a breaking change:

• Removing or renaming a top-level response field.
• Changing the HTTP status returned for an existing scenario.
• Requiring a previously optional parameter.
• Tightening validation in a way that rejects previously valid input.

What does not count as a breaking change:

• Adding a new optional parameter.
• Adding a new field inside meta or details.
• Adding new error code values for existing status codes.
• Adding new endpoints.

The changelog records every release.

Common parameters

These work on every endpoint that returns instrument data:

Param	Type	Default	Notes
format	json | csv	json	CSV is supported on time-series, dividends, splits, fx.

These work on every range-aware endpoint:

Param	Type	Default	Notes
outputsize	int	endpoint-specific	Capped at 5,000.
start_date	ISO date or datetime	none	Inclusive.
end_date	ISO date or datetime	now	Inclusive.

See pagination for the full ranges story.

Endpoint index

Method	Path	Description
GET	/v1/quote	Latest quote for a single symbol or a batch of up to 8.
GET	/v1/time_series	Historical OHLCV at intervals from 1-minute to 1-month.
GET	/v1/statistics	Snapshot of valuation, profitability, and dividend metrics.
GET	/v1/profile	Company profile, sector, industry, identifiers.
GET	/v1/dividends	Dividend history per symbol.
GET	/v1/splits	Stock split history per symbol.
GET	/v1/symbol_search	Fuzzy-match a query string to instruments.
GET	/v1/fx/time_series	Daily FX history for a currency pair.
GET	/v1/stocks	Browse the canonical instrument universe.
GET	/v1/usage	Current quota status for your customer.

Conventions

• All paths are lowercase. Underscores, not hyphens.
• All request bodies on POST/PUT (currently none in v1) are JSON.
• All response bodies on errors use the standard envelope.
• All timestamps are ISO 8601 UTC with Z suffix.
• All numeric prices are JSON numbers, not strings.

What’s next

• Pick an endpoint from the index above.
• Or read the migration guide if you are coming from a similar provider.