ユーザー名によるユーザー取得 | 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

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 を明示的に指定してください