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

# Filter GST

> Filter and search GST registrations by various criteria

Filter GST registrations based on multiple criteria including trade name, state, taxpayer type, status, and more.

## Headers

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

## Query Parameters

<ParamField query="GSTIN" type="string">
  Filter by GSTIN
</ParamField>

<ParamField query="TradeName" type="string">
  Search by trade name (partial match)
</ParamField>

<ParamField query="BusinessActivities" type="string">
  Filter by business activity
</ParamField>

<ParamField query="Status" type="string">
  Filter by status (Active, Cancelled, etc.)
</ParamField>

<ParamField query="TaxpayerType" type="string">
  Filter by taxpayer type (Regular, Composition, etc.)
</ParamField>

<ParamField query="DateOfRegistration_start" type="string">
  Registration date range start (YYYY-MM-DD)
</ParamField>

<ParamField query="DateOfRegistration_end" type="string">
  Registration date range end (YYYY-MM-DD)
</ParamField>

<ParamField query="COREBUSINESS" type="string">
  Filter by core business type
</ParamField>

<ParamField query="TotalIncome" type="number">
  Filter by total income
</ParamField>

<ParamField query="Turnover" type="number">
  Filter by turnover
</ParamField>

<ParamField query="Address" type="string">
  Search by address
</ParamField>

<ParamField query="State" type="string">
  Filter by state
</ParamField>

<ParamField query="District" type="string">
  Filter by district
</ParamField>

<ParamField query="gdes" type="string">
  Filter by goods description
</ParamField>

<ParamField query="sdes" type="string">
  Filter by services description
</ParamField>

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

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

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.finscreener.in/api/gst/gst-filter?State=Maharashtra&Status=Active&TaxpayerType=Regular&page=1&limit=10" \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ```

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

  response = requests.get(
      "https://api.finscreener.in/api/gst/gst-filter",
      params={
          "State": "Maharashtra",
          "Status": "Active",
          "TaxpayerType": "Regular",
          "page": 1,
          "limit": 10
      },
      headers={"Authorization": f"Bearer {token}"}
  )
  gst_records = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "results": [
      {
        "GSTIN": "27AAACR5055K1ZZ",
        "TradeName": "RELIANCE INDUSTRIES LIMITED",
        "Status": "Active",
        "TaxpayerType": "Regular",
        "State": "Maharashtra",
        "COREBUSINESS": "Manufacturer"
      }
    ],
    "total_results": 1523,
    "page": 1,
    "limit": 10
  }
  ```
</ResponseExample>