curl -X GET "https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
"https://api.finscreener.in/api/screener/screeners/scr_123/run",
params={"page": 1, "limit": 10},
headers={"Authorization": f"Bearer {token}"}
)
results = response.json()
print(f"Found {results['total']} matching records")
for record in results["data"]:
print(record)
const response = await fetch(
'https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10',
{
method: 'GET',
headers: { Authorization: `Bearer ${token}` }
}
);
const results = await response.json();
console.log(`Found ${results.total} matching records`);
{
"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]"
}
}
{
"detail": "Screener not found"
}
Screener
Run Screener
Execute a saved screener and get matching results
GET
/
api
/
screener
/
screeners
/
{screener_id}
/
run
curl -X GET "https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
"https://api.finscreener.in/api/screener/screeners/scr_123/run",
params={"page": 1, "limit": 10},
headers={"Authorization": f"Bearer {token}"}
)
results = response.json()
print(f"Found {results['total']} matching records")
for record in results["data"]:
print(record)
const response = await fetch(
'https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10',
{
method: 'GET',
headers: { Authorization: `Bearer ${token}` }
}
);
const results = await response.json();
console.log(`Found ${results.total} matching records`);
{
"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]"
}
}
{
"detail": "Screener not found"
}
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
string
required
The ID of the saved screener to execute
Headers
string
required
Bearer token:
Bearer <access_token>Query Parameters
integer
default:"1"
Page number for pagination
integer
default:"10"
Number of results per page (max 100)
Response
array
Array of matching company or GST records
integer
Total number of matching records
integer
Current page number
integer
Results per page
object
Screener metadata (id, name, type, query)
curl -X GET "https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
"https://api.finscreener.in/api/screener/screeners/scr_123/run",
params={"page": 1, "limit": 10},
headers={"Authorization": f"Bearer {token}"}
)
results = response.json()
print(f"Found {results['total']} matching records")
for record in results["data"]:
print(record)
const response = await fetch(
'https://api.finscreener.in/api/screener/screeners/scr_123/run?page=1&limit=10',
{
method: 'GET',
headers: { Authorization: `Bearer ${token}` }
}
);
const results = await response.json();
console.log(`Found ${results.total} matching records`);
{
"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]"
}
}
{
"detail": "Screener not found"
}
Error Codes
| Status | Description |
|---|---|
| 200 | Screener executed successfully |
| 401 | Unauthorized — invalid or expired token |
| 404 | Screener not found or doesn’t belong to user |
| 422 | Invalid query — FQL syntax error in saved screener |
| 429 | Rate 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.