Skip to main content
GET
v2 macro

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:series

series: one BACEN SGS series. inflation: the IPCA set (headline, cores, groups, diffusion) with 12-month accumulation. inflation_items: IBGE's IPCA item tree with weights. fx: BACEN PTAX buy and sell rates. expectations: the BCB Focus survey path. Default: series.

Available options:
series,
inflation,
inflation_items,
fx,
expectations
id
string

By kind: series takes an SGS series label or code (SELIC_META, CDI, IGPM, 432); inflation takes one series label (IPCA, IPCA_CORE_EX0, ...; none: every series); inflation_items takes an IBGE structure number or SIDRA item code (none: the groups); expectations takes a Focus indicator (IPCA, Selic, ...; none: every indicator). Required for kind series. Kind fx takes no id. 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.

family
enum<string>
default:all

Hidden parameter (?help=all lists it). kind inflation: headline, core, classification, diffusion or group (all: every family). kind expectations: the Focus survey, annual (the default), monthly, selic (COPOM meetings) or inflation_12m. Default: all.

Available options:
all,
headline,
core,
classification,
diffusion,
group,
annual,
monthly,
selic,
inflation_12m
currency
string
default:USD

Hidden parameter (?help=all lists it). kind fx: an ISO code held (USD, EUR, GBP, JPY, ARS). all: every currency, from the api.ptax_daily view (paged with order + limit + offset). Default: USD.

horizon
string

Hidden parameter (?help=all lists it). kind expectations: the target horizon exactly as BACEN publishes it: a year (2027) for annual, MM/YYYY for monthly, a COPOM meeting (R6/2028) for selic. Default: family annual: the current year (UTC-3); every other survey needs one.

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.