> ## 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.

# Create Screener

> Save a new screener query

Save an FQL query as a named screener for future use.

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer token: `Bearer <access_token>`
</ParamField>

## Request Body

<ParamField body="name" type="string" required>
  Screener name
</ParamField>

<ParamField body="type" type="string" required>
  Entity type: `company` or `gst`
</ParamField>

<ParamField body="query" type="string" required>
  FQL query string
</ParamField>

<ParamField body="description" type="string">
  Optional description
</ParamField>

<Warning>
  Field names are **case-sensitive**! Company fields use PascalCase (`City`, `State`), GST fields use lowercase (`state`).
</Warning>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.finscreener.in/api/screener/screeners \
    -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"
    }'
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://api.finscreener.in/api/screener/screeners",
      headers={"Authorization": f"Bearer {token}"},
      json={
          "name": "Mumbai IT Companies",
          "type": "company",
          "query": "City == 'Mumbai' AND NICCode IN [62011, 62012]",
          "description": "IT companies in Mumbai"
      }
  )
  screener = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "data": {
      "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"
    }
  }
  ```
</ResponseExample>
