twexapi-io Users Endpoints API

openapi: 3.2.0
info:
  title: Twexapi Io Users Endpoints API
  version: 1.0.0
  license:
    name: MIT
  description: 'Operations tagged Users Endpoints across 2 of this provider''s published API definitions: twexapi-io-docs-openapi.json, twexapi-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.twexapi.io
  description: Development server
tags:
- name: Users Endpoints
paths:
  /twitter/users:
    post:
      tags:
      - Users Endpoints
      summary: Get Multiple Users by Usernames
      description: Retrieve detailed profile information for multiple Twitter users by their usernames or profile URLs, $0.05/1000 users. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.
      operationId: get_users_by_usernames_twitter_users_post
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: string
              type: array
              title: Usernames
              description: A list of Twitter usernames or profile URLs. Provide multiple times for multiple users (e.g., `[elonmusk,sundarpichai]`).
              examples:
              - - elonmusk
                - sundarpichai
              example:
              - elonmusk
              - sundarpichai
        required: true
      responses:
        '200':
          description: A list of user profile objects. Unfound users are represented by `null`.
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /twitter/user/block:
    post:
      tags:
      - Users Endpoints
      summary: Block a User
      description: Block a user
      operationId: block_user_apiendpoint_twitter_user_block_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockUserQuery'
        required: true
      responses:
        '200':
          description: Blocked user information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - Users Endpoints
      summary: Unblock User
      description: Unblock a user, $0.0005 per call.
      operationId: unblock_user_api_endpoint_twitter_user_block_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockUserQuery'
        required: true
      responses:
        '200':
          description: A confirmation of the action's success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /twitter/users/by_ids:
    post:
      tags:
      - Users Endpoints
      summary: Users Details by ID
      description: Users Details by ID. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.
      operationId: users_details_by_id_api_twitter_users_by_ids_post
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: string
              type: array
              title: User Ids
              description: A list of Twitter user IDs. Provide multiple times for multiple users (e.g., `[44196397,1696160451770429440]`).
              examples:
              - - '44196397'
                - '1696160451770429440'
        required: true
      responses:
        '200':
          description: A list of User objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersDetailsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /x/account/verify:
    post:
      tags:
      - Users Endpoints
      summary: Verify Account Status
      description: Retrieves the verification metadata for a specific account. This endpoint identifies whether an account holds a **Blue Verified** status (authenticity check) or is an **Official Organization Affiliate** (gold/grey labels). The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.
      operationId: account_verify_api_x_account_verify_post
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: string
              type: array
              title: Targets
              description: The IDs or usernames of the users.
              examples:
              - - '1696160451770429440'
                - elonmusk
              example:
              - '1696160451770429440'
              - elonmusk
        required: true
      responses:
        '200':
          description: A verification object containing the account's badge type and affiliation details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountVerifyResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /twitter/users/status:
    post:
      tags:
      - Users Endpoints
      summary: Batch Get User account status
      description: Retrieve detailed account status for multiple Twitter users by their usernames. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.
      operationId: batch_get_user_account_status_endpoint
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: string
              type: array
              title: Usernames
              description: A list of usernames of the users to get information for.
              examples:
              - - elonmusk
                - sundarpichai
        required: true
      responses:
        '200':
          description: A list of user account status strings. If user is suspended return suspended, if unfound return null.
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /twitter/search-user/{keyword}/{target_count}:
    get:
      tags:
      - Users Endpoints
      summary: Search User
      description: Search user
      operationId: search_user_api_endpoint_twitter_search_user__keyword___target_count__get
      security:
      - HTTPBearer: []
      parameters:
      - name: keyword
        in: path
        required: true
        schema:
          type: string
          description: The keyword to search for.
          title: Keyword
        description: The keyword to search for.
      - name: target_count
        in: path
        required: true
        schema:
          type: integer
          description: The number of users to return.
          title: Target Count
        description: The number of users to return.
      responses:
        '200':
          description: A list of user objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /twitter/user/follow:
    post:
      tags:
      - Users Endpoints
      summary: Follow User
      description: Follow a user, $0.0005 per call.
      operationId: follow_user_api_endpoint_twitter_user_follow_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FollowUserQuery'
        required: true
      responses:
        '200':
          description: A confirmation of the action's success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - Users Endpoints
      summary: Unfollow User
      description: Unfollow a user, $0.0005 per call.
      operationId: unfollow_user_api_endpoint_twitter_user_follow_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnfollowUserQuery'
        required: true
      responses:
        '200':
          description: A confirmation of the action's success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnfollowUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.twexapi.io
      description: Development server
components:
  schemas:
    BlockUserResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code
          default: 200
        msg:
          type: string
          title: Msg
          description: Response message
          default: success
        data:
          anyOf:
          - $ref: '#/components/schemas/UserModel'
          - type: 'null'
          description: User information
      type: object
      title: BlockUserResponse
      description: response
    BlockUserQuery:
      properties:
        username:
          type: string
          title: Username
          description: The username of the user to block.
        cookie:
          type: string
          title: Cookie
          description: The user's own authorized Twitter session credentials or auth_token (BYOC — Bring Your Own Cookie). Stateless proxy execution with zero credential retention. See [Authentication Security](/authentication#write-operations--byoc-bring-your-own-cookie) and [How to get Cookie](https://youtube-promotion.pages.dev/how-to-get-twitter-cookie).
          example: ct0=abc123... or 2c4a4e1832096aa694c739b83c83b6d96d43eba7
      type: object
      required:
      - username
      - cookie
      title: BlockUserQuery
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AccountVerifyModel:
      properties:
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: The ID of the user.
        screen_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Screen Name
          description: The username of the user.
        is_blue_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Blue Verified
        is_verified_organization_affiliate:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Verified Organization Affiliate
        is_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Verified
          description: True if is_blue_verified or is_verified_organization_affiliate is True
      type: object
      title: AccountVerifyModel
    FollowUserQuery:
      properties:
        username:
          type: string
          title: Username
          description: The username of the user to follow or unfollow.
        cookie:
          type: string
          title: Cookie
          description: The user's own authorized Twitter session credentials or auth_token (BYOC — Bring Your Own Cookie). Stateless proxy execution with zero credential retention. See [Authentication Security](/authentication#write-operations--byoc-bring-your-own-cookie) and [How to get Cookie](https://youtube-promotion.pages.dev/how-to-get-twitter-cookie).
          example: ct0=abc123... or 2c4a4e1832096aa694c739b83c83b6d96d43eba7
      type: object
      required:
      - username
      - cookie
      title: FollowUserQuery
    UserModel:
      properties:
        id:
          type: string
          title: Id
          description: User ID
          example: '1717001045992251392'
        name:
          type: string
          title: Name
          description: Display name
          example: Cryptoklepto
        screen_name:
          type: string
          title: Screen Name
          description: Twitter username
          example: CK_Cryptoklepto
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: Account creation date
          example: Mon Oct 28 02:32:47 +0000 2024
        created_at_datetime:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At Datetime
          description: Account creation datetime in ISO format
          example: '2024-10-28T02:32:47.000Z'
        can_dm:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Can Dm
          description: Whether the user can be direct messaged
          default: false
        can_media_tag:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Can Media Tag
          description: Whether the user can be tagged in media
          default: false
        default_profile:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Default Profile
          description: Whether the user has a default profile
          default: false
        default_profile_image:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Default Profile Image
          description: Whether the user has a default profile image
          default: false
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: User's bio description
          default: ''
        description_urls:
          items:
            type: string
          type: array
          title: Description Urls
          description: List of URLs found in the user's description
          default: []
        urls:
          anyOf:
          - items:
              $ref: '#/components/schemas/urlModel'
            type: array
          - type: 'null'
          title: Urls
          description: List of URLs found in the user's profile
        fast_followers_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fast Followers Count
          description: Count of fast followers
          default: 0
        favourites_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Favourites Count
          description: Number of tweets the user has liked
          default: 0
        followers_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Followers Count
          description: Number of followers
          default: 0
        following_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Following Count
          description: Number of users this user is following
          default: 0
        has_custom_timelines:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Has Custom Timelines
          description: Whether the user has custom timelines
          default: false
        is_blue_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Blue Verified
          description: Blue verification status
          default: false
        verified_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Verified Type
          description: 'Verification badge type when not blue-only: blue, business, government, etc.'
          examples:
          - government
          - business
          - blue
        is_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Verified
          description: True if the account has any verification badge (blue, business, government, or legacy verified)
          default: false
        profile_image_shape:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile Image Shape
          description: Profile image shape (Circle or Square; Square often indicates business/government)
          examples:
          - Circle
          - Square
        is_translator:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Translator
          description: Whether the user is a translator
          default: false
        listed_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Listed Count
          description: Number of public lists the user is a member of
          default: 0
        location:
          anyOf:
          - type: string
          - type: 'null'
          title: Location
          description: User's location
          default: ''
          example: New York, USA
        media_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Media Count
          description: Number of media tweets posted by the user
          default: 0
        normal_followers_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Normal Followers Count
          description: Count of normal followers
          default: 0
        pinned_tweet_ids:
          items:
            type: string
          type: array
          title: Pinned Tweet Ids
          description: List of pinned tweet IDs
          default: []
        possibly_sensitive:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Possibly Sensitive
          description: Whether the user's profile may contain sensitive content
          default: false
        profile_banner_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile Banner Url
          description: URL of the user's profile banner
        profile_image_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile Image Url
          description: URL of the user's profile image
        protected:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Protected
          description: Whether the user's tweets are protected
          default: false
        statuses_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Statuses Count
          description: Number of tweets posted by the user
          default: 0
      type: object
      required:
      - id
      - name
      - screen_name
      title: UserModel
    SearchUserResponse:
      properties:
        code:
          type: integer
          title: Code
          description: The status code of the response.
        msg:
          type: string
          title: Msg
          description: The message of the response.
        data:
          items:
            $ref: '#/components/schemas/UserModel'
          type: array
          title: Data
          description: A list of user objects.
      type: object
      required:
      - code
      - msg
      - data
      title: SearchUserResponse
    UsersDetailsResponse:
      properties:
        code:
          type: integer
          title: Code
          description: The status code of the response.
        msg:
          type: string
          title: Msg
          description: The message of the response.
        data:
          items:
            $ref: '#/components/schemas/UserModel'
          type: array
          title: Data
          description: A list of user objects.
      type: object
      required:
      - code
      - msg
      - data
      title: UsersDetailsResponse
    UnfollowUserResponse:
      properties:
        code:
          type: integer
          title: Code
          description: The status code of the response.
        msg:
          type: string
          title: Msg
          description: The message of the response.
        data:
          anyOf:
          - $ref: '#/components/schemas/UserModel'
          - type: 'null'
          description: A confirmation of the action's success.
      type: object
      required:
      - code
      - msg
      title: UnfollowUserResponse
    AccountVerifyResponse:
      properties:
        code:
          type: integer
          title: Code
          description: The status code of the response.
        msg:
          type: string
          title: Msg
          description: The message of the response.
        data:
          items:
            $ref: '#/components/schemas/AccountVerifyModel'
          type: array
          title: Data
          description: A list of account verification objects.
      type: object
      required:
      - code
      - msg
      - data
      title: AccountVerifyResponse
    UnfollowUserQuery:
      properties:
        username:
          type: string
          title: Username
          description: The username of the user to unfollow.
        cookie:
          type: string
          title: Cookie
          description: The user's own authorized Twitter session credentials or auth_token (BYOC — Bring Your Own Cookie). Stateless proxy execution with zero credential retention. See [Authentication Security](/authentication#write-operations--byoc-bring-your-own-cookie) and [How to get Cookie](https://youtube-promotion.pages.dev/how-to-get-twitter-cookie).
          example: ct0=abc123... or 2c4a4e1832096aa694c739b83c83b6d96d43eba7
      type: object
      required:
      - username
      - cookie
      title: UnfollowUserQuery
    urlModel:
      properties:
        url:
          type: string
          title: Url
          description: URL
          example: https://www.google.com
        expanded_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Expanded Url
          description: Expanded URL
          example: https://www.google.com
        display_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Url
          description: Display URL
          example: www.google.com
      type: object
      required:
      - url
      title: urlModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UserModel_2:
      properties:
        id:
          type: string
          title: Id
          description: User ID
          example: '1717001045992251392'
        name:
          type: string
          title: Name
          description: Display name
          example: Cryptoklepto
        screen_name:
          type: string
          title: Screen Name
          description: Twitter username
          example: CK_Cryptoklepto
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: Account creation date
          example: Mon Oct 28 02:32:47 +0000 2024
        created_at_datetime:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At Datetime
          description: Account creation datetime in ISO format
          example: '2024-10-28T02:32:47.000Z'
        can_media_tag:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Can Media Tag
          description: Whether the user can be tagged in media
          default: false
        default_profile:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Default Profile
          description: Whether the user has a default profile
          default: false
        default_profile_image:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Default Profile Image
          description: Whether the user has a default profile image
          default: false
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: User's bio description
          default: ''
        description_urls:
          items:
            type: string
          type: array
          title: Description Urls
          description: List of URLs found in the user's description
          default: []
        urls:
          anyOf:
          - items:
              $ref: '#/components/schemas/urlModel'
            type: array
          - type: 'null'
          title: Urls
          description: List of URLs found in the user's profile
        fast_followers_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fast Followers Count
          description: Count of fast followers
          default: 0
        favourites_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Favourites Count
          description: Number of tweets the user has liked
          default: 0
        followers_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Followers Count
          description: Number of followers
          default: 0
        following_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Following Count
          description: Number of users this user is following
          default: 0
        has_custom_timelines:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Has Custom Timelines
          description: Whether the user has custom timelines
          default: false
        is_blue_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Blue Verified
          description: Blue verification status
          default: false
        verified_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Verified Type
          description: 'Verification badge type when not blue-only: blue, business, government, etc.'
          examples:
          - government
          - business
          - blue
        is_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Verified
          description: True if the account has any verification badge (blue, business, government, or legacy verified)
          default: false
        profile_image_shape:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile Image Shape
          description: Profile image shape (Circle or Square; Square often indicates business/government)
          examples:
          - Circle
          - Square
        is_translator:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Translator
          description: Whether the user is a translator
          default: false
        listed_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Listed Count
          description: Number of public lists the user is a member of
          default: 0
        location:
          anyOf:
          - type: string
          - type: 'null'
          title: Location
          description: User's location
          default: ''
          example: New York, USA
        media_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Media Count
          description: Number of media tweets posted by the user
          default: 0
        normal_followers_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Normal Followers Count
          description: Count of normal followers
          default: 0
        pinned_tweet_ids:
          items:
            type: string
          type: array
          title: Pinned Tweet Ids
          description: List of pinned tweet IDs
          default: []
        possibly_sensitive:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Possibly Sensitive
          description: Whether the user's profile may contain sensitive content
          default: false
        profile_banner_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile Banner Url
          description: URL of the user's profile banner
        profile_image_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile Image Url
          description: URL of the user's profile image
        protected:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Protected
          description: Whether the user's tweets are protected
          default: false
        statuses_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Statuses Count
          description: Number of tweets posted by the user
          default: 0
      type: object
      required:
      - id
      - name
      - screen_name
      title: UserModel
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: TwexAPI developer documentation
  url: https://docs.twexapi.io
x-refined-from:
- twexapi-io-docs-openapi.json
- twexapi-io-openapi.json