Custom screener query

POST

/api/v2/market/screener

Last modified:2026-09-03 17:14:13

Maintainer:Not configured

OperationId:post_market_screener

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "query": {
        "operands": [
            {
                "operands": [
                    "intradaymarketcap",
                    1000000000
                ],
                "operator": "gt"
            },
            {
                "operands": [
                    "region",
                    "us"
                ],
                "operator": "eq"
            }
        ],
        "operator": "and"
    },
    "size": 0,
    "offset": 0,
    "sortField": "string",
    "sortType": "string",
    "quoteType": "string",
    "property1": "string",
    "property2": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v2/market/screener' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "query": {
        "operands": [
            {
                "operands": [
                    "intradaymarketcap",
                    1000000000
                ],
                "operator": "gt"
            },
            {
                "operands": [
                    "region",
                    "us"
                ],
                "operator": "eq"
            }
        ],
        "operator": "and"
    },
    "size": 0,
    "offset": 0,
    "sortField": "string",
    "sortType": "string",
    "quoteType": "string",
    "property1": "string",
    "property2": "string"
}'

Responses

🟢200OK

application/json

Screener results.

Bodyapplication/json

Example

{
    "data": {
        "total": 0,
        "start": 0,
        "count": 0,
        "records": [
            {
                "symbol": "string",
                "name": "string",
                "price": 0,
                "change": 0,
                "change_pct": 0,
                "volume": 0,
                "market_cap": 0,
                "property1": "string",
                "property2": "string"
            }
        ],
        "property1": "string",
        "property2": "string"
    },
    "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": 0,
        "source": "string",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true,
        "period": "string",
        "notes": "string"
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429Service Unavailable

🔴503Service Unavailable

Modified at 2026-09-03 17:14:13

Predefined screener (gainers, losers, most active, etc.)

Visualization / heatmap data