Screener run

POST/v1/screener/runPromised whole

Run a screen and return the matching securities.

Response contract

Every field in the response is part of the contract.

Response fields

The top level keys a live response actually returned, read off the API rather than written down here.

countoffsetlimithas_morecolumnscriteria_countrowscoverage

How this was verified

Called against 3 different subjects on the live API. Every field it returned, at every level, was compared with the contract above. Last checked August 18, 2026.

Request

curl -X POST "https://api.massari.ai/v1/screener/run" \
  -H "Authorization: Bearer $MASSARI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"filters":[{"metric":"market_cap","op":"gte","value":1000000000000}],"limit":3}'

Example response

{
  "count": 3,
  "offset": 0,
  "limit": 3,
  "has_more": true,
  "columns": [
    "symbol",
    "name"
  ],
  "criteria_count": 0,
  "rows": [
    {
      "symbol": "NVDA",
      "name": "NVIDIA Corporation",
      "asset_type": "Common Stock",
      "is_adr": false,
      "is_leveraged": null,
      "is_inverse": null,
      "is_mlp": false,
      "is_active": true,
      "sector": "Technology",
      "industry": "Semiconductors",
      "issuer_country": "US",
      "market_cap": "5453600260096",
      "pe_ratio": "34.1676446160149862",
      "dividend_yield": "0.440000",
      "cagr_lifetime": "37.085300",
      "beta": "2.215",
      "ipo_date": "1999-01-22T00:00:00.000Z",
      "last": 225.01,
      "chg_pct": -0.011947059868530598,
      "quote_source": "delayed"
    },
    {
      "symbol": "AAPL",
      "name": "Apple Inc.",
      "asset_type": "Common Stock",
      "is_adr": false,
      "is_leveraged": null,
      "is_inverse": null,
      "is_mlp": false,
      "is_active": true,
      "sector": "Technology",
      "industry": "Consumer Electronics",
      "issuer_country": "US",
      "market_cap": "4464797286400",
      "pe_ratio": "34.6296229457845342",
      "dividend_yield": "0.350000",
      "cagr_lifetime": "19.238400",
      "beta": "1.086",
      "ipo_date": "1980-12-12T00:00:00.000Z",
      "last": 305.59,
      "chg_pct": -0.26149772823848966,
      "quote_source": "delayed"
    }
  ],
  "coverage": null
}

A real response from the live API, captured August 18, 2026. This one is CUT: long arrays, wide objects and long strings were trimmed to keep it readable, so treat it as a sample of the shape rather than all of it. Either way it is valid JSON.