Skip to main content
POST
Daily, weekly or monthly OHLCV bars for a stock, ETF or index. Returns a normalized Candle page.

Authorizations

Authorization
string
header
required

AgentKey API key (ak_…).

Body

application/json
symbol
string
required

Ticker: AAPL, 0700.HK, 600519.SH, 000001.SZ.

end
string<date>

Latest bar date, YYYY-MM-DD (inclusive); default today.

fields
string[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_raw
boolean
default:false

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

interval
enum<string>
default:1d

Bar size.

Available options:
1d,
1wk,
1mo
limit
integer
default:100

Maximum number of bars to return.

Required range: 1 <= x <= 500
provider
string

Shorthand for routing.only = [provider].

routing
object

Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider.

start
string<date>

Earliest bar date, YYYY-MM-DD. Required for every market except A-shares and Hong Kong daily bars.

Response

Success envelope

Success envelope whose data is a CandlePage.

attempts
object[]
required
credits_charged
number
required

Credits charged for this call (the method's fixed price).

data
object
required

One page of OHLCV bars, most recent first.

op
string
required

Method name.

op_version
integer
required

Method version that served the call.

provider
string
required

Provider that actually served the call.

request_id
string
required

Correlation id; quote it in support requests.

took_ms
integer
required
unsupported_fields
string[]
required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

raw
any

Upstream payload, only with include_raw=true. Not a stable contract.

raw_truncated
boolean