Finance

Custom screener query

post/api/v2/market/screener

Request body

queryobject required

Screener/visualization query DSL: a nested {operator, operands} tree forwarded to the upstream screener.

sizeinteger nullable

Maximum number of results to return.

offsetinteger nullable

Result offset for pagination.

sortFieldstring nullable

Field to sort results by.

sortTypestring nullable

Sort direction, e.g. ASC or DESC.

quoteTypestring nullable

Instrument-type filter, e.g. EQUITY or ETF.

Example request

{
  "query": {
    "operands": [
      {
        "operands": [
          "intradaymarketcap",
          1000000000
        ],
        "operator": "gt"
      },
      {
        "operands": [
          "region",
          "us"
        ],
        "operator": "eq"
      }
    ],
    "operator": "and"
  }
}

Response

Screener results.

Example response

{
  "meta": {
    "endpoint": "/api/v1/fred/us/cpi",
    "data_time": "2026-04-16T14:30:00Z",
    "response_time": "2026-04-16T14:30:12Z",
    "provider": "Sugra API v1.0.1",
    "data_age_days": 8.532,
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ],
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes

Changed in 4 of the 22 revisions of this API.120

Sep 1, 2026328d061c12ca3See the full diff
- ○
  added the optional property meta/data_age_days to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/notes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/period to the response with the 200 status
  response-optional-property-added
Aug 24, 202664715a22734d4See the full diff
- ○
  added the optional property data/count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/records to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/start to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/total to the response with the 200 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 2026d9a732d8e6be11See the full diff
- ▲
  added required request body
  request-body-added-required
- ○
  added the non-success response with the status 422
  response-non-success-status-added
Aug 8, 20264c4530760ba112See the full diff
- ○
  added the optional property code to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 503 status
  response-optional-property-added

Full history