{ "openapi": "3.0.1", "info": { "title": "Company Registry Search API - Legal Entity and Officer Data", "description": "Search official company registries across 140+ jurisdictions and export clean legal-entity records - registered name, company number, jurisdiction, incorporation date, status, type and registered address. Also search company officers. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "7krRLdEV4RLZc3Gnz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~company-registry-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-registry-search-api", "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/nabeelbaghoor~company-registry-search-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-company-registry-search-api", "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/nabeelbaghoor~company-registry-search-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-company-registry-search-api", "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": { "searchType": { "title": "Search type", "enum": [ "companies", "officers" ], "type": "string", "description": "Search official registries for companies or for officers (directors, secretaries, agents).", "default": "companies" }, "query": { "title": "Search term", "type": "string", "description": "Text to search for, e.g. a company or officer name. Matches all words in any order. Use `*` for prefix matching, e.g. `acme*`." }, "jurisdictionCode": { "title": "Jurisdiction code", "type": "string", "description": "Restrict to a registry jurisdiction, e.g. `gb` (United Kingdom), `us_de` (Delaware), `fr` (France). Leave blank to search all jurisdictions." }, "countryCode": { "title": "Country code", "type": "string", "description": "Restrict to a country by ISO 3166-1 alpha-2 code, e.g. `gb`, `us`, `de`. Broader than a single jurisdiction." }, "companyType": { "title": "Company type", "type": "string", "description": "Filter companies by type as named by the register, e.g. `Private Limited Company`, `LLC`. Companies search only." }, "currentStatus": { "title": "Current status", "type": "string", "description": "Filter by current status as named by the register, e.g. `Active`, `Dissolved`. Companies search only." }, "incorporationDateFrom": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date (YYYY-MM-DD). Companies search only." }, "incorporationDateTo": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date (YYYY-MM-DD). Companies search only." }, "inactive": { "title": "Inactive filter", "enum": [ "any", "active", "inactive" ], "type": "string", "description": "Restrict by activity: any, only active, or only inactive companies.", "default": "any" }, "position": { "title": "Officer position", "type": "string", "description": "For officer search: filter by position, e.g. `director`, `secretary`, `agent`. Officers search only." }, "order": { "title": "Sort order", "enum": [ "", "score", "created_at", "updated_at", "incorporation_date", "dissolution_date" ], "type": "string", "description": "How to sort results. `score` is best-match relevance; the date options sort newest first.", "default": "score" }, "startPage": { "title": "Start page", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-based page to start from (max 100). Increase to skip earlier results.", "default": 1 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many records (1-10,000). Paged automatically at 100 per page. You are charged per result returned." }, "apiKey": { "title": "API token", "type": "string", "description": "Your company-registry API token. Required. Sign up self-serve for an API plan with the provider to get a token. Stored securely and never logged." } } }, "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 } } } } } } } } } }