Skip to main content
GET
v2 prices

Authorizations

apikey
string
header
default:sb_publishable__yfFQsykAglrvc9GS6_PYw_B24ex437
required

The public publishable key. It identifies the project, not you, and is the anonymous tier.

Query Parameters

kind
enum<string>
default:history

history: one ticker's daily series. latest: its newest session. session: every quote of one session (the seven price views in one). index: a B3 index's daily levels. forward: B3 FORWARD-segment prints (fixed-income ETFs COTAHIST does not carry). Default: history.

Available options:
history,
latest,
session,
index,
forward
freq
enum<string>
default:day

kind history, index, forward. month: the last session of each month, selected from the daily rows (no interpolation; a month with no session has no row). Default: day.

Available options:
day,
month
adjust
enum<string>
default:split

kind history. split: close_adj (splits, groupings, bonus shares; no dividends). none: the raw close as traded. Every row carries adjusted (true or false); the other kinds are never adjusted. Default: split.

Available options:
split,
none
id
string

By kind: history, latest take a B3 ticker (PETR4); session takes a B3 ticker (none: every ticker of the session); index takes a B3 index code (IBOV, IFIX, ...); forward takes a B3 FORWARD-segment ticker. With no id, kinds history, latest read api.research_universe (what SILO holds). Default: none.

from
string<date>

First date of the window, YYYY-MM-DD. Default: the resource's default window, counted back from to.

to
string<date>

Last date of the window, YYYY-MM-DD. Default: the latest complete period, from coverage.

limit
integer

The page size. More rows than one page come through next_page_url, never cut silently; a call stops at the tier's rows-per-call cap with meta.tier_cap_reached. Default: the tier's page maximum (10 anonymous, 100 signed in); a larger value is coerced to it.

Required range: x >= 1
cursor
string

The opaque cursor from a previous next_page_url. It carries every other parameter: send it alone (another parameter with a different value is bad_request). Default: none: the first page.

board
string

Hidden parameter (?help=all lists it). kind history, latest, session. A BDI board code (02 is the standard lot). Default: all boards: the series follows the ISIN across boards.

asset_class
enum<string>
default:all

Hidden parameter (?help=all lists it). kind session. all: api.quotes (standard lot, tpmerc 010). Each class reads its own view (equities, bdrs, units, fund_quotas, cash_securities: standard, odd and block lots, with lot on the row; auctions: tpmerc 017), with every column it publishes. Default: all.

Available options:
all,
equity,
bdr,
unit,
fund_quota,
cash_security,
auction
fields
enum<string>
default:core

Hidden parameter (?help=all lists it). core: a short set (history: ticker, trade_date, close_adj or close, isin). all: every column the endpoint publishes. index and forward publish few columns, so core is all of them. Default: core.

Available options:
core,
all
date
string<date>

Hidden parameter (?help=all lists it). kind session. The session date, YYYY-MM-DD. Default: the latest session in the 14 days to today that matches the other filters.

Response

The v2 envelope.

data
any[]
required

Always a list. Rows as the endpoint returned them; null stays null.

meta
object
required
next_page_url
string

Present only when more rows remain. It carries one opaque cursor.