Pobierz użytkownika według nazwy | Dokumentacja 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

Użyj username do pobrania profilu użytkownika. Ten punkt końcowy jest przydatny, gdy znasz tylko nazwę użytkownika i potrzebujesz ujednoliconego data.id do żądań osi czasu.

text

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

Uwierzytelnianie

Wszystkie punkty końcowe API Twitter wymagają uwierzytelnienia tokenem Bearer.

http

Authorization: Bearer YOUR_API_KEY

Parametry zapytania

usernamestringWymagane

Nazwa użytkownika Twitter. Akceptowane są elonmusk i @elonmusk; początkowe @ jest usuwane po stronie serwera.

user.fieldsstring

Pola użytkownika oddzielone przecinkami, na przykład created_at,description,public_metrics,verified.

Przykład żądania

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"

Odpowiedź

dataobjectWymagane

Ujednolicony obiekt użytkownika.

Pola data

idstringWymagane

Unikalny identyfikator użytkownika. Preferuj tę wartość w zapytaniach osi czasu.

namestringWymagane

Nazwa wyświetlana.

usernamestringWymagane

Nazwa użytkownika bez @.

created_atstring

Znacznik czasu ISO 8601, zwracany przy żądaniu user.fields=created_at.

descriptionstring

Opis użytkownika.

entitiesobject

Elementy profilu, takie jak opisy adresów URL i linki.

locationstring

Lokalizacja w profilu użytkownika.

pinned_tweet_idstring

ID przypiętego tweeta.

profile_banner_urlstring

Adres URL banera profilu.

profile_image_urlstring

Adres URL zdjęcia profilowego.

protectedboolean

Czy konto jest chronione.

public_metricsobject

Publiczne statystyki użytkownika.

Pola public_metrics

followers_countinteger

Liczba obserwujących.

following_countinteger

Liczba obserwowanych kont.

tweet_countinteger

Łączna liczba tweetów.

listed_countinteger

Liczba list zawierających użytkownika. Może nie występować, gdy źródło danych jej nie dostarcza.

urlstring

Adres witryny w profilu użytkownika.

verifiedboolean

Czy konto jest zweryfikowane.

verified_typestring

Typ weryfikacji, na przykład Business.

Przykład powodzenia

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
  }
}

Odpowiedź błędu

Zobacz kody błędów i diagnozowanie, aby poznać pełny wykaz kodów, różnice protokołów i kroki diagnostyczne.

json

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

Wskazówki użytkowania

Jeśli znasz tylko username, najpierw wywołaj ten punkt końcowy
Jeśli planujesz zapytanie o oś czasu, użyj zwróconego data.id
Jeśli potrzebujesz tylko awatara, opisu lub liczby obserwujących, jawnie przekaż user.fields