{ "openapi": "3.0.1", "info": { "title": "B2B Company Enrichment API - Firmographics and Intent", "description": "Enrich company domains and names into full B2B profiles, or prospect for new companies by size, revenue, industry, SIC and NAICS codes, technologies and buyer intent topics. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "if1qpaJEBWC62qQYW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~b2b-company-enrichment-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-b2b-company-enrichment-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~b2b-company-enrichment-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-b2b-company-enrichment-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~b2b-company-enrichment-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-b2b-company-enrichment-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": { "searchMode": { "title": "Search mode", "enum": [ "lookup", "prospecting" ], "type": "string", "description": "`Lookup` enriches companies you already know, by domain, name or provider id. `Prospecting` finds new companies that match an ideal customer profile you describe with filters.", "default": "lookup" }, "domains": { "title": "Company domains", "type": "array", "description": "Lookup mode. Company domains to enrich, one per line, for example `example.com`. Full URLs and work email addresses are accepted and reduced to their domain.", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Company names to look up, one per line. Use a domain instead where you have one, since names are less precise.", "items": { "type": "string" } }, "companyIds": { "title": "Provider company ids", "type": "array", "description": "Company ids from the data provider, one per line. Use these when you stored ids from a previous run and want the profiles again without a fresh search.", "items": { "type": "string" } }, "names": { "title": "Company name contains", "type": "array", "description": "Prospecting mode. Name fragments to match, one per line. Each needs 2 to 256 characters.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Locations to match, one per line, for example `United States` or `London, United Kingdom`. Each needs 2 to 256 characters.", "items": { "type": "string" } }, "sizes": { "title": "Company sizes", "type": "array", "description": "Employee count bands to match, one per line, using the provider's own band labels such as `11-50` or `201-500`.", "items": { "type": "string" } }, "revenues": { "title": "Revenue bands", "type": "array", "description": "Annual revenue bands to match, one per line, using the provider's own band labels.", "items": { "type": "string" } }, "industriesLabels": { "title": "Industries", "type": "array", "description": "Industry labels to match, one per line, for example `Software Development`.", "items": { "type": "string" } }, "sics": { "title": "SIC codes", "type": "array", "description": "Standard Industrial Classification codes to match, one per line.", "items": { "type": "string" } }, "naics": { "title": "NAICS codes", "type": "array", "description": "North American Industry Classification System codes to match, one per line.", "items": { "type": "string" } }, "technologies": { "title": "Technologies in use", "type": "array", "description": "Technologies the company runs, one per line, for example `Salesforce` or `HubSpot`.", "items": { "type": "string" } }, "intentTopics": { "title": "Buyer intent topics", "type": "array", "description": "Buyer intent topics the company is showing activity on, one per line. Requires an intent entitlement on your provider plan.", "items": { "type": "string" } }, "rawFilters": { "title": "Additional filters", "type": "object", "description": "Advanced. A JSON object merged into the `companies` filter object, for example `{\"include\": {\"sizes\": [{\"min\": 50, \"max\": 200}]}, \"exclude\": {\"locations\": [\"India\"]}}`. Merged last, so it also overrides the fields above. Use this for exclusions and for any filter shape not covered by the simple lists." }, "enrichCompanies": { "title": "Reveal full profiles", "type": "boolean", "description": "When enabled, every matched company is revealed into a full profile with firmographics, industry codes, technologies, funding and social links. Turn this off to keep only the lightweight preview, which costs fewer provider credits.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after this many companies (1-20,000). One row is one company." }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the data provider. Required. It is generated in the provider's dashboard. Stored securely here 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 } } } } } } } } } }