# Telegram Username (`xtools/telegram-username`) Actor

Bulk Telegram username availability checker. Verify thousands of usernames instantly - returns Available, Taken, Auctioned, or Sold. Features concurrency control, automatic retries, and scalable cloud processing. Perfect for marketers, developers, and businesses. Deploy on Apify Cloud.

- **URL**: https://apify.com/xtools/telegram-username.md
- **Developed by:** [xtools](https://apify.com/xtools) (community)
- **Categories:** Social media, Automation, Developer tools
- **Features:** Limited permissions
- **Stats:** 1,016 total users, 7 monthly users, 100.0% runs succeeded, 3 bookmarks
- **User rating**: 5.00 out of 5 stars

## Pricing

from $0.02 / actor start

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Telegram Username Availability Checker

This Actor checks Telegram username availability status. It can efficiently check thousands of usernames and determine whether they are available, taken, auctioned, or sold.

### Features

- High performance: Optimized for checking thousands of usernames efficiently
- Concurrency control: Configurable concurrent requests to avoid rate limiting
- Rate limiting: Built-in delays between requests to respect API limits
- Retry logic: Automatic retry with exponential backoff for failed requests

### Input

```json
{
  "usernames": ["telegram", "test", "example"],
  "maxConcurrency": 5,
  "requestDelay": 200,
  "maxRetries": 3
}
```

#### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `usernames` | `string[]` | ✅ Yes | `[]` | Array of Telegram usernames to check (without @ symbol) |
| `maxConcurrency` | `number` | ❌ No | `5` | Maximum number of concurrent requests (recommended: 5-10) |
| `requestDelay` | `number` | ❌ No | `200` | Delay between requests in milliseconds |
| `maxRetries` | `number` | ❌ No | `3` | Maximum number of retries for failed requests |

### Output

The Actor outputs data to the default dataset with the following structure:

```json
{
  "username": "telegram",
  "status": "Taken",
  "checkedAt": "2024-12-10T11:00:00.000Z"
}
```

#### Status Values

- **`Available`** - Username is available for registration
- **`Taken`** - Username is already taken
- **`Auctioned or for sale`** - Username is being auctioned or is for sale
- **`Sold`** - Username was sold
- **`Error`** - An error occurred while checking the username
- **`Invalid`** - Invalid username format

### Recommended Settings

- **Thousands of usernames**: `maxConcurrency: 5-10`, `requestDelay: 200-500ms`
- **Hundreds of usernames**: `maxConcurrency: 10-15`, `requestDelay: 100-200ms`

# Actor input Schema

## `usernames` (type: `array`):

Array of Telegram usernames to check (without @ symbol)

## `maxConcurrency` (type: `integer`):

Maximum number of concurrent requests (recommended: 5-10 to avoid rate limiting)

## `requestDelay` (type: `integer`):

Delay between requests in milliseconds to avoid rate limiting

## `maxRetries` (type: `integer`):

Maximum number of retries for failed requests

## Actor input object example

```json
{
  "usernames": [
    "telegram",
    "test",
    "example"
  ],
  "maxConcurrency": 5,
  "requestDelay": 200,
  "maxRetries": 3
}
```

# Actor output Schema

## `overview` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "usernames": [
        "telegram",
        "test",
        "example"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("xtools/telegram-username").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "usernames": [
        "telegram",
        "test",
        "example",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("xtools/telegram-username").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "usernames": [
    "telegram",
    "test",
    "example"
  ]
}' |
apify call xtools/telegram-username --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,xtools/telegram-username"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/yWgDokYAGwYo8gCxY/builds/YlTajlDLOV3IHHeh9/openapi.json