{ "openapi": "3.0.1", "info": { "title": "Telegram User Account Advanced Search", "description": "One keyword, or a number and letter range, returns a deep list of Telegram accounts. Best in class on volume, and the only Actor that gets this many results. Sign in once. $3 per 1,000 found.", "version": "0.4", "x-build-id": "c9ZNvbzm9QKdeaEDd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arjuna-x_official-owner~telegram-advanced-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arjuna-x_official-owner-telegram-advanced-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/arjuna-x_official-owner~telegram-advanced-search/runs": { "post": { "operationId": "runs-sync-arjuna-x_official-owner-telegram-advanced-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/arjuna-x_official-owner~telegram-advanced-search/run-sync": { "post": { "operationId": "run-sync-arjuna-x_official-owner-telegram-advanced-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": [ "base" ], "properties": { "base": { "title": "Base keyword", "type": "string", "description": "Base search string. Alone it searches once. With start/end it becomes a prefix for generated suffixes (e.g. base=bitcoin, start=1, end=10 gives bitcoin1 through bitcoin10)." }, "start": { "title": "Range start (optional)", "type": "string", "description": "Optional range start. Use digits (1, 01, 100) or lowercase letters of equal length (a, aa, zz)." }, "end": { "title": "Range end (optional)", "type": "string", "description": "Optional range end. Must match the type/length style of start." }, "maxTerms": { "title": "Max search terms", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on how many generated patterns to search.", "default": 200 }, "delayBetweenSearchesSec": { "title": "Delay between searches (seconds)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Pause between each search term to reduce rate limiting.", "default": 2 }, "loginWaitSec": { "title": "Login wait (seconds)", "minimum": 10, "maximum": 600, "type": "integer", "description": "How long to wait while you sign in the first time. Later runs reuse the saved login.", "default": 120 }, "sessionStoreName": { "title": "Session store name", "type": "string", "description": "Private name for the saved login. Example: tg-session-alice. Do not share this name.", "default": "telegram-web-session" }, "persistSession": { "title": "Persist session", "type": "boolean", "description": "Keep the login for later runs. Uses the session store name.", "default": true }, "forceLogin": { "title": "Force QR / Live View login", "type": "boolean", "description": "Sign in again. Use this if the saved login expired or you want a different account. On Apify Console, open Live View after Start.", "default": false }, "headless": { "title": "Headless browser", "type": "boolean", "description": "On for later runs, after you have already signed in. Turn off if you need to sign in or watch the run. The first run opens a window for the QR even if this is on.", "default": true }, "onlyNewResults": { "title": "Only new results", "type": "boolean", "description": "Skip usernames this session name has already returned.", "default": true } } }, "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 } } } } } } } } } }