POST
/
api
/
v1
/
bond_search

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
asset_classes
enum<string>[]

Asset classes.

Available options:
bond,
medium-term note,
convertible note
countries
string[]

Countries of issuing entities. Match partial name.

coupon_max
number

Maximum coupon of the bond.

coupon_min
number

Minimum coupon of the bond.

currencies
string[]

Bond currencies, 3-letter ISO 4217 code.

full_reference_data
boolean

Return full reference data as in from /api/v1/bond_reference. This option requires a special account tier.

handles
enum<string>[]

Bond handles.

Available options:
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
include_callable
boolean

Whether to include callable bonds.

include_non_outstanding
boolean
default: false

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.

include_puttable
boolean

Whether to include puttable bonds.

interest_types
enum<string>[]

Interest types.

Available options:
fixed rate,
zero rate / discount rate,
variable rate
isins
string[]

International Securities Identification Numbers of the bonds.

issued_amount_max
integer

Maximum size of total amount issued (in nominal value).

Required range: x > 0
issued_amount_min
integer

Minimum size of total amount issued (in nominal value).

Required range: x > 0
issuer_types
enum<string>[]

Issuer types.

Available options:
corporate,
government,
municipal
issuers
string[]

Names of issuing entities. Match partial name

last_trade_date_min
string

Include only bonds that have traded since this date.

leis
string[]

Legal Entity Identifiers of issuing entities.

leis_direct_parent
string[]

Legal Entity Identifiers of the direct parents of issuing entities.

leis_ultimate_parent
string[]

Legal Entity Identifiers of the ultimate parents of issuing entities.

maturity_date_max
string

Maximum maturity date of the bond in YYYY-MM-DD format.

maturity_date_min
string

Minimum maturity date of the bond in YYYY-MM-DD format.

maturity_types
enum<string>[]

Maturity types.

Available options:
fixed,
amortized,
perpetual,
extendible
offset
integer
default: 0

Offset for query pagination. E.g. if this parameter is 1500, results 1501-2500 will be returned.

Required range: x > 0
yield_to_maturity_max
number

Maximum yield to maturity of the bond.

yield_to_maturity_min
number

Minimum yield to maturity of the bond.

Response

200 - application/json
data
object[]
required

List of response data objects per bond. Contains at most 1000 objects.

total
integer
required

Total number of results in the database that match the query filters.