# GST Scraper (`w3crawler/gstin-scraper`) Actor Scrape taxpayer details, filing & HSN from GST portal - **URL**: https://apify.com/w3crawler/gstin-scraper.md - **Developed by:** [W3Crawler](https://apify.com/w3crawler) (community) - **Categories:** Developer tools, Automation, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $9.99 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## GSTIN Scraper Scrape taxpayer details, filing & HSN from GST portal without CAPTCHA ### Features - **Structured data extraction** — outputs clean JSON fields ready for analysis - **Cloud-ready** — runs on Apify with scheduling, proxy rotation, and webhook support ### Use Cases - Data collection and research automation at scale - Building structured datasets from public web content - Monitoring for new listings, updates, or changes over time - Competitive intelligence and market benchmarking ### Input | Field | Type | Default | Required | Description | |-------|------|---------|----------|-------------| | `gstins` | array | `—` | ✓ | GSTIN numbers to scrape from GST portal | | `extractHsnCodes` | boolean | `True` | | Extract goods and services information including HSN/SAC codes | | `extractFilingDetails` | boolean | `True` | | Extract filing status and financial year details | | `headless` | boolean | `True` | | Run browser in headless mode (no visible UI). Set to false for debugging. | | `maxItems` | integer | `20` | | Maximum number of items to scrape | | `proxyConfiguration` | object | Apify Residential | | Proxy settings. Residential proxy is strongly recommended | ### Output Each scraped item includes: | Field | Description | |-------|-------------| | `goodservice` | Goodservice | | `finanacialYears` | Finanacial years | | `filingStatus` | Filing status | | `filingFrequency` | Filing frequency | | `natureOfTaxpayer` | Nature of taxpayer | | `isAadhaarVerified` | Is aadhaar verified | | `legalName` | Legal name | | `stateJurisdiction` | State jurisdiction | | `state` | State or province name | | `division` | Division | | `zone` | Zone | | `circle` | Circle | | `taxpayerType` | Taxpayer type | | `cancellationDate` | Cancellation date | | `gstinNumber` | Gstin number | | `businessActivities` | Business activities | | `isEKYCVerified` | Is e k y c verified | | `compositionScheme` | Composition scheme | | `registrationDate` | Registration date | | `companyType` | Company type | #### Sample Output ```json { "goodservice": "goodservice_value", "finanacialYears": "finanacialYears_value", "filingStatus": "filingStatus_value", "filingFrequency": "filingFrequency_value", "natureOfTaxpayer": "natureOfTaxpayer_value", "isAadhaarVerified": "isAadhaarVerified_value", "legalName": "legalName_value", "stateJurisdiction": "stateJurisdiction_value" } ```` ### Notes - **Proxy**: Residential proxy is highly recommended — set `proxyConfiguration: { useApifyProxy: true, apifyProxyGroups: ["RESIDENTIAL"] }` - **Rate limits**: Keep `maxItems` reasonable per run to avoid IP bans or rate throttling - **Scheduling**: Use Apify Scheduler to run this actor on a recurring basis for a consistently fresh dataset # Actor input Schema ## `gstins` (type: `array`): GSTIN numbers to scrape from GST portal ## `extractHsnCodes` (type: `boolean`): Extract goods and services information including HSN/SAC codes ## `extractFilingDetails` (type: `boolean`): Extract filing status and financial year details ## `headless` (type: `boolean`): Run browser in headless mode (no visible UI). Set to false for debugging. ## `proxyConfiguration` (type: `object`): Use Apify Proxy to avoid IP address-based blocking. Required for successful scraping. ## Actor input object example ```json { "gstins": [ "06AAICK7471J1Z4" ], "extractHsnCodes": true, "extractFilingDetails": true, "headless": true, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "IN" } } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "gstins": [ "06AAICK7471J1Z4" ], "headless": true }; // Run the Actor and wait for it to finish const run = await client.actor("w3crawler/gstin-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "gstins": ["06AAICK7471J1Z4"], "headless": True, } # Run the Actor and wait for it to finish run = client.actor("w3crawler/gstin-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "gstins": [ "06AAICK7471J1Z4" ], "headless": true }' | apify call w3crawler/gstin-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=w3crawler/gstin-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "GST Scraper", "description": "Scrape taxpayer details, filing & HSN from GST portal", "version": "2.0", "x-build-id": "HEhSwkXOlVn8RFoL2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~gstin-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-gstin-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/w3crawler~gstin-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-gstin-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/w3crawler~gstin-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-gstin-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "gstins" ], "properties": { "gstins": { "title": "GSTIN Numbers", "type": "array", "description": "GSTIN numbers to scrape from GST portal", "items": { "type": "string" } }, "extractHsnCodes": { "title": "Extract HSN Codes", "type": "boolean", "description": "Extract goods and services information including HSN/SAC codes", "default": true }, "extractFilingDetails": { "title": "Extract Filing Details", "type": "boolean", "description": "Extract filing status and financial year details", "default": true }, "headless": { "title": "Headless Mode", "type": "boolean", "description": "Run browser in headless mode (no visible UI). Set to false for debugging.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Use Apify Proxy to avoid IP address-based blocking. Required for successful scraping.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "IN" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```