Skip to main content
GET
v2 panel

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

metric
string
default:auto

Comma-separated catalog metric names (close, close_adj, close_return, volume, nav, delinquency, ...). auto: each id's family default, as api.panel with no p_metrics (close_adj for shares and units, close for other tickers, settlement_rate for futures, nav for funds). Comma-separated list. Default: auto.

freq
enum<string>
default:month

month: the last session of each month for tickers, the filed month for funds. day: tickers and futures only (funds file monthly). Default: month.

Available options:
month,
day
family
enum<string>
default:auto

auto: every family a CNPJ files under (a CNPJ filing as fi and fidc yields one row per family). One family narrows the fund rows to it; with no id it walks that family (universe mode). Default: auto.

Available options:
auto,
fi,
fidc,
fii,
fip,
fiagro
id
string

The id is a comma-separated list of tickers, fund CNPJs, option or termo tickers and futures codes, up to the tier's id ceiling. 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.

min_nav
number

Hidden parameter (?help=all lists it). Universe mode only: keep funds whose latest NAV in the window is at least this, BRL. Default: none: no floor.

Required range: x >= 0
min_months
integer

Hidden parameter (?help=all lists it). Universe mode only: keep funds with at least this many observations of the first metric. Default: none: no floor.

Required range: x >= 0

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.