d9a732d8e6be

latestOpenAPI 3.1.0Proprietary2026-08-111,5563,2026.4 MB

Finance

Visualization / heatmap data

post/api/v2/market/visualization

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

Visualization / heatmap payload.

dataStubData required

Response shape not yet documented; fields are returned as-is.

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",
    "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"
    ]
  }
}