ดึงผู้ใช้ตามชื่อผู้ใช้ | เอกสาร 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 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

เอนทิตีโปรไฟล์ เช่น คำอธิบาย 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 ชัดเจน