POST
/
api
/
v1
/
muni_search
curl --request POST \
  --url https://terrapinfinance.com/api/v1/muni_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "interest_types": [
    "fixed rate"
  ],
  "issuers": [
    "ABAG FINANCE AUTHORITY FOR NONPROFIT CORPORATIONS"
  ],
  "maturity_date_min": "2030-10-30"
}'
{
  "data": [
    {
      "coupon": 5,
      "interest_type": "fixed rate",
      "is_callable": true,
      "isin": "US00037CUQ13",
      "issuer_name": "ABAG FINANCE AUTHORITY FOR NONPROFIT CORPORATIONS",
      "maturity_date": "2035-11-15",
      "rating": "investment_grade",
      "state": "CA",
      "ticker": "CA AFAGEN 5 11/15/2035"
    }
  ],
  "total": 1
}

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 coupon of the bond.

Example:

5

coupon_min
number

Minimum coupon of the bond.

Example:

1

full_reference_data
boolean

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

include_callable
boolean

Whether to include callable bonds.

Example:

true

interest_types
enum<string>[]

Interest types.

Available options:
fixed rate,
zero rate / discount rate,
variable rate
is_insured
boolean

Whether the bond is insured.

Example:

true

isins
string[]

International Securities Identification Numbers of the bonds.

issue_date_max
string

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

Example:

"2023-12-14"

issue_date_min
string

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

Example:

"2021-09-14"

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

issuers
string[]

Names of issuing entities. Match partial name.

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"

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:
isin,
ticker,
coupon,
maturity_date,
state,
issuer_name,
interest_type,
rating,
is_callable,
-isin,
-ticker,
-coupon,
-maturity_date,
-state,
-issuer_name,
-interest_type,
-rating,
-is_callable
sources_of_repayment
enum<string>[]

Sources of repayment.

Available options:
Revenue,
General Obligation,
Double Barrel
states
string[]

State codes of issuing entities.

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.