POST
/
api
/
v1
/
muni_search

Authorizations

Authorization
string
headerrequired

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.

coupon_min
number

Minimum coupon of the bond.

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.

interest_types
enum<string>[]

Interest types.

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

Whether the bond is insured.

isins
string[]

International Securities Identification Numbers of the bonds.

issue_date_max
string

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

issue_date_min
string

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

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
issuers
string[]

Names of issuing entities. Match partial name.

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.

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