Skip to main content
GET
/
api
/
screener
/
{id}
# Get screener details only
curl -X GET "https://api.finscreener.in/api/screener/scr_123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# Run screener and get results
curl -X GET "https://api.finscreener.in/api/screener/scr_123?run=true&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "screener": {
    "id": "scr_123",
    "name": "Mumbai IT Companies",
    "type": "company",
    "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]"
  },
  "results": [
    {
      "CIN": "U72200MH2004PTC148441",
      "companyName": "TATA CONSULTANCY SERVICES LIMITED",
      "City": "Mumbai",
      "NICCode": 62011
    }
  ],
  "total": 1523,
  "page": 1,
  "pages": 153
}
Retrieve a saved screener and optionally execute its query.

​
Path Parameters

​
id
string
required
Screener ID

​
Query Parameters

​
run
boolean
default:"false"
Execute the screener query and return results
​
page
number
default:"1"
Results page (when run=true)
​
limit
number
default:"50"
Results per page (when run=true)

​
Headers

​
Authorization
string
required
Bearer token: Bearer <access_token>

​
Response

​
screener
object
Screener details
​
results
array
Query results (only when run=true)
​
total
number
Total matching records
# Get screener details only
curl -X GET "https://api.finscreener.in/api/screener/scr_123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# Run screener and get results
curl -X GET "https://api.finscreener.in/api/screener/scr_123?run=true&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "screener": {
    "id": "scr_123",
    "name": "Mumbai IT Companies",
    "type": "company",
    "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]"
  },
  "results": [
    {
      "CIN": "U72200MH2004PTC148441",
      "companyName": "TATA CONSULTANCY SERVICES LIMITED",
      "City": "Mumbai",
      "NICCode": 62011
    }
  ],
  "total": 1523,
  "page": 1,
  "pages": 153
}