Skip to main content
POST
/
api
/
screener
/
create
curl -X POST https://api.finscreener.in/api/screener/create \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mumbai IT Companies",
    "type": "company",
    "query": "City == '\''Mumbai'\'' AND NICCode IN [62011, 62012]",
    "description": "IT companies in Mumbai"
  }'
{
  "id": "scr_789",
  "name": "Mumbai IT Companies",
  "type": "company",
  "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]",
  "description": "IT companies in Mumbai",
  "created_at": "2026-02-04T12:00:00Z"
}
Save an FQL query as a named screener for future use.

Headers

Authorization
string
required
Bearer token: Bearer <access_token>

Request Body

name
string
required
Screener name
type
string
required
Entity type: company, director, or gst
query
string
required
FQL query string
description
string
Optional description

Response

id
string
Created screener ID
name
string
Screener name
Field names are case-sensitive! Company fields use PascalCase (City, State), GST fields use lowercase (state).
curl -X POST https://api.finscreener.in/api/screener/create \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mumbai IT Companies",
    "type": "company",
    "query": "City == '\''Mumbai'\'' AND NICCode IN [62011, 62012]",
    "description": "IT companies in Mumbai"
  }'
{
  "id": "scr_789",
  "name": "Mumbai IT Companies",
  "type": "company",
  "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]",
  "description": "IT companies in Mumbai",
  "created_at": "2026-02-04T12:00:00Z"
}