{ "openapi": "3.0.1", "info": { "title": "India Company Registry", "version": "0.1", "x-build-id": "uhrhMMaKzlwuLe55e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/civicdataforge~india-company-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-civicdataforge-india-company-registry", "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/civicdataforge~india-company-registry/runs": { "post": { "operationId": "runs-sync-civicdataforge-india-company-registry", "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/civicdataforge~india-company-registry/run-sync": { "post": { "operationId": "run-sync-civicdataforge-india-company-registry", "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", "properties": { "nameContains": { "title": "Company name contains", "type": "string", "description": "Case-insensitive name substring within the server-filtered pool. Pair with a state or class filter for bounded scans." }, "cin": { "title": "CIN (exact)", "type": "string", "description": "Exact Corporate Identification Number." }, "cins": { "title": "CINs for exact bulk lookup", "maxItems": 5000, "type": "array", "description": "Up to 5,000 exact CINs. Each is looked up independently and returned with per-record evidence.", "items": { "type": "string" }, "default": [] }, "companyNameExact": { "title": "Company name (exact)", "type": "string", "description": "Exact official registered company-name filter." }, "companyNames": { "title": "Company names for exact bulk lookup", "maxItems": 5000, "type": "array", "description": "Up to 5,000 exact registered names. Combine with CINs; ambiguous keyword matching is deliberately excluded.", "items": { "type": "string" }, "default": [] }, "maxConcurrency": { "title": "Bulk lookup concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Parallel exact lookups from 1 to 8. Lower this if the caller-owned OGD key is rate-limited.", "default": 5 }, "includeLei": { "title": "Cross-check GLEIF LEI data", "type": "boolean", "description": "For each returned CIN, query the official public GLEIF API for an exact registered-identifier match and attach LEI identity, validation, renewal, and address evidence. No fuzzy match is accepted.", "default": false }, "state": { "title": "Registered state", "type": "string", "description": "Exact official registered-state filter." }, "status": { "title": "Company status", "type": "string", "description": "Exact official company-status filter." }, "companyClass": { "title": "Company class", "type": "string", "description": "Exact official class filter." }, "category": { "title": "Company category", "type": "string", "description": "Exact official category filter." }, "roc": { "title": "Registrar of Companies", "type": "string", "description": "Exact Registrar of Companies filter." }, "maxRecords": { "title": "Maximum records", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Bounded result limit from 1 to 50,000.", "default": 100 }, "previousFingerprints": { "title": "Previous CIN fingerprints", "maxItems": 5000, "type": "array", "description": "Optional caller-controlled prior receipt items: [{\"cin\":\"...\",\"record_fingerprint\":\"sha256:...\"}]. Returned CINs become new, changed, or unchanged. Removed records are never inferred from a bounded query.", "items": { "type": "object", "properties": { "cin": { "title": "Corporate Identification Number", "description": "CIN used as the stable entity key for comparison.", "type": "string" }, "record_fingerprint": { "title": "Prior record fingerprint", "description": "SHA-256 record fingerprint from an earlier Actor result.", "type": "string" } }, "required": [ "cin", "record_fingerprint" ] }, "default": [] }, "onlyChanges": { "title": "Return only new or changed CINs", "type": "boolean", "description": "Requires previousFingerprints. Unchanged returned records are omitted.", "default": false }, "apiKey": { "title": "data.gov.in API key", "type": "string", "description": "Optional caller-owned key for a private quota. Never returned in records or receipts." } } }, "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 } } } } } } } } } }