Skip to main content
POST
/
api
/
screener
/
screeners
/
{screener_id}
/
run
curl -X POST "https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "data": [
    {
      "CIN": "L17110MH1973PLC019786",
      "company": "RELIANCE INDUSTRIES LIMITED",
      "City": "Mumbai",
      "State": "Maharashtra",
      "paidUpCapital": 6765800000,
      "llpStatus": "Active"
    },
    {
      "CIN": "L65910MH2007PLC169487",
      "company": "RELIANCE JIO INFOCOMM LIMITED",
      "City": "Mumbai",
      "State": "Maharashtra",
      "paidUpCapital": 4500000000,
      "llpStatus": "Active"
    }
  ],
  "total": 45,
  "page": 1,
  "limit": 10,
  "screener": {
    "id": "scr_123",
    "name": "Mumbai IT Companies",
    "type": "company",
    "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.finscreener.in/llms.txt

Use this file to discover all available pages before exploring further.

Execute a previously saved screener query and return the matching companies or GST records.
This endpoint runs the saved FQL query in real-time against the latest data. Results are not cached — you always get fresh data.

​
Path Parameters

​
screener_id
string
required
The ID of the saved screener to execute

​
Headers

​
Authorization
string
required
Bearer token: Bearer <access_token>

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"10"
Number of results per page (max 100)

​
Response

​
data
array
Array of matching company or GST records
​
total
integer
Total number of matching records
​
page
integer
Current page number
​
limit
integer
Results per page
​
screener
object
Screener metadata (id, name, type, query)
curl -X POST "https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "data": [
    {
      "CIN": "L17110MH1973PLC019786",
      "company": "RELIANCE INDUSTRIES LIMITED",
      "City": "Mumbai",
      "State": "Maharashtra",
      "paidUpCapital": 6765800000,
      "llpStatus": "Active"
    },
    {
      "CIN": "L65910MH2007PLC169487",
      "company": "RELIANCE JIO INFOCOMM LIMITED",
      "City": "Mumbai",
      "State": "Maharashtra",
      "paidUpCapital": 4500000000,
      "llpStatus": "Active"
    }
  ],
  "total": 45,
  "page": 1,
  "limit": 10,
  "screener": {
    "id": "scr_123",
    "name": "Mumbai IT Companies",
    "type": "company",
    "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]"
  }
}

​
Error Codes

StatusDescription
200Screener executed successfully
401Unauthorized — invalid or expired token
404Screener not found or doesn’t belong to user
422Invalid query — FQL syntax error in saved screener
429Rate limit exceeded
Use Run Screener to build automated pipelines. Save a screener once, then run it on a schedule to track changes in matching records over time.