Skip to main content
GET
v2 curves

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

snapshot: one curve on one session, every vertex, with its rate basis. history: one fixed vertex through time. vertices: the raw reference-rate rows (api.reference_rate) of one curve on one session. Default: snapshot.

Available options:
snapshot,
history,
vertices
curve
enum<string>
default:PRE

PRE: DI x pre. DOC: the clean onshore dollar coupon. DPL: the clean IPCA coupon (a real rate). Default: PRE.

Available options:
PRE,
DOC,
DPL
tenor
integer
default:360

kind history: the nominal tenor of one of B3's fixed vertices, in CALENDAR days (B3's vertex_code: 1, 30, 60, 90, ... 360, 720, ... 10800). 360 is the one-year vertex. Any other tenor is refused with the list, never interpolated. Default: 360.

Required range: x >= 0
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.

date
string<date>

Hidden parameter (?help=all lists it). kind snapshot and vertices: the B3 session, YYYY-MM-DD. Default: the newest session held for the curve (vertices: the newest in the 14 days to today).

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.