Skip to main content
POST
Screen instruments

Authorizations

X-API-Key
string
header
required

Body

application/json
symbols
string[]

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

Same identifiers as /instruments/{symbol}: a bare US ticker or an exchange-prefixed listing (PAR:AI, HKG:2020). Each row echoes the identifier you sent in upper case, and one we hold no listing for comes back in meta.not_found. Dotted share classes (BRK.B) resolve here as everywhere.

Maximum array length: 50
Required string length: 1 - 20
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
country
string

Filter by country of domicile, an ISO 3166-1 alpha-2 code (Plus plan). A company listed in London but domiciled in Jersey is JE.

Example:

"GB"

sort
enum<string>
default:symbol

Filter-mode order. market_cap lists the largest first.

Available options:
symbol,
market_cap
limit
integer
default:50
Required range: x <= 100
offset
integer
default:0

Response

Screening results

data
object[]
meta
object