> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keyapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 用户资料

> 根据 screenname 或 rest_id 查询 Twitter / X 用户公开资料，返回头像、简介、认证状态、粉丝/关注数、位置和账号状态等信息。适用于账号画像、用户核验和基础资料补全。

<div className="inline-flex items-center gap-2 px-4 py-2 bg-yellow-50 dark:bg-yellow-900/20 border border-yellow-200 dark:border-yellow-800 rounded-lg">
  <span className="text-base">🪙</span>
  <span className="text-sm font-medium text-yellow-900 dark:text-yellow-100"><span className="font-semibold">1 credit</span><span className="text-yellow-700 dark:text-yellow-300 ml-1">每次请求</span></span>
</div>

## Copy for AI

<div className="my-6 rounded-xl border border-gray-200 bg-gray-50 p-5 dark:border-gray-800 dark:bg-gray-900/40">
  <div className="min-w-0">
    <p className="text-base font-semibold text-gray-900 dark:text-gray-100">🤖 让 AI 帮你写调用代码</p>
    <p className="mt-1 text-sm text-gray-700 dark:text-gray-300">点击按钮复制一段结构化提示词，可直接交给 ChatGPT、Claude 或其他 AI 助手生成接口调用代码。</p>
  </div>

  <div className="mt-4">
    <button type="button" className="inline-flex items-center gap-2 rounded-md border border-emerald-300 bg-emerald-50 px-3 py-2 text-sm font-medium text-emerald-800 hover:bg-emerald-100 dark:border-emerald-700 dark:bg-emerald-900/30 dark:text-emerald-100 dark:hover:bg-emerald-900/50" onClick={() => navigator.clipboard.writeText("我想调用 KeyAPI 接口：GET https://api.keyapi.ai/v1/twitter/screenname\n\n请帮我编写调用代码，并包含必要的错误处理、参数校验和响应处理逻辑。\n\n接口信息：\n\nEndpoint: GET https://api.keyapi.ai/v1/twitter/screenname\n\nDescription: Twitter / X 的「Twitter / X详情」接口用于根据指定标识查询完整信息，返回基础资料、统计指标以及示例中的扩展字段。常用必填参数包括 screenname。\n\nRequired Headers:\n--header 'Authorization: Bearer <YOUR_API_KEY>'\n\nParameters:\n- screenname (Required): screenname 参数. Example: elonmusk\n- rest_id (Optional): rest_id 标识符. Example: 44196397\n\nExample Response:\n{\n  \"code\": 0,\n  \"message\": \"success\",\n  \"data\": {\n    \"status\": \"active\",\n    \"profile\": \"elonmusk\",\n    \"rest_id\": \"44196397\",\n    \"blue_verified\": true,\n    \"verification_type\": null,\n    \"affiliates\": {\n      \"label\": {\n        \"badge\": {\n          \"url\": \"https://pbs.twimg.com/profile_images/1955359038532653056/OSHY3ewP_bigger.jpg\"\n        },\n        \"description\": \"X\",\n        \"url\": {\n          \"url\": \"https://twitter.com/X\",\n          \"urlType\": \"DeepLink\"\n        },\n        \"userLabelDisplayType\": \"Badge\",\n        \"userLabelType\": \"BusinessLabel\"\n      }\n    },\n    \"business_account\": [],\n    \"avatar\": \"https://pbs.twimg.com/profile_images/2053244804520427520/m8mdWZCG_normal.jpg\",\n    \"header_image\": \"https://pbs.twimg.com/profile_banners/44196397/1774145451\",\n    \"desc\": \"https://t.co/dDtDyVssfm\",\n    \"name\": \"Elon Musk\",\n    \"protected\": false,\n    \"location\": \"\",\n    \"friends\": 1325,\n    \"sub_count\": 239947098,\n    \"statuses_count\": 102410,\n    \"media_count\": 4487,\n    \"pinned_tweet_ids_str\": null,\n    \"created_at\": \"Tue Jun 02 20:12:29 +0000 2009\",\n    \"id\": \"44196397\"\n  },\n  \"requestId\": \"dbca9df7-d91b-4075-8d72-7bb4b062d01a\"\n}\n\n请根据以上信息给出可直接运行的示例代码。")}>
      ✨ 复制给 AI
    </button>
  </div>
</div>


## OpenAPI

````yaml zh/twitter.zh.openapi.json GET /v1/twitter/screenname
openapi: 3.0.1
info:
  title: Twitter API 中文文档
  description: Twitter API 的中文参考文档，包含接口用途、参数说明、响应状态和示例结构。
  version: 1.0.0
servers:
  - url: https://api.keyapi.ai
    description: Production
security:
  - JWT Bearer: []
tags: []
paths:
  /v1/twitter/screenname:
    get:
      tags: []
      summary: 用户资料
      description: >-
        根据 screenname 或 rest_id 查询 Twitter / X
        用户公开资料，返回头像、简介、认证状态、粉丝/关注数、位置和账号状态等信息。适用于账号画像、用户核验和基础资料补全。
      parameters:
        - name: screenname
          in: query
          description: Twitter / X 用户名，不包含 @。
          required: true
          example: elonmusk
          schema:
            type: string
            example: elonmusk
        - name: rest_id
          in: query
          description: 用户ID；传入后会优先使用该 ID 查询，并覆盖 screenname。
          required: false
          example: '44196397'
          schema:
            type: string
            example: '44196397'
      responses:
        '200':
          description: 请求成功
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example:
                code: 0
                message: success
                data:
                  status: active
                  profile: elonmusk
                  rest_id: '44196397'
                  blue_verified: true
                  verification_type: null
                  affiliates:
                    label:
                      badge:
                        url: >-
                          https://pbs.twimg.com/profile_images/1955359038532653056/OSHY3ewP_bigger.jpg
                      description: X
                      url:
                        url: https://twitter.com/X
                        urlType: DeepLink
                      userLabelDisplayType: Badge
                      userLabelType: BusinessLabel
                  business_account: []
                  avatar: >-
                    https://pbs.twimg.com/profile_images/2053244804520427520/m8mdWZCG_normal.jpg
                  header_image: https://pbs.twimg.com/profile_banners/44196397/1774145451
                  desc: https://t.co/dDtDyVssfm
                  name: Elon Musk
                  protected: false
                  location: ''
                  friends: 1325
                  sub_count: 239947098
                  statuses_count: 102410
                  media_count: 4487
                  pinned_tweet_ids_str: null
                  created_at: Tue Jun 02 20:12:29 +0000 2009
                  id: '44196397'
                requestId: dbca9df7-d91b-4075-8d72-7bb4b062d01a
          headers: {}
        '400':
          description: 请求参数错误，请检查必填字段和参数格式
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 400
                  data: null
                  message: Missing required parameter
        '401':
          description: 鉴权失败，请检查 Authorization Header 中的 Bearer Token 或 API Key 是否有效
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 401
                  data: null
                  message: apiKey is null
        '402':
          description: 账户余额或额度不足
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 402
                  data: null
                  message: apiKey quota is not enough
        '429':
          description: 请求过于频繁，已触发限流
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 429
                  data: null
                  message: qps limit exceeded
        '500':
          description: 服务器内部错误，请稍后重试
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 500
                  data: null
                  message: Internal server error
      deprecated: false
      security:
        - JWT Bearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.keyapi.ai/v1/twitter/screenname?screenname=elonmusk&rest_id=44196397' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.keyapi.ai/v1/twitter/screenname',
                params={"screenname": "elonmusk", "rest_id": "44196397"},
                headers={'Authorization': 'Bearer <YOUR_API_KEY>'}
            )
            print(response.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const params = new URLSearchParams({"screenname": "elonmusk",
            "rest_id": "44196397"});


            const response = await
            fetch(`https://api.keyapi.ai/v1/twitter/screenname?${params}`, {
              method: 'GET',
              headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' }
            });

            const data = await response.json();

            console.log(data);
components:
  securitySchemes:
    JWT Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |-
        接口鉴权凭证。请在请求 Header 中传入 `Authorization: Bearer <YOUR_API_KEY>`。
        可在 [Dashboard](https://keyapi.ai/app/dashboard) 获取你的 API Key。

````