{ "openapi": "3.0.1", "info": { "title": "B2B Account Search API - Company Firmographics and Tech", "description": "Search B2B company accounts by name, domain, industry, size, revenue, location and technologies, and export firmographic and technographic data. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "3NaeLDwiu9G6Oktvr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~b2b-account-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-b2b-account-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~b2b-account-search-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-b2b-account-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~b2b-account-search-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-b2b-account-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": { "names": { "title": "Company names", "type": "string", "description": "Comma-separated list of company names to search for, e.g. `Acme, Globex, Initech`. Leave blank to match on other filters." }, "domains": { "title": "Company domains", "type": "string", "description": "Comma-separated list of web domains, e.g. `acme.com, globex.io`. Matches accounts by their primary website domain." }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text keywords to match against company profiles, e.g. `cloud security`. Comma-separated values are sent as a list." }, "description": { "title": "Description contains", "type": "string", "description": "Match accounts whose company description contains this phrase, e.g. `payment processing`." }, "types": { "title": "Company types", "type": "string", "description": "Comma-separated company types. Allowed values: `Public Company`, `Privately Held`, `Government Agency`, `non profit`." }, "technologies": { "title": "Technologies", "type": "string", "description": "Comma-separated technographic filters, e.g. `Salesforce, AWS, HubSpot`. Matches accounts using those technologies." }, "naics": { "title": "NAICS codes", "type": "string", "description": "Comma-separated NAICS industry classification codes, e.g. `541511, 511210`." }, "sic": { "title": "SIC codes", "type": "string", "description": "Comma-separated SIC industry classification codes, e.g. `7372, 7389`." }, "revenueMin": { "title": "Revenue from (USD)", "minimum": 0, "type": "integer", "description": "Minimum annual revenue in USD, e.g. `1000000`. Maps to the revenue range lower bound." }, "revenueMax": { "title": "Revenue to (USD)", "minimum": 0, "type": "integer", "description": "Maximum annual revenue in USD, e.g. `50000000`. Maps to the revenue range upper bound." }, "foundedFrom": { "title": "Founded from (year)", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Only accounts founded in or after this year, e.g. `2010`." }, "foundedTo": { "title": "Founded to (year)", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Only accounts founded in or before this year, e.g. `2024`." }, "countries": { "title": "Countries", "type": "string", "description": "Comma-separated countries to include, e.g. `United States, United Kingdom, Germany`." }, "excludeCountries": { "title": "Exclude countries", "type": "string", "description": "Comma-separated countries to exclude from results, e.g. `India, China`." }, "states": { "title": "States or regions", "type": "string", "description": "Comma-separated states or regions, e.g. `California, Texas, Bavaria`." }, "cities": { "title": "Cities", "type": "string", "description": "Comma-separated cities, e.g. `San Francisco, London, Berlin`." }, "matchExactName": { "title": "Match exact company name", "type": "boolean", "description": "Require an exact match on company name instead of a fuzzy match.", "default": false }, "matchExactDomain": { "title": "Match exact domain", "type": "boolean", "description": "Require an exact match on the company domain instead of a partial match.", "default": false }, "redeem": { "title": "Redeem full records", "type": "boolean", "description": "When on, each matched account is redeemed to return full firmographic values (domain, revenue, headcount and more). When off, only lighter preview records are returned, which is cheaper but has less data. You are charged per record returned either way.", "default": true }, "rawFilters": { "title": "Raw filters (advanced)", "type": "object", "description": "Advanced escape hatch. A JSON object merged verbatim over the generated search body, letting you set fields not exposed above (for example `websites`, `regions`). Use only if you know the underlying account search body.", "default": {} }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many records (1-5,000). Paged automatically. You are charged per result returned." }, "apiKey": { "title": "API key", "type": "string", "description": "Your own B2B data provider API key (Bearer token). Required. Bring your own key: this actor calls the provider on your behalf using your enterprise-provisioned credentials. 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 } } } } } } } } } }