{ "openapi": "3.0.1", "info": { "title": "Company Firmographics API - Business Data Search by Industry", "description": "Search a global business firmographics database by industry code, country, region, employee count and revenue, and export company records with identifiers, addresses, industry codes and corporate linkage. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "VVdqdyZf296TFnB9c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~company-firmographics-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-firmographics-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-firmographics-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-company-firmographics-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-firmographics-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-company-firmographics-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": { "searchTerm": { "title": "Search term", "type": "string", "description": "Free-text term matched against company names and trade styles, e.g. `acme robotics`. Combine with the filters below to narrow the result set." }, "primaryName": { "title": "Company name", "type": "string", "description": "Match on the registered primary company name, e.g. `Acme Robotics Inc`." }, "countryISOAlpha2Code": { "title": "Country", "enum": [ "US", "CA", "GB", "IE", "DE", "FR", "NL", "BE", "ES", "IT", "PT", "SE", "NO", "DK", "FI", "PL", "CH", "AT", "AU", "NZ", "JP", "CN", "HK", "SG", "TW", "IN", "KR", "MY", "TH", "ID", "PH", "VN", "AE", "SA", "IL", "ZA", "BR", "MX", "AR", "CL", "CO" ], "type": "string", "description": "Restrict results to companies registered in this country. Uses two-letter ISO country codes." }, "addressRegion": { "title": "State or region", "type": "string", "description": "Restrict results to this state, province or region, e.g. `California`, `Bavaria`." }, "addressLocality": { "title": "City", "type": "string", "description": "Restrict results to this city, e.g. `Austin`, `London`." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Restrict results to this postal or ZIP code, e.g. `94105`." }, "usSicV4": { "title": "SIC industry codes", "type": "string", "description": "Comma-separated four-digit US SIC industry codes to match, e.g. `3661, 3663, 7372`. Companies in any of the listed industries are returned." }, "employeesMin": { "title": "Minimum employees", "minimum": 0, "type": "integer", "description": "Only companies with at least this many employees, e.g. `10`." }, "employeesMax": { "title": "Maximum employees", "minimum": 0, "type": "integer", "description": "Only companies with at most this many employees, e.g. `500`." }, "yearlyRevenueMin": { "title": "Minimum yearly revenue (USD)", "type": "number", "description": "Only companies with at least this much annual revenue, in USD, e.g. `1000000`." }, "yearlyRevenueMax": { "title": "Maximum yearly revenue (USD)", "type": "number", "description": "Only companies with at most this much annual revenue, in USD." }, "isMarketable": { "title": "Marketable records only", "type": "boolean", "description": "When enabled, return only records the provider flags as marketable, which filters out many incomplete entries.", "default": false }, "isOutOfBusiness": { "title": "Include out-of-business companies", "type": "boolean", "description": "When enabled, include companies flagged as out of business. Off by default.", "default": false }, "rawCriteria": { "title": "Advanced raw criteria", "type": "object", "description": "Power users: a JSON object of raw search criteria merged over the fields above, verbatim. Use this for criteria not exposed as fields, e.g. `{ \"isStandalone\": true, \"registrationNumbers\": [\"12345678\"] }`. Pagination stays under the actor's control." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many company records (1-5,000). Paged automatically at 50 per page. You are charged per result returned." }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the data provider. Required. Used with the API secret below to obtain a short-lived access token. Stored securely and never logged." }, "apiSecret": { "title": "API secret", "type": "string", "description": "Your own API secret for the data provider. Required. 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 } } } } } } } } } }