POST
/
api
/
v1
/
bond_search
curl --request POST \
  --url https://terrapinfinance.com/api/v1/bond_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "countries": [
    "Italy"
  ],
  "coupon_max": 4,
  "coupon_min": 3,
  "maturity_date_max": "2028-11-01",
  "maturity_date_min": "2028-10-22"
}'
{
  "data": [
    {
      "coupon": 3.4,
      "currency": "EUR",
      "isin": "IT0004423494",
      "issuer_name": "BANCO BPM SPA",
      "maturity_date": "2028-10-30",
      "ticker": "BPIM 3.4 10/30/28"
    },
    {
      "coupon": 3.75,
      "currency": "EUR",
      "isin": "IT0005571952",
      "issuer_name": "BPER BANCA SPA",
      "maturity_date": "2028-10-22",
      "ticker": "BPEIM 3.75 10/22/28 EMTN"
    }
  ],
  "total": 2
}

Authorizations

​
Authorization
string
header
required

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.

Example:

5

​
coupon_min
number

Minimum coupon of the bond.

Example:

1

​
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.

Example:

true

​
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.

Example:

false

​
include_puttable
boolean

Whether to include puttable bonds.

Example:

false

​
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
Example:

2500000000

​
issued_amount_min
integer

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

Required range: x >= 0
Example:

10000000

​
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.

Example:

"2023-01-02"

​
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.

​
limit
integer
default:100

Result count limit. E.g. if total number of results is 1450, limit of 100 with offset of 0 would return the first 100 results. Use limit of -1 to opt out of limits.

Required range: x >= -1
​
maturity_date_max
string

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

Example:

"2026-12-14"

​
maturity_date_min
string

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

Example:

"2024-09-14"

​
maturity_types
enum<string>[]

Maturity types.

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

Offset for query pagination. E.g. limit of 100 with offset of 50 would return the results 50 to 150.

Required range: x >= 0
​
sort
enum<string>[]

Sort order. Prefix with '-' for descending order.

Available options:
ticker,
issuer_name,
isin,
currency,
coupon,
maturity_date,
country,
-ticker,
-issuer_name,
-isin,
-currency,
-coupon,
-maturity_date,
-country
​
yield_to_maturity_max
number

Maximum yield to maturity of the bond.

Example:

5

​
yield_to_maturity_min
number

Minimum yield to maturity of the bond.

Example:

1

Response

200
application/json
Partial reference data
​
data
object[]
required

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

Response schema per bond.

​
total
integer
required

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

DevelopmentReference Data