Получение пользователя по имени | Документация API

# Get User By Username

Query a Twitter user profile by username and return a normalized X API v2-style user object.

GET https://api.apihop.ai/v1/twitter/users

Use `username` to query a user profile. This endpoint is useful when you only know a username and need the normalized `data.id` for timeline requests.

```text
GET https://api.apihop.ai/v1/twitter/users
```

## Authentication

All Twitter API endpoints require Bearer Token authentication.

```http
Authorization: Bearer YOUR_API_KEY
```

## Query Parameters

### `username` (string, required)

Twitter username. Both `elonmusk` and `@elonmusk` are accepted; the leading `@` is removed server-side.

### `user.fields` (string)

Comma-separated user fields, such as `created_at,description,public_metrics,verified`.

## Request Example

```bash
curl --request GET \
  "$API_BASE_URL/v1/twitter/users?username=elonmusk&user.fields=created_at,description,public_metrics,verified" \
  --header "Authorization: Bearer YOUR_API_KEY"
```

## Response

### `data` (object, required)

Normalized user object.

### data fields

### `id` (string, required)

Unique user identifier. Prefer this value for timeline queries.

### `name` (string, required)

Display name.

### `username` (string, required)

Username without `@`.

### `created_at` (string)

ISO 8601 timestamp, returned when `user.fields=created_at` is requested.

### `description` (string)

User bio.

### `entities` (object)

Profile entities, such as URL descriptions and links.

### `location` (string)

Location in the user profile.

### `pinned_tweet_id` (string)

ID of the pinned tweet.

### `profile_banner_url` (string)

Profile banner URL.

### `profile_image_url` (string)

Profile image URL.

### `protected` (boolean)

Whether the account is protected.

### `public_metrics` (object)

Public user metrics.

### public_metrics fields

### `followers_count` (integer)

Number of followers.

### `following_count` (integer)

Number of accounts followed.

### `tweet_count` (integer)

Total number of tweets.

### `listed_count` (integer)

Number of lists containing the user. May be absent when the data source does not provide it.

### `url` (string)

Website URL in the user profile.

### `verified` (boolean)

Whether the account is verified.

### `verified_type` (string)

Verification type, such as `Business`.

### Success Example

```json
{
  "data": {
    "id": "44196397",
    "name": "Elon Musk",
    "username": "elonmusk",
    "created_at": "2009-06-02T20:12:29.000Z",
    "description": "Mars and cars",
    "public_metrics": {
      "followers_count": 10,
      "following_count": 20,
      "tweet_count": 40
    },
    "verified": true
  }
}
```

## Error Response

See [Error Codes and Troubleshooting](https://apihop.ai/en/docs/api-reference/errors) for the full code reference, protocol differences, and diagnostic steps.

```json
{
  "success": false,
  "error": {
    "code": 40000,
    "message": "Insufficient credit. Required: 100000, Available: 99999"
  },
  "requestId": "req_xxx"
}
```

## Usage Tips

- If you only know `username`, call this endpoint first
- If you plan to query a timeline, use the returned `data.id`
- If you only need avatar, bio, or follower counts, pass `user.fields` explicitly

Используйте username для запроса профиля. Этот эндпоинт полезен, когда известно только имя пользователя и нужен нормализованный data.id для запросов ленты.

text

GET https://api.apihop.ai/v1/twitter/users

Аутентификация

Все эндпоинты API Twitter требуют аутентификации с токеном Bearer.

http

Authorization: Bearer YOUR_API_KEY

Параметры запроса

usernamestringобязательно

Имя пользователя Twitter. Допускаются elonmusk и @elonmusk; начальный @ удаляется на сервере.

user.fieldsstring

Поля пользователя через запятую, например created_at,description,public_metrics,verified.

Пример запроса

bash

curl --request GET \
  "$API_BASE_URL/v1/twitter/users?username=elonmusk&user.fields=created_at,description,public_metrics,verified" \
  --header "Authorization: Bearer YOUR_API_KEY"

Ответ

dataobjectобязательно

Нормализованный объект пользователя.

Поля data

idstringобязательно

Уникальный идентификатор пользователя. Предпочитайте это значение для запросов ленты.

namestringобязательно

Отображаемое имя.

usernamestringобязательно

Имя пользователя без @.

created_atstring

Временная метка ISO 8601, возвращаемая при запросе user.fields=created_at.

descriptionstring

Биография пользователя.

entitiesobject

Сущности профиля, например описания URL и ссылки.

locationstring

Местоположение в профиле пользователя.

pinned_tweet_idstring

ID закреплённого твита.

profile_banner_urlstring

URL баннера профиля.

profile_image_urlstring

URL изображения профиля.

protectedboolean

Защищён ли аккаунт.

public_metricsobject

Публичные метрики пользователя.

Поля public_metrics

followers_countinteger

Число подписчиков.

following_countinteger

Число отслеживаемых аккаунтов.

tweet_countinteger

Общее число твитов.

listed_countinteger

Число списков, содержащих пользователя. Может отсутствовать, если источник данных не предоставляет его.

urlstring

URL сайта в профиле пользователя.

verifiedboolean

Подтверждён ли аккаунт.

verified_typestring

Тип подтверждения, например Business.

Пример успешного ответа

json

{
  "data": {
    "id": "44196397",
    "name": "Elon Musk",
    "username": "elonmusk",
    "created_at": "2009-06-02T20:12:29.000Z",
    "description": "Mars and cars",
    "public_metrics": {
      "followers_count": 10,
      "following_count": 20,
      "tweet_count": 40
    },
    "verified": true
  }
}

Ответ с ошибкой

Полный справочник кодов, различия протоколов и этапы диагностики приведены в разделе Коды ошибок и устранение неполадок.

json

{
  "success": false,
  "error": {
    "code": 40000,
    "message": "Insufficient credit. Required: 100000, Available: 99999"
  },
  "requestId": "req_xxx"
}

Советы по использованию

Если известен только username, сначала вызовите этот эндпоинт
Если планируете запрашивать ленту, используйте возвращённый data.id
Если нужны только аватар, биография или число подписчиков, явно передайте user.fields