Skip to main content
POST
Screen instruments

Authorizations

X-API-Key
string
header
required

Body

application/json
symbols
string[]

Specific tickers to screen (max 50). Available on every plan.

Maximum array length: 50
Example:
status

Filter by compliance status (Plus plan). String or array.

Available options:
compliant,
non-compliant,
pending
sector
string

Filter by sector, e.g. "Technology" (Plus plan).

market_cap

Filter by market-cap band (Plus plan). String or array.

Available options:
small,
mid,
large,
mega
health

Filter by financial health (Plus plan). String or array.

Available options:
fragile,
robust,
antifragile
limit
integer
default:50
Required range: x <= 100
offset
integer
default:0

Response

Screening results

data
object[]
meta
object