Start trial

API reference

Screener

Filter an exchange's full listing by sector, market cap and fundamentals, sorted however you need.

Screen instruments

POST /v1/screener

10 credits per call Growth and up 20 credits with fresh=true Operation ID screener.run

Instruments matching every filter in the body, sorted and cut to limit. Leaving a filter out doesn't filter on it.

Query parameters

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Request body

  • depositaryReceipts boolean

    true keeps only depositary receipts like ADRs, false leaves them out

  • exchanges array of strings

    MICs or aliases like ASX

    Up to 50 items

  • fields array of strings

    Values to fill in. Leave out to fill every one, the rest come back null

  • industries array of strings

    Industry ids from /v1/sectors

    Up to 100 items

  • limit integer

    From 1 to 1000. Defaults to 100

  • marketCap object

    In each instrument's own currency

    Show 2 fields
    • max number

      At least 0

    • min number

      At least 0

  • order string

    Defaults to desc, or asc when sorting by name

    One of ascdesc

  • sort string

    One of market_capclosename

    Defaults to market_cap

  • types array of strings

    Up to 11 items

Response

  • data array of objects
    Show 6 fields
    • close number or null
    • currency string or null

      The currency close and marketCap are in

    • industry string or null

      An industry id from /v1/sectors

    • instrument object
      Show 7 fields
      • country string or null
      • currency string or null
      • id string
      • mic string or null
      • name string
      • symbol string
      • type string

        One of equityetffundindexfxcryptotokenratefuturecommoditybond

    • marketCap number or null
    • snapshotDate date

      The trading day these values are from

  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.