{
  "openapi": "3.0.1",
  "info": {
    "title": "Telegram Profile Contact Scraper",
    "description": "Telegram Profile Contact Scraper SD - Telegram Profile Contact Scraper is a lead generation tool that extracts leads with public contact emails, bio, follower counts and profile URLs from Telegram profile URLs or usernames - Telegram profile scraper for creator outreach.",
    "version": "1.0",
    "x-build-id": "Sf3Cg37iMkpaHha5T"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/leads-scraper~telegram-profile-contact-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-leads-scraper-telegram-profile-contact-scraper",
        "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/leads-scraper~telegram-profile-contact-scraper/runs": {
      "post": {
        "operationId": "runs-sync-leads-scraper-telegram-profile-contact-scraper",
        "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/leads-scraper~telegram-profile-contact-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-leads-scraper-telegram-profile-contact-scraper",
        "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": {
          "keywords": {
            "title": "Search keywords",
            "type": "array",
            "description": "Search terms - a niche, job title or industry. The Actor finds Telegram accounts matching each term, then scrapes every account it finds. Use this when you do not already have a list of accounts. You can combine keywords with the profile URLs below.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location (optional)",
            "type": "string",
            "description": "Added to every keyword search, e.g. `New York`. Leave empty to search everywhere. Only applies to keyword search.",
            "default": ""
          },
          "profileUrls": {
            "title": "Telegram profile URLs",
            "type": "array",
            "description": "Full Telegram profile URLs, e.g. `https://t.me/username`. Bare usernames also work. Use this when you already know which accounts you want.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "usernames": {
            "title": "Usernames / handles",
            "type": "array",
            "description": "Telegram handles without the URL. Combined with the list above.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "customDomains": {
            "title": "Email domains",
            "type": "array",
            "description": "Domains the keyword search asks Google for, e.g. `@gmail.com`. Also filters results to these domains. Leave EMPTY (recommended) to search the 12 biggest free-mail providers - Gmail, Yahoo, Outlook, Hotmail, iCloud, AOL, Proton, Live, GMX, Mail.com, Yandex and Zoho - and keep every address found, including company domains. Listing domains here narrows the search to only those.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "onlyWithEmail": {
            "title": "Only save profiles that have an email",
            "type": "boolean",
            "description": "Skip profiles whose public bio contains no contact address.",
            "default": false
          },
          "maxProfiles": {
            "title": "Max profiles per keyword",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Profiles to save for EACH keyword and EACH contact type: 20 with one keyword saves up to 20 profiles with an email and 20 with a phone number; switch one type off and it is 20 in total. Profiles you give directly (URLs or usernames) count as one more group of their own.",
            "default": 100
          },
          "findEmails": {
            "title": "Find emails",
            "type": "boolean",
            "description": "Collect email addresses. Turn off to collect only phone numbers.",
            "default": true
          },
          "findPhones": {
            "title": "Find phone numbers",
            "type": "boolean",
            "description": "Collect phone numbers. Turn off to collect only emails.",
            "default": true
          },
          "countries": {
            "title": "Countries to search",
            "type": "array",
            "description": "Which countries' phone numbers to look for. The search asks Google for that country's dial code, and every number found is validated against that country's real numbering plan. Country name, ISO code or dial code all work. Each extra country multiplies the number of searches.",
            "default": [
              "United States",
              "United Kingdom",
              "India"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxPagesPerKeyword": {
            "title": "Pages per keyword",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "How many Google results pages to read per search query. Raise it to find more accounts. Keyword search only.",
            "default": 5
          },
          "expandQueries": {
            "title": "Expand queries",
            "type": "boolean",
            "description": "Search each keyword in several phrasings (keyword + \"email\", + \"contact\", ...) to reach accounts a single query misses. Keyword search only.",
            "default": true
          },
          "queryModifiers": {
            "title": "Query modifiers",
            "type": "array",
            "description": "Extra words combined with each keyword when query expansion is on. Leave empty to use the defaults for this platform.",
            "default": [
              "email",
              "contact",
              "admin",
              "business",
              "partnership"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "How many profiles are fetched in parallel, and how many Google searches run at once. Raise it for speed, lower it if you see blocked rows.",
            "default": 10
          },
          "proxyGroup": {
            "title": "Apify proxy group",
            "enum": [
              "RESIDENTIAL",
              "BUYPROXIES94952",
              "UNBLOCKER"
            ],
            "type": "string",
            "description": "RESIDENTIAL is recommended. Profile pages block datacenter IPs.",
            "default": "RESIDENTIAL"
          },
          "countryCode": {
            "title": "Proxy country (optional)",
            "type": "string",
            "description": "Two-letter country code for the proxy (e.g. US, GB, DE). Empty for any.",
            "default": ""
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}