v57

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-2161198428.4 KB

Screener

Search Screener

Search instruments using structured filters.

Returns a columnar response where each row is an array of column objects. Each column contains a human-readable name, a field reference, an optional type hint (e.g. CURR_USD, PERCENT), and the value.

Use columns to select which columns appear in each row. When omitted, the default field set is returned.

post/v1/screener

Request body

page_sizeinteger nullable

The number of items to return per page (only used when page_token is not provided)

page_tokenstring byte

Base64URL-encoded pagination token

sort_case_sensitiveboolean nullable

Whether string sorts should be case-sensitive (default: false).

Example request

{
  "columns": [
    {
      "name": "market_cap"
    },
    {
      "name": "price"
    },
    {
      "name": "volume"
    }
  ],
  "filters": [
    {
      "left": {
        "name": "market_cap"
      },
      "op": {
        "name": "GREATER_OR_EQUAL"
      },
      "right": [
        {
          "value": 1000000000
        }
      ]
    }
  ],
  "page_size": 25,
  "sorts": [
    {
      "direction": "DESC",
      "field": {
        "name": "market_cap"
      }
    }
  ]
}

Response

Screener results

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "data": [
    [
      {
        "field": {
          "name": "market_cap",
          "value_type": "DECIMAL"
        },
        "name": "Market Cap",
        "type": "CURR_USD",
        "value": 2890000000000
      }
    ]
  ]
}