v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Screener data

Get the list of securities based on the filter

get/instruments/stocks

Query parameters

sortBystring

Popular, trending, topGainers, topLosers, yearHigh, yearLow

pageSizeinteger

Number of records per page. Max pageSize = 99 and default pageSize = 10

pageinteger

Page Number

typestring

If sortBy=popular – EQUITY/ETF

Headers

api-keystring required

API key

auth-keystring required

Auth key generated using API key & secret

Response

200

statusinteger

Example response

{
  "status": 200,
  "doc": [
    {
      "code": "TSLA",
      "company": "Tesla, Inc.",
      "price": 855.62,
      "change": -8.75,
      "percentChange": -1.02,
      "yearHigh": "1243.49",
      "yearLow": "539.49",
      "marketCapitalization": 1076406730000,
      "logo": "https://d13bbfxgj95hfa.cloudfront.net/TSLA.png",
      "type": "EQUITY"
    }
  ]
}