Finance

Visualization / heatmap data

Changed on
post/api/v2/market/visualization

Request

  • Base URL: https://sugra.ai
  • URL: https://sugra.ai/api/v2/market/visualization
  • Auth: API key in header x-api-key

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.

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"
    ],
    "stale_since": "2026-09-08T12:00:00Z",
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes

  • d2472ec2cf81Revision changes
    • breaking

      added subschema #2 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 4f8853a61440Revision changes
    • info

      added the optional property / to the response with the status