{ "openapi": "3.0.1", "info": { "title": "Skip Trace & People Search — Phone, Email & Address", "description": "Find people in the US by name, or find out who is behind a phone number. Get age, aliases, relatives with ages, address history and phone numbers — every match as its own clean record, never merging same-name strangers.", "version": "1.0", "x-build-id": "WwygJwDycV0bpwUVM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~skip-trace-people-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-skip-trace-people-search", "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/brilliant_gum~skip-trace-people-search/runs": { "post": { "operationId": "runs-sync-brilliant_gum-skip-trace-people-search", "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/brilliant_gum~skip-trace-people-search/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-skip-trace-people-search", "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", "required": [ "searchType" ], "properties": { "searchType": { "title": "Search Type", "enum": [ "name", "phone", "email", "address" ], "type": "string", "description": "How to search. Name search returns matching people with ages, other names, relatives, phones, emails and the places they have lived. Phone and address do reverse lookups (who owns a number / who lives at an address). Email search is best-effort.", "default": "name" }, "firstName": { "title": "First Name", "type": "string", "description": "Person's first name. Name search needs both first and last name." }, "lastName": { "title": "Last Name", "type": "string", "description": "Person's last name. Name search needs both first and last name." }, "state": { "title": "State", "type": "string", "description": "US state, as an abbreviation (NY) or full name (New York). Only people who have lived in this state are returned. A misspelt state stops the run with an error." }, "city": { "title": "City", "type": "string", "description": "City to narrow and target the search. Results are filtered to the state; the city improves relevance but is not a strict filter (a nearby town or another borough of the same metro can still appear)." }, "phone": { "title": "Phone Number", "type": "string", "description": "Phone number for a reverse phone lookup (10-digit US number). Used when Search Type is Phone." }, "email": { "title": "Email Address", "type": "string", "description": "Email address to search. Used when Search Type is Email." }, "street": { "title": "Street Address", "type": "string", "description": "Street address for a reverse address lookup. Used when Search Type is Address." }, "zip": { "title": "ZIP Code", "type": "string", "description": "ZIP code, used together with the street/city for an address lookup." }, "queries": { "title": "Batch Queries (JSON)", "type": "array", "description": "Array of query objects for batch mode. For name search each needs firstName and lastName; state and city are optional. Example: [{\"firstName\":\"John\",\"lastName\":\"Smith\",\"state\":\"NY\"}]. When provided, single-query fields above are ignored." }, "sources": { "title": "Data Sources", "type": "array", "description": "Which sources to query. Results from all selected sources are merged per person. Leave the default for the best balance of coverage and speed.", "items": { "type": "string", "enum": [ "fastPeopleSearch", "thatsThem", "spokeo", "truePeopleSearch" ], "enumTitles": [ "Source A", "Source B", "Source C (name search only)", "Source D (broadest data, slower)" ] }, "default": [ "fastPeopleSearch", "thatsThem" ] }, "maxResults": { "title": "Max Results Per Query", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of person records to return per search query. A state or city filter can leave fewer.", "default": 5 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxies are included and configured automatically — leave this empty. To use your own, set it here." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }