Bond Search
This endpoint returns a list of bonds with a small set of fields. It is intended for search according to the filters provided.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Asset classes.
bond
, medium-term note
, convertible note
Countries of issuing entities. Match partial name.
Maximum coupon of the bond.
Minimum coupon of the bond.
Bond currencies, 3-letter ISO 4217 code.
Return full reference data as in from /api/v1/bond_reference. This option requires a special account tier.
Bond handles.
de_bobl
, de_bund
, de_schatz
, de_ilb
, de_green
, de_bubill
, uk_gilt
, uk_green_gilt
, uk_il_gilt
, uk_bill
, fr_btf
, fr_oat
, fr_oatei
, fr_oati
Whether to include callable bonds.
Whether to include non-outstanding bonds. Setting to true will vastly increasse returned results; only set to true if bonds no longer outstanding are truly needed.
Whether to include puttable bonds.
Interest types.
fixed rate
, zero rate / discount rate
, variable rate
International Securities Identification Numbers of the bonds.
Maximum size of total amount issued (in nominal value).
x > 0
Minimum size of total amount issued (in nominal value).
x > 0
Issuer types.
corporate
, government
, municipal
Names of issuing entities. Match partial name
Include only bonds that have traded since this date.
Legal Entity Identifiers of issuing entities.
Legal Entity Identifiers of the direct parents of issuing entities.
Legal Entity Identifiers of the ultimate parents of issuing entities.
Maximum maturity date of the bond in YYYY-MM-DD format.
Minimum maturity date of the bond in YYYY-MM-DD format.
Maturity types.
fixed
, amortized
, perpetual
, extendible
Offset for query pagination. E.g. if this parameter is 1500, results 1501-2500 will be returned.
x > 0
Maximum yield to maturity of the bond.
Minimum yield to maturity of the bond.
Response
List of response data objects per bond. Contains at most 1000 objects.
Total number of results in the database that match the query filters.