{ "openapi": "3.0.1", "info": { "title": "Skip Tracer — Address History & Relatives Finder", "description": "Find people by name, phone, email or address and get their address history, known relatives and name variants from public records. Confidence-scored, mode-aware, and never charged on zero matches.", "version": "0.1", "x-build-id": "xom8BvfiLzDwDZeio" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/0xgollum~skip-tracer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-0xgollum-skip-tracer", "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/0xgollum~skip-tracer/runs": { "post": { "operationId": "runs-sync-0xgollum-skip-tracer", "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/0xgollum~skip-tracer/run-sync": { "post": { "operationId": "run-sync-0xgollum-skip-tracer", "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": { "search_mode": { "title": "Search mode", "enum": [ "name", "phone", "email", "address" ], "type": "string", "description": "Used for the single top-level query below (ignored if 'queries' batch array is provided).", "default": "name" }, "full_name": { "title": "Full name", "type": "string", "description": "Required for name mode.", "default": "" }, "city": { "title": "City", "type": "string", "description": "Optional, improves accuracy.", "default": "" }, "state": { "title": "State", "type": "string", "description": "2-letter US state code recommended; strongly improves name-mode accuracy.", "default": "" }, "phone": { "title": "Phone", "type": "string", "description": "Required for phone mode.", "default": "" }, "email": { "title": "Email", "type": "string", "description": "Required for email mode.", "default": "" }, "street_address": { "title": "Street address", "type": "string", "description": "Required for address mode.", "default": "" }, "zip": { "title": "ZIP code", "type": "string", "description": "Optional, helps pinpoint location.", "default": "" }, "queries": { "title": "Batch queries (optional)", "type": "array", "description": "Optional list of query objects (each with its own search_mode + fields) to run in one job. Overrides the single top-level query fields above when non-empty.", "default": [] }, "max_results_per_query": { "title": "Max matches per query", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of people to return per query.", "default": 3 }, "min_confidence": { "title": "Minimum confidence", "minimum": 0, "maximum": 1, "type": "number", "description": "Records below this confidence are dropped before output (and never billed).", "default": 0.35 }, "include_relatives": { "title": "Include relatives", "type": "boolean", "description": "Include related family members in results.", "default": true }, "include_address_history": { "title": "Include address history", "type": "boolean", "description": "Include previous addresses in results.", "default": true }, "request_timeout_secs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "HTTP request timeout.", "default": 20 } } }, "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 } } } } } } } } } }