Skip to main content
GET
Corporate bond screener

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Query Parameters

as_of
string

Public information through this UTC date, YYYY-MM-DD.

q
string

Instrument or issuer contains; max 100 characters.

currency
string

Native ISO currency in upper case, e.g. USD.

kind
enum<string>

Instrument kind: note includes subordinated, Tier 2 and AT1 notes; sukuk includes AT1 sukuk; loan is term loans and loans; capital is equity-classified capital instruments.

Available options:
bond,
note,
sukuk,
loan,
capital,
group
include_prior
boolean
default:true

Include prior-only disclosures; these do not establish current outstanding status.

include_matured
boolean
default:false

Include matured instruments and those the issuer shows as repaid or redeemed or the exchange delisted; default excludes them without deleting their evidence.

sort
enum<string>
default:maturity

Amounts sort by their USD value at the cutoff (daily reference rates); an amount whose currency has no rate sorts last.

Available options:
maturity,
coupon,
amount,
issuer
direction
enum<string>
default:asc

Sort direction.

Available options:
asc,
desc
limit
integer
default:25

Instruments per page, 1–100 (above 100 is a 400). Each instrument brings its cited sources, ~6 KB.

Required range: 1 <= x <= 100
cursor
string

page_info.nextCursor from the previous page (next_cursor is its deprecated alias); page_info.hasMore is false on the last page. Revision-bound: restart from the first page if the data or filters change.

company
string[]

Repeat for up to 50 exact CIKs or platform keys.

Response

OK

Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.

debt
object