{ "openapi": "3.0.1", "info": { "title": "Global Company Database API - Worldwide Firmographics Data", "description": "Search a worldwide company database covering more than 200 countries by industry code, location, employee count, sales volume, registration number and corporate parent. Returns firmographics, contacts, map coordinates and group linkage. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "XaX3zAYtSjOqgBJiV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~global-company-database-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-global-company-database-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-company-database-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-global-company-database-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-company-database-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-global-company-database-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": { "businessNames": { "title": "Business names", "type": "array", "description": "Business names to match.", "items": { "type": "string" } }, "who": { "title": "Who (free text)", "type": "string", "description": "One free-text box matching business name, category or phone at once, the way a directory search box works." }, "where": { "title": "Where (free text)", "type": "string", "description": "One free-text location box matching city name and postal code at once." }, "tryAnyLocationMatch": { "title": "Allow partial location match", "type": "boolean", "description": "When the Where box does not resolve to an exact location, fall back to any location that partially matches.", "default": false }, "websites": { "title": "Websites", "type": "array", "description": "Website addresses to match.", "items": { "type": "string" } }, "emails": { "title": "Email addresses", "type": "array", "description": "Email addresses to match.", "items": { "type": "string" } }, "phoneNumbers": { "title": "Phone numbers", "type": "array", "description": "Phone numbers to match.", "items": { "type": "string" } }, "nationalIds": { "title": "National registration numbers", "type": "array", "description": "National company registration numbers to match. In many countries this is also the VAT number.", "items": { "type": "string" } }, "uniqueIds": { "title": "Provider record ids", "type": "array", "description": "Look up specific records by the provider's own record id. Up to 50,000 values.", "items": { "type": "string" } }, "businessNamesExclude": { "title": "Exclude business names", "type": "array", "description": "Business names to leave out of the results.", "items": { "type": "string" } }, "ceoName": { "title": "Executive name", "type": "string", "description": "Match on the name of the company's registered executive." }, "ceoTitle": { "title": "Executive title", "type": "string", "description": "Match on the title of the company's registered executive." }, "countryCodes": { "title": "Country codes", "type": "array", "description": "Two-letter ISO country codes. Leave empty to search every country the account is licensed for.", "items": { "type": "string" } }, "cityNames": { "title": "City names", "type": "array", "description": "Cities to match, by name.", "items": { "type": "string" } }, "provinceNames": { "title": "Province names", "type": "array", "description": "Provinces to match, by name.", "items": { "type": "string" } }, "regionNames": { "title": "Region names", "type": "array", "description": "Regions to match, by name.", "items": { "type": "string" } }, "postCodes": { "title": "Postal codes", "type": "array", "description": "Postal codes to match.", "items": { "type": "string" } }, "cityCodes": { "title": "City codes", "type": "array", "description": "Cities to match, by the provider's city code.", "items": { "type": "string" } }, "provinceCodes": { "title": "Province codes", "type": "array", "description": "Provinces to match, by the provider's province code.", "items": { "type": "string" } }, "regionCodes": { "title": "Region codes", "type": "array", "description": "Regions to match, by the provider's region code.", "items": { "type": "string" } }, "postCodesExclude": { "title": "Exclude postal codes", "type": "array", "description": "Postal codes to leave out of the results.", "items": { "type": "string" } }, "streetAddress": { "title": "Street", "type": "string", "description": "Match on the street name." }, "houseNumber": { "title": "House number", "type": "string", "description": "Match on the house number." }, "centerLatitude": { "title": "Circle centre latitude", "type": "string", "description": "Latitude of the centre point for a radius search. Set all three circle fields together." }, "centerLongitude": { "title": "Circle centre longitude", "type": "string", "description": "Longitude of the centre point for a radius search." }, "radiusMeters": { "title": "Circle radius (metres)", "minimum": 1, "type": "integer", "description": "Return only records inside this radius of the centre point. The provider reads this in metres, not kilometres or miles." }, "internationalCodes": { "title": "International category codes", "type": "array", "description": "The provider's international category codes. This is the default classification.", "items": { "type": "string" } }, "naceCodes": { "title": "NACE codes", "type": "array", "description": "NACE classification codes, which the provider exposes as its alternate international categories.", "items": { "type": "string" } }, "infobelCodes": { "title": "Directory category codes", "type": "array", "description": "The provider's own directory category codes.", "items": { "type": "string" } }, "localCodes": { "title": "Local category codes", "type": "array", "description": "Country-specific local category codes. These differ per country.", "items": { "type": "string" } }, "categoryKeywords": { "title": "Category keywords", "type": "array", "description": "Match categories by keyword instead of by code, when you do not have the code to hand.", "items": { "type": "string" } }, "restrictToMainCategory": { "title": "Primary category only", "type": "boolean", "description": "Match category filters against the company's primary category only, rather than any of its categories.", "default": false }, "internationalCodesExclude": { "title": "Exclude international category codes", "type": "array", "description": "International category codes to leave out of the results.", "items": { "type": "string" } }, "minEmployeesTotal": { "title": "Minimum employees (total)", "minimum": 0, "type": "integer", "description": "Only companies with at least this many employees across the whole company." }, "maxEmployeesTotal": { "title": "Maximum employees (total)", "minimum": 0, "type": "integer", "description": "Only companies with at most this many employees across the whole company." }, "minEmployeesHere": { "title": "Minimum employees (this location)", "minimum": 0, "type": "integer", "description": "Only companies with at least this many employees at the individual location." }, "maxEmployeesHere": { "title": "Maximum employees (this location)", "minimum": 0, "type": "integer", "description": "Only companies with at most this many employees at the individual location." }, "minSalesVolume": { "title": "Minimum sales volume", "minimum": 0, "type": "integer", "description": "Only companies with at least this much annual sales, in the currency chosen below." }, "maxSalesVolume": { "title": "Maximum sales volume", "minimum": 0, "type": "integer", "description": "Only companies with at most this much annual sales, in the currency chosen below." }, "salesVolumeCurrency": { "title": "Sales volume currency", "enum": [ "local", "usd", "eur" ], "type": "string", "description": "Which currency the sales volume filters are expressed in. Local means each company's own reporting currency.", "default": "local" }, "minYearStarted": { "title": "Founded after year", "minimum": 0, "type": "integer", "description": "Only companies started in or after this year." }, "maxYearStarted": { "title": "Founded before year", "minimum": 0, "type": "integer", "description": "Only companies started in or before this year." }, "minFamilyMembers": { "title": "Minimum group members", "minimum": 0, "type": "integer", "description": "Only companies whose corporate family has at least this many members." }, "maxFamilyMembers": { "title": "Maximum group members", "minimum": 0, "type": "integer", "description": "Only companies whose corporate family has at most this many members." }, "legalStatusCodes": { "title": "Legal form codes", "type": "array", "description": "Legal form codes to include, for example the code for a corporation. Pull valid values from the provider's legal status reference endpoint.", "items": { "type": "string" } }, "nationalIdentificationTypeCodes": { "title": "Registration number type codes", "type": "array", "description": "Which kind of national registration number a record must carry.", "items": { "type": "string" } }, "isVat": { "title": "Registration number is a VAT number", "type": "boolean", "description": "Only companies whose national registration number is also a VAT number.", "default": false }, "locationStatus": { "title": "Location status", "type": "array", "description": "Whether the record is a single-location business, a headquarters or a branch.", "items": { "type": "string", "enum": [ "singlelocation", "hq", "branch" ], "enumTitles": [ "Single location", "Headquarters", "Branch" ] } }, "importExportAgentCodes": { "title": "Import and export agent codes", "type": "array", "description": "Filter on whether a company acts as an importer, an exporter or both.", "items": { "type": "string" } }, "globalUltimateCountryCodes": { "title": "Global parent country codes", "type": "array", "description": "Two-letter ISO country codes of the global ultimate parent, for finding local subsidiaries of foreign groups.", "items": { "type": "string" } }, "globalUltimateUniqueIds": { "title": "Global parent record ids", "type": "array", "description": "Return every company under these global ultimate parents.", "items": { "type": "string" } }, "parentUniqueIds": { "title": "Direct parent record ids", "type": "array", "description": "Return every company whose immediate parent is one of these records.", "items": { "type": "string" } }, "domesticUltimateUniqueIds": { "title": "Domestic parent record ids", "type": "array", "description": "Return every company under these domestic ultimate parents.", "items": { "type": "string" } }, "hasPhone": { "title": "Has a phone number", "type": "boolean", "description": "Only records that carry a phone number.", "default": false }, "hasEmail": { "title": "Has an email address", "type": "boolean", "description": "Only records that carry an email address.", "default": false }, "hasMobile": { "title": "Has a mobile number", "type": "boolean", "description": "Only records that carry a mobile number.", "default": false }, "hasFax": { "title": "Has a fax number", "type": "boolean", "description": "Only records that carry a fax number.", "default": false }, "hasContact": { "title": "Has a phone or mobile number", "type": "boolean", "description": "Only records with either a phone or a mobile number. The provider rejects this if the phone and mobile filters are also set.", "default": false }, "hasWebContact": { "title": "Has a website or an email", "type": "boolean", "description": "Only records with either a website or an email address. The provider rejects this if the website and email filters are also set.", "default": false }, "hasWebsite": { "title": "Website presence", "enum": [ "ignore", "has", "hasnot" ], "type": "string", "description": "Three-state filter: ignore websites, require one, or require that there is none.", "default": "ignore" }, "hasNationalId": { "title": "Registration number presence", "enum": [ "ignore", "has", "hasnot" ], "type": "string", "description": "Three-state filter for the national registration number.", "default": "ignore" }, "hasAddress": { "title": "Has a street address", "type": "boolean", "description": "Only records that carry a street address.", "default": false }, "hasCoordinates": { "title": "Has map coordinates", "type": "boolean", "description": "Only records that carry latitude and longitude, so they can be plotted on a map.", "default": false }, "hasLinkedIn": { "title": "Has a LinkedIn page", "type": "boolean", "description": "Only records that carry a LinkedIn link.", "default": false }, "hasLogo": { "title": "Has a logo", "type": "boolean", "description": "Only records that carry a logo image link.", "default": false }, "hasAdmin": { "title": "Has an executive on file", "type": "boolean", "description": "Only records that carry a named administrator or executive.", "default": false }, "hasMarketability": { "title": "Marketable records only", "type": "boolean", "description": "Only records the provider flags as marketable.", "default": false }, "hasBuildingGeometry": { "title": "Has building geometry", "type": "boolean", "description": "Only records that carry building footprint geometry.", "default": false }, "filterOnDoNotCallMe": { "title": "Exclude do-not-call records", "type": "boolean", "description": "Drop every record listed in the do-not-call register. The provider supports this for Belgium only.", "default": false }, "technographicalTags": { "title": "Technology tags", "type": "array", "description": "Technologies detected on the company website. Pull valid values from the provider's technographic tag reference endpoint.", "items": { "type": "string" } }, "hasEShop": { "title": "Runs an online shop", "type": "boolean", "description": "Only companies whose website was detected as running an online shop.", "default": false }, "hasPayment": { "title": "Accepts online payment", "type": "boolean", "description": "Only companies whose website was detected as accepting online payment.", "default": false }, "hasShopTool": { "title": "Uses shop tooling", "type": "boolean", "description": "Only companies whose website was detected as running e-commerce tooling.", "default": false }, "hasDigitalMarketing": { "title": "Runs digital marketing", "type": "boolean", "description": "Only companies whose website was detected as running digital marketing tooling.", "default": false }, "socialLinks": { "title": "Social networks", "type": "array", "description": "Only companies carrying a link to these social networks.", "items": { "type": "string" } }, "minLinkedInFollowers": { "title": "Minimum LinkedIn followers", "minimum": 0, "type": "integer", "description": "Only companies with a LinkedIn page and at least this many followers." }, "maxLinkedInFollowers": { "title": "Maximum LinkedIn followers", "minimum": 0, "type": "integer", "description": "Only companies with a LinkedIn page and at most this many followers." }, "websiteStatusFlags": { "title": "Website status flags", "type": "array", "description": "Numeric website status flags to include. Pull valid values from the provider's website status reference endpoint.", "items": { "type": "string" } }, "websiteIpAddress": { "title": "Website IP address", "type": "string", "description": "Match companies whose website resolves to this IP address, which finds sites sharing one host." }, "dedupeWebDomain": { "title": "One record per web domain", "type": "boolean", "description": "When several records share a web domain, keep only the best one. Requires the website presence filter to be set.", "default": false }, "dedupeEmail": { "title": "One record per email address", "type": "boolean", "description": "When several records share an email address, keep only the best one. Requires the email filter to be set.", "default": false }, "dedupePhone": { "title": "One record per phone number", "type": "boolean", "description": "When several records share a phone number, keep only the best one. Requires the phone filter to be set.", "default": false }, "dedupeNationalId": { "title": "One record per registration number", "type": "boolean", "description": "When several records share a registration number, keep only the best one. Requires the registration number presence filter to be set.", "default": false }, "dataType": { "title": "Data set", "enum": [ "business", "yellowpages", "whitepages" ], "type": "string", "description": "Which of the provider's data sets to search. Business is the firmographic company database and is the right choice for almost every use.", "default": "business" }, "matchAnyFilter": { "title": "Match any filter instead of all", "type": "boolean", "description": "Combine the inclusive filters with OR rather than AND, so a record matching any one of them is returned. Business searches only.", "default": false }, "sortingOrder": { "title": "Sort order", "type": "array", "description": "How to order the records. Several can be combined, applied in the order listed.", "items": { "type": "string", "enum": [ "relevance", "businessname", "country", "province", "grosssales", "grosssalesdesc", "employees", "employeesdesc", "yearstarted", "yearstarteddesc", "uniqueid", "random" ], "enumTitles": [ "Relevance", "Business name", "Country", "Province", "Sales ascending", "Sales descending", "Employees ascending", "Employees descending", "Year started ascending", "Year started descending", "Record id", "Random" ] } }, "displayLanguage": { "title": "Label language", "type": "string", "description": "Two-letter ISO 639-1 code for the language of category labels. Defaults to EN." }, "internationalPhoneFormat": { "title": "International phone format", "type": "boolean", "description": "Return phone numbers in international format, with a plus and the country prefix.", "default": false }, "validateFilters": { "title": "Validate filters", "type": "boolean", "description": "Ask the provider to validate the filter set before running the search, so a bad code fails loudly instead of quietly matching nothing.", "default": false }, "geoLevels": { "title": "Geocoding precision levels", "type": "array", "description": "Numeric geocoding precision levels to include. Pull valid values from the provider's geo level reference endpoint.", "items": { "type": "string" } }, "rawFilters": { "title": "Extra filters", "type": "object", "description": "Any additional search field, merged over the ones above. Use this for a filter the provider adds after this actor was published." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many company records (1 to 50,000). You are charged per result returned." }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many companies to request per API call (1 to 50). The provider's default and maximum is 50 unless your account has been raised." }, "apiKey": { "title": "Access token", "type": "string", "description": "An access token you already hold for the data provider. Leave empty to supply a username and password instead, and the actor will request a token for you. Stored securely and never logged." }, "username": { "title": "Account username", "type": "string", "description": "Your provider account username. Case sensitive. Only needed when no access token is supplied." }, "password": { "title": "Account password", "type": "string", "description": "Your provider account password. Only needed when no access token is supplied. 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 } } } } } } } } } }