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

# Screener Search

> Search using FQL screener query

Execute an FQL (Finscreener Query Language) query to search and filter companies or GST registrations.

## Headers

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

## Request Body

<ParamField body="query" type="string" required>
  FQL query string (e.g., `state == 'Maharashtra' AND paidUpCapital > 5000000`)
</ParamField>

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

<ParamField body="page" type="number" default="1">
  Page number
</ParamField>

<ParamField body="limit" type="number" default="10">
  Results per page (max: 100)
</ParamField>

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

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.finscreener.in/api/screener/search \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "query": "State == '\''Maharashtra'\'' AND paidUpCapital > 5000000",
      "type": "company",
      "page": 1,
      "limit": 10
    }'
  ```

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

  response = requests.post(
      "https://api.finscreener.in/api/screener/search",
      headers={"Authorization": f"Bearer {token}"},
      json={
          "query": "State == 'Maharashtra' AND paidUpCapital > 5000000",
          "type": "company",
          "page": 1,
          "limit": 10
      }
  )
  results = response.json()
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.finscreener.in/api/screener/search', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      query: "State == 'Maharashtra' AND paidUpCapital > 5000000",
      type: 'company',
      page: 1,
      limit: 10
    })
  });
  const results = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json Company Search theme={null}
  {
    "results": [
      {
        "CIN": "L17110MH1973PLC019786",
        "companyName": "RELIANCE INDUSTRIES LIMITED",
        "State": "Maharashtra",
        "City": "Mumbai",
        "paidUpCapital": 6766000000,
        "llpStatus": "Active"
      }
    ],
    "total": 1523,
    "page": 1,
    "pages": 153
  }
  ```

  ```json GST Search theme={null}
  {
    "results": [
      {
        "GSTIN": "27AAACR5055K1ZZ",
        "TradeName": "RELIANCE INDUSTRIES LIMITED",
        "state": "Maharashtra",
        "Status": "Active",
        "TaxpayerType": "Regular"
      }
    ],
    "total": 892,
    "page": 1,
    "pages": 90
  }
  ```
</ResponseExample>