{ "openapi": "3.0.1", "info": { "title": "Website Visitor Identification API - IP to Company", "description": "Resolve anonymous website visitor IP addresses to companies, or enrich domains and work emails into firmographics: industry, employee and revenue ranges, SIC and NAICS codes, location, predictive scores and segments. Pay per match. Bring your own API key.", "version": "0.1", "x-build-id": "yeSwOUHfz13F3Pdf4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~website-visitor-identification-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-website-visitor-identification-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~website-visitor-identification-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-website-visitor-identification-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~website-visitor-identification-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-website-visitor-identification-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": { "lookupMode": { "title": "Lookup mode", "enum": [ "identify", "enrich" ], "type": "string", "description": "`Identify` resolves anonymous website visitor IP addresses to companies. `Enrich` resolves company domains or work email addresses to the same firmographic record.", "default": "identify" }, "ipAddresses": { "title": "Visitor IP addresses", "type": "array", "description": "Identify mode. The visitor IP addresses to resolve, one per line. IPv4 and IPv6 are both accepted. Duplicates and malformed entries are dropped.", "items": { "type": "string" } }, "epsilonCookie": { "title": "Visitor cookie", "type": "string", "description": "Optional. The provider's visitor tracking cookie value, forwarded with the request to improve the match when you captured it on your own site." }, "customId": { "title": "Custom tracking id", "type": "string", "description": "Optional. Your own identifier, forwarded with the request so the provider can tie the call back to your session or campaign." }, "domains": { "title": "Company domains", "type": "array", "description": "Enrich mode. Company domains to resolve, one per line, for example `example.com`. Full URLs are accepted and reduced to their domain.", "items": { "type": "string" } }, "emails": { "title": "Work email addresses", "type": "array", "description": "Work email addresses to resolve to their company, one per line. Free mailbox providers usually return no match.", "items": { "type": "string" } }, "country": { "title": "Country hint", "type": "string", "description": "Optional context sent with an enrichment lookup to help disambiguate the match." }, "company": { "title": "Company name hint", "type": "string", "description": "Optional company name sent with an enrichment lookup as an extra matching signal." }, "industry": { "title": "Industry hint", "type": "string", "description": "Optional industry sent with an enrichment lookup." }, "title": { "title": "Job title hint", "type": "string", "description": "Optional job title of the person the email belongs to." }, "role": { "title": "Role hint", "type": "string", "description": "Optional role of the person the email belongs to." }, "firstname": { "title": "First name hint", "type": "string", "description": "Optional first name of the person the email belongs to." }, "lastname": { "title": "Last name hint", "type": "string", "description": "Optional last name of the person the email belongs to." }, "leadsource": { "title": "Lead source", "type": "string", "description": "Optional label for where the lead came from, passed through to the provider for its own reporting." }, "skipUnmatched": { "title": "Skip unmatched inputs", "type": "boolean", "description": "When enabled, inputs the provider cannot resolve to a company are left out of the dataset entirely. When off, they are stored as a placeholder row with `matched: false` so the output lines up with your input list. Unmatched rows are never charged either way.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many rows (1-10,000). One row is one IP address, domain or email. You are charged only for rows that resolved to a company." }, "apiKey": { "title": "API token", "type": "string", "description": "Your own API token for the data provider. Required. It is issued in the provider's platform. 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 } } } } } } } } } }