Skip to main content
POST
US agency bond search
This endpoint is soon to be deprecated. See Bond Search instead.

Authorizations

Authorization
string
header
required

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

Body

application/json
coupon_max
number

Maximum interest rate of the agency bond (in percentage). Only matches bonds with a fixed, numeric interest rate.

coupon_min
number

Minimum interest rate of the agency bond (in percentage). Only matches bonds with a fixed, numeric interest rate.

cursor
string | null

The next_cursor of the previous page. Leave out, or send null, for the first page. Only cursor and limit may change between pages. See Pagination.

full_reference_data
boolean

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

interest_types
enum<string>[]

Types of interest:

  • fixed rate: The bond pays a fixed interest rate throughout its life.
  • zero rate / discount rate: A bond that does not pay or accrue interest.
  • variable rate: The bond's interest rate can change over time, typically based on a reference rate or formula (e.g., SOFR, CPI).
  • step rate: The bond's interest rate increases ("steps up") at predetermined intervals.
  • fixed to float: The bond pays a fixed coupon for an initial period, then floats with a reference rate.
  • float to fixed: The bond pays a floating coupon for an initial period, then converts to a fixed rate.
Available options:
fixed rate,
fixed to float,
float to fixed,
step rate,
variable rate,
zero rate / discount rate
is_callable
boolean

Filter by whether the bond is callable.

isins
string[]

International Securities Identification Number (ISIN), unique 12-character code for the security.

Required string length: 12
issue_date_max
string<date>

Maximum issue date of the agency bond in ISO-8601 format (YYYY-MM-DD).

issue_date_min
string<date>

Minimum issue date of the agency bond in ISO-8601 format (YYYY-MM-DD).

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_name
enum<string>

Name of the issuing agency.

Available options:
FEDERAL HOME LOAN MORTGAGE CORPORATION,
FEDERAL NATIONAL MORTGAGE ASSOCIATION
limit
integer
default:100

Number of results per page. A limit of 0 returns only total, the number of matching results.

Required range: x >= 0
maturity_date_max
string<date>

Maximum maturity date of the agency bond in ISO-8601 format (YYYY-MM-DD).

maturity_date_min
string<date>

Minimum maturity date of the agency bond in ISO-8601 format (YYYY-MM-DD).

offset
integer
deprecated

Deprecated, will be removed on April 2, 2027. Use cursor instead, see Pagination. Number of results to skip. Can't be combined with cursor unless 0.

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

Fields to sort by. Prefix a field with '-' for descending order. Results with no value come last. See Order for how ties are broken.

Available options:
-interest_rate,
-interest_type,
-is_callable,
-isin,
-issuer_name,
-maturity_date,
-ticker,
interest_rate,
interest_type,
is_callable,
isin,
issuer_name,
maturity_date,
ticker
values_updated_since

Optional filter to only return bonds whose reference data has been updated since the given UTC instant.

Accepts an ISO-8601 date-time (YYYY-MM-DDThh:mm:ssZ), which is recommended since reference data can be updated multiple times per day.

A plain ISO-8601 date (YYYY-MM-DD) is also accepted for backwards compatibility but is deprecated, as it only resolves to the start of that day (00:00:00 UTC).

Response

Partial reference data

data
object[]
required

List of response data objects, often capped to 1000.

next_cursor
string | null
required

Send as cursor to get the next page. null on the last page, or when limit is 0.

total
integer
required

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