{ "openapi": "3.0.1", "info": { "title": "Company Data API - Global Business Registry Search", "description": "Search a global registry database of companies by country, city, region, SIC industry code, headcount, revenue, founding year and data completeness. Returns name, address, registration number, CEO, phone, email, website and group structure as flat rows. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "63QxRUkENohQFkVPZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~global-business-registry-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-global-business-registry-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~global-business-registry-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-global-business-registry-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~global-business-registry-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-global-business-registry-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": { "endpoint": { "title": "Endpoint", "enum": [ "search", "export" ], "type": "string", "description": "Search returns a preview record and is the cheap way to size a filter set. Export returns the full company record including headquarters chain and executives, and draws on your export allowance.", "default": "search" }, "search": { "title": "Free text search", "type": "array", "description": "Free text terms matched across the company record, one per line, for example a company name or a trade name.", "items": { "type": "string" } }, "countryCode": { "title": "Country codes", "type": "array", "description": "ISO two letter country codes, one per line, for example NL, DE or US.", "items": { "type": "string" } }, "countryName": { "title": "Country names", "type": "array", "description": "Full country names, one per line. Use this only when you do not have the ISO code.", "items": { "type": "string" } }, "provinceName": { "title": "Provinces or states", "type": "array", "description": "Province or state names, one per line.", "items": { "type": "string" } }, "regionName": { "title": "Regions", "type": "array", "description": "Region names, one per line.", "items": { "type": "string" } }, "cityName": { "title": "Cities", "type": "array", "description": "City names, one per line. Spellings must match the provider's city list.", "items": { "type": "string" } }, "streetName": { "title": "Street names", "type": "array", "description": "Street names, one per line.", "items": { "type": "string" } }, "postalCode": { "title": "Postal codes", "type": "array", "description": "Exact postal codes, one per line. To match a postal code range instead, use the numeric postal code range fields below.", "items": { "type": "string" } }, "sic4Digits": { "title": "SIC codes (4 digit)", "type": "array", "description": "Four digit industry activity codes, one per line, for example 7372.", "items": { "type": "string" } }, "legalStatus": { "title": "Legal status codes", "type": "array", "description": "Legal form or status codes as defined in your API reference, one per line.", "items": { "type": "string" } }, "statusCode": { "title": "Status codes", "type": "array", "description": "Company status codes as defined in your API reference, one per line.", "items": { "type": "string" } }, "subsidiaryCode": { "title": "Subsidiary codes", "type": "array", "description": "Subsidiary status codes, one per line, used to include or exclude group subsidiaries.", "items": { "type": "string" } }, "importExportCode": { "title": "Import and export codes", "type": "array", "description": "Trade activity classification codes, one per line.", "items": { "type": "string" } }, "ids": { "title": "Company IDs", "type": "array", "description": "Provider company IDs to fetch directly, one per line. This is how you re-pull records you already stored.", "items": { "type": "string" } }, "nationalId": { "title": "National registration numbers", "type": "array", "description": "Official company registration numbers, one per line, for example a chamber of commerce number.", "items": { "type": "string" } }, "worldwideHeadquarterId": { "title": "Global headquarters IDs", "type": "array", "description": "Global headquarters IDs, one per line. Use this to pull every member of a corporate group.", "items": { "type": "string" } }, "phoneNumber": { "title": "Phone numbers", "type": "array", "description": "Phone numbers to match, one per line.", "items": { "type": "string" } }, "email": { "title": "Emails", "type": "array", "description": "Email addresses to match, one per line.", "items": { "type": "string" } }, "employeesTotalMin": { "title": "Employees total, minimum", "minimum": 0, "type": "integer", "description": "Lowest company-wide headcount to include." }, "employeesTotalMax": { "title": "Employees total, maximum", "minimum": 0, "type": "integer", "description": "Highest company-wide headcount to include." }, "employeesHereMin": { "title": "Employees on site, minimum", "minimum": 0, "type": "integer", "description": "Lowest headcount at this specific location." }, "employeesHereMax": { "title": "Employees on site, maximum", "minimum": 0, "type": "integer", "description": "Highest headcount at this specific location." }, "annualSalesMin": { "title": "Annual revenue, minimum", "minimum": 0, "type": "integer", "description": "Lowest yearly revenue to include, as a whole number." }, "annualSalesMax": { "title": "Annual revenue, maximum", "minimum": 0, "type": "integer", "description": "Highest yearly revenue to include, as a whole number." }, "foundingYearsMin": { "title": "Founded from year", "minimum": 1000, "type": "integer", "description": "Earliest founding year to include, for example 2000." }, "foundingYearsMax": { "title": "Founded to year", "minimum": 1000, "type": "integer", "description": "Latest founding year to include, for example 2010." }, "postalCodeIntegerMin": { "title": "Postal code range, from", "minimum": 0, "type": "integer", "description": "Lowest numeric postal code to include, for countries whose postal codes are numeric." }, "postalCodeIntegerMax": { "title": "Postal code range, to", "minimum": 0, "type": "integer", "description": "Highest numeric postal code to include." }, "hasEmail": { "title": "Only companies with an email", "type": "boolean", "description": "Return only companies that have at least one email address on record.", "default": false }, "hasPhone": { "title": "Only companies with a phone number", "type": "boolean", "description": "Return only companies that have a phone number on record.", "default": false }, "hasWebsite": { "title": "Only companies with a website", "type": "boolean", "description": "Return only companies that have a website on record.", "default": false }, "hasCEOName": { "title": "Only companies with a named CEO", "type": "boolean", "description": "Return only companies whose top executive is named on the record.", "default": false }, "hasContactPerson": { "title": "Only companies with a contact person", "type": "boolean", "description": "Return only companies that carry at least one named contact.", "default": false }, "hasNationalID": { "title": "Only companies with a registration number", "type": "boolean", "description": "Return only companies that carry an official national registration number.", "default": false }, "hasStreetAddress": { "title": "Only companies with a street address", "type": "boolean", "description": "Return only companies with a street level address rather than a postal box.", "default": false }, "hasFax": { "title": "Only companies with a fax number", "type": "boolean", "description": "Return only companies that have a fax number on record.", "default": false }, "hasMarketability": { "title": "Only companies flagged as marketable", "type": "boolean", "description": "Return only companies the provider flags as contactable for marketing.", "default": false }, "advancedParams": { "title": "Advanced parameters", "type": "string", "description": "Any additional filters, written as query string pairs joined by &, for example legalStatus=3&hasBusinessName=true. Whatever you put here wins over the fields above, so it is also the way to override one. Use it for filters your plan has that this form does not list." }, "useScroll": { "title": "Use scroll paging", "type": "boolean", "description": "Walk the result set with the provider's scroll cursor, which is what it intends for a large extract. Turn this off to use simple page number paging instead, which is fine for small repeatable pulls.", "default": true }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 100, "type": "integer", "description": "Records per request. The provider's documented maximum is 100.", "default": 100 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies. This is the cap on both spend and run time.", "default": 100 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own business registry data API key, sent in the x-api-key header. The actor never ships a key of its own: your plan, quota and terms apply." } } }, "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 } } } } } } } } } }