依使用者名稱查詢使用者 | 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

驗證

所有 Twitter API 端點均需要 Bearer Token 驗證。

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

個人資料實體，例如網址說明與連結。

locationstring

使用者個人資料中的所在地。

pinned_tweet_idstring

置頂推文的 ID。

profile_banner_urlstring

個人資料橫幅網址。

profile_image_urlstring

個人資料圖片網址。

protectedboolean

帳號是否受到保護。

public_metricsobject

公開使用者指標。

public_metrics 欄位

followers_countinteger

追蹤者人數。

following_countinteger

追蹤的帳號數量。

tweet_countinteger

推文總數。

listed_countinteger

包含此使用者的列表數量。資料來源未提供時可能缺少此欄位。

urlstring

使用者個人資料中的網站網址。

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