TwitterXApi

https://docs.twitterxapi.com/
Admin
TwitterXApi is a third-party Twitter API platform providing comprehensive access to tweets, users,...
Tokens:75,599
Snippets:402
Trust Score:5.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Fetch User Data with Java Unirest

Source: https://docs.twitterxapi.com/authentication

This Java example utilizes the Unirest library to make an authenticated GET request for user data. It demonstrates setting headers and handling the response, including error reporting.

```java
import kong.unirest.HttpResponse;
import kong.unirest.Unirest;

public class TwitterApiExample {
    public static void main(String[] args) {
        try {
            HttpResponse<String> response = Unirest
                .get("https://api.twexapi.io/twitter/users?usernames=elonmusk")
                .header("Authorization", "Bearer YOUR_API_KEY")
                .header("Content-Type", "application/json")
                .asString();
            
            if (response.getStatus() == 200) {
                System.out.println(response.getBody());
            } else {
                System.err.println("Error: " + response.getStatus() + " - " + response.getBody());
            }
        } catch (Exception e) {
            System.err.println("Request failed: " + e.getMessage());
        }
    }
}
```

--------------------------------

### GET /balance

Source: https://docs.twitterxapi.com/api-reference/balance-endpoints/get-balance

Retrieves the current account balance information.

```APIDOC
## GET /balance

### Description
Get the current account balance.

### Method
GET

### Endpoint
/balance

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code
- **msg** (string) - Response message
- **data** (object) - Response data

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": {}
}
```

--------------------------------

### GET /followers

Source: https://docs.twitterxapi.com/api-reference/followers-&-following-endpoints/get-followers-by-page

Retrieve a paginated list of followers for a user using cursor-based pagination.

```APIDOC
## GET /followers

### Description
Retrieve a paginated list of followers using cursor-based pagination. Each page returns up to 200 followers. Pass next_cursor from the previous response to continue.

### Method
GET

### Endpoint
/followers

### Parameters
#### Query Parameters
- **next_cursor** (string) - Optional - The cursor value from the previous response to fetch the next page of results.

### Response
#### Success Response (200)
- **followers** (array) - A list of follower objects.
- **next_cursor** (string) - The cursor to use for the next page of results.
```

--------------------------------

### Get Following by Page

Source: https://docs.twitterxapi.com/api-reference/followers-&-following-endpoints/get-following-by-page

Retrieve a paginated list of following users using cursor-based pagination. Each page returns up to 200 users. Pass next_cursor from the previous response to continue. Pricing: $0.14 per 1,000 following users.

```APIDOC
## GET /users/{user_id}/following

### Description
Retrieve a paginated list of users that a specified user is following. This endpoint uses cursor-based pagination to fetch results in batches.

### Method
GET

### Endpoint
/users/{user_id}/following

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user whose following list is to be retrieved.

#### Query Parameters
- **cursor** (string) - Optional - The cursor for the next page of results. If not provided, the first page is returned.
- **max_results** (integer) - Optional - The maximum number of results to return per page. Defaults to 200.

### Response
#### Success Response (200)
- **data** (array) - A list of user objects.
- **meta** (object)
  - **next_cursor** (string) - The cursor to retrieve the next page of results.
  - **result_count** (integer) - The number of results returned in this page.

#### Response Example
```json
{
  "data": [
    {
      "id": "12345",
      "name": "Example User 1",
      "username": "exampleuser1"
    },
    {
      "id": "67890",
      "name": "Example User 2",
      "username": "exampleuser2"
    }
  ],
  "meta": {
    "next_cursor": "abc123xyz789",
    "result_count": 200
  }
}
```
```

--------------------------------

### Fetch User Data with Python Requests

Source: https://docs.twitterxapi.com/authentication

This Python script demonstrates how to make an authenticated GET request to fetch user data using the 'requests' library. It includes error handling for non-200 status codes.

```python
import requests

# API endpoint and parameters
url = "https://api.twexapi.io/twitter/users"
params = {"usernames": "elonmusk"}

# Authentication header
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

# Make the request
response = requests.get(url, headers=headers, params=params)

# Handle the response
if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Error: {response.status_code} - {response.text}")
```

--------------------------------

### GET /verify-account-status

Source: https://docs.twitterxapi.com/api-reference/users-endpoints/verify-account-status

Retrieves the verification metadata for a specific account, including Blue Verified status and organization affiliation.

```APIDOC
## GET /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).

### Method
GET

### Endpoint
/verify-account-status
```

--------------------------------

### GET /twitter/following/{screen_name}/{count}

Source: https://docs.twitterxapi.com/api-reference/followers-&-following-endpoints/get-following

Retrieves a list of users that a specified user is following. This endpoint is useful for understanding a user's network and connections.

```APIDOC
## GET /twitter/following/{screen_name}/{count}

### Description
Get following of a user, $0.14/1000 following.

### Method
GET

### Endpoint
/twitter/following/{screen_name}/{count}

### Parameters
#### Path Parameters
- **screen_name** (string) - Required - The screen name of the user to get following.
- **count** (integer) - Required - The number of following to get.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code
- **msg** (string) - Response message
- **data** (array) - List of user info
  - **userId** (string) - User ID
  - **isBlueVerified** (boolean) - Blue verification status
  - **createdAt** (string) - Account creation date
  - **createdAtDatetime** (string or null) - Account creation datetime in ISO format
  - **defaultProfile** (boolean) - Default profile flag
  - **defaultProfileImage** (boolean) - Default profile image flag
  - **description** (string) - Bio description
  - **location** (string) - Location
  - **fastFollowersCount** (integer) - Fast followers count
  - **favouritesCount** (integer) - Likes count
  - **followersCount** (integer) - Followers count
  - **followingCount** (integer) - Following count

#### Response Example
```json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "userId": "1234567890",
      "isBlueVerified": true,
      "createdAt": "2020-01-01T12:00:00Z",
      "createdAtDatetime": "2020-01-01T12:00:00Z",
      "defaultProfile": false,
      "defaultProfileImage": false,
      "description": "Software Engineer",
      "location": "San Francisco, CA",
      "fastFollowersCount": 1000,
      "favouritesCount": 500,
      "followersCount": 10000,
      "followingCount": 500
    }
  ]
}
```

#### Error Response (422)
- **detail** (array) - Validation Error details
```

--------------------------------

### OpenAPI Specification for Get Multiple Users

Source: https://docs.twitterxapi.com/api-reference/users-endpoints/get-multiple-users-by-usernames

This OpenAPI specification defines the `/twitter/users` POST endpoint for retrieving multiple user profiles. It requires a Bearer token for authentication and accepts a JSON array of usernames or profile URLs in the request body. Unfound users are returned as null.

```yaml
openapi: 3.1.0
info:
  title: Twitter API Service
  description: |
            A comprehensive Twitter API service that provides various Twitter operations including:
            
            * **Search Operations**: Advanced search, hashtags, cashtags
            * **Tweet Operations**: Post, like, retweet, quote, bookmark, delete
            * **User Operations**: Batch user information retrieval
            * **Influencer Operations**: Get tweets from top influencers
            
            All endpoints return standardized responses in the format:
            ```json
            {
                "code": 200,
                "msg": "success", 
                "data": {...}
            }
            ```
            
            ## Authentication
            
            This API uses Bearer token authentication. Include your token in the Authorization header:
            ```
            Authorization: Bearer your_token_here
            ```
            
  contact:
    name: API Support
    email: support@twitterxapi.com
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twexapi.io
    description: Development server
security: []
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.14/1000 users.
      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
        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: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

```

--------------------------------

### GET /websites/twitterxapi

Source: https://docs.twitterxapi.com/api-reference/twitter-user-about-endpoints/get-twitter-user-about-by-screen-name

Retrieves detailed information about a Twitter user.

```APIDOC
## GET /websites/twitterxapi

### Description
Retrieves detailed information about a Twitter user, including their profile, verification status, and account history.

### Method
GET

### Endpoint
/websites/twitterxapi

### Parameters
#### Query Parameters
- **user_id** (string) - Required - The unique identifier of the user.

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier of the user.
- **avatar** (string) - URL of the user's avatar.
- **name** (string) - The user's display name.
- **screen_name** (string) - The user's unique username.
- **created_at** (string) - The date and time the user account was created.
- **profile_image_shape** (string) - The shape of the user's profile image.
- **verification** (object) - Information about the user's verification status.
  - **status** (string) - The verification status.
- **userLabelDisplayType** (string) - The display type of the user label.
- **userLabelType** (string) - The type of the user label.
- **is_blue_verified** (boolean) - Whether the user has a blue verification badge (Twitter Blue/X Premium).
- **privacy_policy_url** (string) - Privacy policy or learn more URL.
- **account_based_in** (string) - Country or region where the account is based.
- **location_accurate** (boolean) - Whether the location information is accurate.
- **affiliate_username** (string) - Affiliated username (e.g., business account username).
- **source** (string) - Source of account creation (e.g., 'United States App Store').
- **username_changes_count** (integer) - Number of times the username has been changed.
- **override_verified_year** (integer) - Override verified year (if applicable, negative values indicate special cases).
- **verified_since_msec** (integer) - Timestamp in milliseconds when the account was verified (negative values indicate special cases).

#### Response Example
```json
{
  "user_id": "1234567890",
  "avatar": "https://example.com/avatar.jpg",
  "name": "John Doe",
  "screen_name": "johndoe",
  "created_at": "2023-01-01T12:00:00Z",
  "profile_image_shape": "circle",
  "verification": {
    "status": "verified"
  },
  "userLabelDisplayType": "default",
  "userLabelType": "blue",
  "is_blue_verified": true,
  "privacy_policy_url": "https://help.twitter.com/managing-your-account/about-twitter-verified-accounts",
  "account_based_in": "United States",
  "location_accurate": true,
  "affiliate_username": "X",
  "source": "United States App Store",
  "username_changes_count": 0,
  "override_verified_year": -3000,
  "verified_since_msec": -156836000000000
}
```

#### Error Response (422)
- **loc** (array) - Location of the error in the request.
- **msg** (string) - Error message.
- **type** (string) - Error type.
- **input** (any) - The input that caused the error.
- **ctx** (object) - Context of the error.

#### Response Example
```json
{
  "loc": [
    "body",
    "user_id"
  ],
  "msg": "field required",
  "type": "value_error.missing",
  "input": {},
  "ctx": {}
}
```
```

--------------------------------

### Fetch User Data with cURL

Source: https://docs.twitterxapi.com/authentication

Use this cURL command to test API authentication and fetch user data. Ensure you replace YOUR_API_KEY with your valid API key.

```bash
curl --request GET \
  --url 'https://api.twexapi.io/twitter/users?usernames=elonmusk' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json'
```

--------------------------------

### GET /twitter/tweets/{tweet_id}/similar

Source: https://docs.twitterxapi.com/api-reference/tweets-endpoints/get-similar-tweets

Retrieves a list of tweets that are similar to a specified tweet.

```APIDOC
## GET /twitter/tweets/{tweet_id}/similar

### Description
Get similar tweets based on the provided tweet ID.

### Method
GET

### Endpoint
/twitter/tweets/{tweet_id}/similar

### Parameters
#### Path Parameters
- **tweet_id** (string) - Required - The unique identifier of the tweet for which to find similar tweets.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code, defaults to 200.
- **msg** (string) - Response message, defaults to "success".
- **data** (array of TweetModel or null) - A list of tweet objects or null if no similar tweets are found.

#### Response Example
```json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "tweet_id": "1803006263529541838",
      "is_paid_promotion": true,
      "text": "Example tweet text.",
      "created_at": "Mon Jun 17 03:51:48 +0000 2024",
      "created_at_datetime": "2024-06-17T03:51:48.000Z",
      "bookmark_count": 10,
      "bookmarked": false,
      "community_note": null,
      "edit_tweet_ids": [],
      "editable_until_msecs": null
    }
  ]
}
```

#### Error Response (422)
- **detail** (array of ValidationError) - Details about the validation error.
```

--------------------------------

### GET /twitter/{country}/trending

Source: https://docs.twitterxapi.com/api-reference/trending-endpoints/get-trending-topics

Retrieves trending topics for a specified country or globally.

```APIDOC
## GET /twitter/{country}/trending

### Description
Get trending topics for a given country. Use 'worldwide' for global trends or specific country codes.

### Method
GET

### Endpoint
/twitter/{country}/trending

### Parameters
#### Path Parameters
- **country** (string) - Required - Country code or 'worldwide' for global trends

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code
- **msg** (string) - Response message
- **data** (object) - Response data

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": {}
}
```

--------------------------------

### Documentation Index

Source: https://docs.twitterxapi.com/api-reference/notifications-endpoints/get-notifications

Fetch the complete documentation index to discover all available pages.

```APIDOC
## Documentation Index

### Description
Fetch the complete documentation index at: https://docs.twitterxapi.com/llms.txt
Use this file to discover all available pages before exploring further.

### Method
GET

### Endpoint
/llms.txt

### Parameters
(No parameters specified in the provided text)

### Request Example
(No request example specified in the provided text)

### Response
#### Success Response (200)
(Response content is the documentation index file)

#### Response Example
(No response example specified in the provided text)
```

--------------------------------

### POST /x/account/verify

Source: https://docs.twitterxapi.com/api-reference/users-endpoints/verify-account-status

Retrieves verification metadata for specific accounts, including Blue Verified status and organization affiliation.

```APIDOC
## POST /x/account/verify

### 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).

### Method
POST

### Endpoint
/x/account/verify

### Parameters
#### Request Body
- **Targets** (array of strings) - Required - The IDs or usernames of the users.

### Request Example
[
  "1696160451770429440",
  "elonmusk"
]

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message of the response.
- **data** (array) - A list of account verification objects.

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "user_id": "1696160451770429440",
      "screen_name": "elonmusk",
      "is_blue_verified": true,
      "is_verified_organization_affiliate": false,
      "is_verified": true
    }
  ]
}
```

--------------------------------

### GET /user/about

Source: https://docs.twitterxapi.com/api-reference/twitter-user-about-endpoints/get-twitter-user-about-by-screen-name

Retrieves profile information such as account location and accuracy for a specified Twitter user.

```APIDOC
## GET /user/about

### Description
Get Twitter User About for a specific twitter user. Returns account_based_in and location_accurate fields.

### Method
GET

### Endpoint
/user/about

### Parameters
#### Query Parameters
- **screen_name** (string) - Required - The Twitter screen name of the user.
```

--------------------------------

### GET /order/status

Source: https://docs.twitterxapi.com/api-reference/social-media-services-endpoints/check-order-status

Retrieve the current status and progress details for a specific Twitter engagement order.

```APIDOC
## GET /order/status

### Description
Check the delivery status and progress of your Twitter engagement order.

### Method
GET

### Endpoint
/order/status

### Response
#### Success Response (200)
- **order_id** (string) - Unique identifier for your order
- **start_count** (integer) - Initial engagement count when order began
- **fee** (number) - Total cost of the order in USD
- **status** (string) - Current order status (pending, in_progress, completed, partial, failed)

### Order Status Types
- pending: Order received and queued for processing
- in_progress: Services are being delivered
- completed: All services have been delivered successfully
- partial: Some services delivered (may continue processing)
- failed: Order could not be completed (contact support)
```

--------------------------------

### User Profile Object Structure

Source: https://docs.twitterxapi.com/api-reference/lists-endpoints/get-list-members-by-page

This snippet details the fields returned in a user profile object. It includes information such as account creation date, follower counts, bio, profile image URLs, and verification status.

```APIDOC
## User Profile Object

### Description
Represents a Twitter user's profile information.

### Fields
- **created_at** (string) - Account creation datetime in ISO format. Example: '2024-10-28T02:32:47.000Z'
- **can_dm** (boolean | null) - Whether the user can be direct messaged. Default: false
- **can_media_tag** (boolean | null) - Whether the user can be tagged in media. Default: false
- **default_profile** (boolean | null) - Whether the user has a default profile. Default: false
- **default_profile_image** (boolean | null) - Whether the user has a default profile image. Default: false
- **description** (string | null) - User's bio description. Default: ''
- **description_urls** (array[string]) - List of URLs found in the user's description. Default: []
- **urls** (array[object] | null) - List of URLs found in the user's profile. Each object should conform to the `urlModel` schema.
- **fast_followers_count** (integer | null) - Count of fast followers. Default: 0
- **favourites_count** (integer | null) - Number of tweets the user has liked. Default: 0
- **followers_count** (integer | null) - Number of followers. Default: 0
- **following_count** (integer | null) - Number of users this user is following. Default: 0
- **has_custom_timelines** (boolean | null) - Whether the user has custom timelines. Default: false
- **is_blue_verified** (boolean | null) - Blue verification status. Default: false
- **is_translator** (boolean | null) - Whether the user is a translator. Default: false
- **listed_count** (integer | null) - Number of public lists the user is a member of. Default: 0
- **location** (string | null) - User's location. Example: 'New York, USA'. Default: ''
- **media_count** (integer | null) - Number of media tweets posted by the user. Default: 0
- **normal_followers_count** (integer | null) - Count of normal followers. Default: 0
- **pinned_tweet_ids** (array[string]) - List of pinned tweet IDs. Default: []
- **possibly_sensitive** (boolean | null) - Whether the user's profile may contain sensitive content. Default: false
- **profile_banner_url** (string | null) - URL of the user's profile banner.
- **profile_image_url** (string | null) - URL of the user's profile image.
- **protected** (boolean | null) - Whether the user's tweets are protected. Default: false
- **statuses_count** (integer | null) - Number of tweets posted by the user. Default: 0
```

--------------------------------

### GET /tweets/user

Source: https://docs.twitterxapi.com/api-reference/all-tweets-replies-endpoints/get-all-tweets-and-replies-by-user

Retrieves a comprehensive list of all tweets and replies posted by a specific Twitter user.

```APIDOC
## GET /tweets/user

### Description
Get all tweets and replies posted by a specific Twitter user. Returns a comprehensive list including both original tweets and reply tweets posted by the user.

### Method
GET

### Endpoint
/tweets/user
```

--------------------------------

### Authentication

Source: https://docs.twitterxapi.com/api-reference/dm-endpoints/send-dm

Details on how to authenticate API requests using HTTP Bearer tokens.

```APIDOC
## Authentication

### Security Schemes

#### HTTPBearer
- **Type**: http
- **Scheme**: bearer

Requests must include an `Authorization` header with a valid Bearer token.

### Example Header
```
Authorization: Bearer YOUR_ACCESS_TOKEN
```
```

--------------------------------

### GET /twitter/community/{community_id}

Source: https://docs.twitterxapi.com/api-reference/communities-endpoints/get-community

Retrieves detailed information about a specific Twitter community by its unique identifier.

```APIDOC
## GET /twitter/community/{community_id}

### Description
Retrieves detailed information about a specific Twitter community by its unique identifier.

### Method
GET

### Endpoint
/twitter/community/{community_id}

### Parameters
#### Path Parameters
- **community_id** (string) - Required - The unique identifier of the community.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message of the response.
- **data** (object) - A community object containing details like name, description, member count, and admin info.

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": {
    "id": "12345",
    "name": "Tech Enthusiasts",
    "description": "A community for tech lovers.",
    "member_count": 150
  }
}
```

--------------------------------

### User Model

Source: https://docs.twitterxapi.com/api-reference/communities-endpoints/get-community-tweets-by-page

Defines the structure for user objects, including profile information and account settings.

```APIDOC
## User Model

### Description
Represents a Twitter user account and their associated profile information.

### Properties
- **id** (string) - Required - The unique identifier for the user.
- **name** (string) - Required - The display name of the user.
- **screen_name** (string) - Required - The Twitter username.
- **created_at** (string | null) - Optional - The date the user account was created.
- **created_at_datetime** (string | null) - Optional - The datetime the user account was created in ISO format.
- **can_dm** (boolean | null) - Optional - Indicates if the user can be direct messaged. Defaults to false.
- **can_media_tag** (boolean | null) - Optional - Indicates if the user can be tagged in media. Defaults to false.
- **default_profile** (boolean | null) - Optional - Indicates if the user has their default profile.

### Example
```json
{
  "id": "1717001045992251392",
  "name": "Cryptoklepto",
  "screen_name": "CK_Cryptoklepto",
  "created_at": "Mon Oct 28 02:32:47 +0000 2024",
  "created_at_datetime": "2024-10-28T02:32:47.000Z",
  "can_dm": true,
  "can_media_tag": false,
  "default_profile": false
}
```
```

--------------------------------

### Authentication

Source: https://docs.twitterxapi.com/api-reference/tweet-actions-endpoints/create-a-quote-tweet

Details regarding the security schemes used for API access.

```APIDOC
## Authentication

### Security Scheme
- **Name**: HTTPBearer
- **Type**: http
- **Scheme**: bearer
```

--------------------------------

### GET /twitter/{screen_name}/about

Source: https://docs.twitterxapi.com/api-reference/twitter-user-about-endpoints/get-twitter-user-about-by-screen-name

Retrieves detailed information about a specific Twitter user by their screen name.

```APIDOC
## GET /twitter/{screen_name}/about

### Description
Get Twitter User About for a specific twitter user. Returns account details such as user ID, avatar, name, and verification status.

### Method
GET

### Endpoint
/twitter/{screen_name}/about

### Parameters
#### Path Parameters
- **screen_name** (string) - Required - The screen name of the twitter user to get about.

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code
- **msg** (string) - Response message
- **data** (object) - Twitter User About data

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": {
    "user_id": "44196397",
    "avatar": "https://pbs.twimg.com/profile_images/1983681414370619392/oTT3nm5Z_normal.jpg",
    "name": "Elon Musk",
    "screen_name": "elonmusk",
    "created_at": "Tue Jun 02 20:12:29 +0000 2009",
    "profile_image_shape": "Circle",
    "verification": false,
    "userLabelDisplayType": "Badge",
    "userLabelType": "BusinessLabel"
  }
}
```

--------------------------------

### Fetch Article as Markdown

Source: https://docs.twitterxapi.com/api-reference/article-endpoints/fetch-article-as-markdown

Retrieves the content of an X (Twitter) article formatted as clean, valid Markdown. The response body is delivered as a raw UTF-8 string, optimized for direct import into static site generators, Obsidian, Notion, or any standard Markdown editor.

```APIDOC
## GET /x/article/{tweet_id}/markdown

### Description
Retrieves the content of an X (Twitter) article formatted as clean, valid Markdown. The response body is delivered as a raw UTF-8 string, optimized for direct import into static site generators, Obsidian, Notion, or any standard Markdown editor.

### Method
GET

### Endpoint
/x/article/{tweet_id}/markdown

### Parameters
#### Path Parameters
- **tweet_id** (string) - Required - The tweet ID of the article to get.

### Responses
#### Success Response (200)
- **text/plain** (string) - Raw Markdown string representing the article content.

#### Error Response (422)
- **application/json** - Validation Error
```

--------------------------------

### Get Notifications API

Source: https://docs.twitterxapi.com/api-reference/notifications-endpoints/get-notifications

Retrieves notifications. This endpoint has a rate limit of 12 calls per minute.

```APIDOC
## GET /notifications

### Description
Retrieves notifications. This endpoint has a rate limit of 12 calls per minute.

### Method
GET

### Endpoint
/notifications

### Parameters
#### Query Parameters
(No query parameters specified in the provided text)

#### Request Body
(No request body specified in the provided text)

### Response
#### Success Response (200)
(No response fields specified in the provided text)

#### Response Example
(No response example specified in the provided text)
```

--------------------------------

### GET /twitter/list/{list_id}/tweets/{target_count}

Source: https://docs.twitterxapi.com/api-reference/lists-endpoints/get-list-tweets

Retrieves a specified number of tweets from a given Twitter list.

```APIDOC
## GET /twitter/list/{list_id}/tweets/{target_count}

### Description
Get a list of tweets from a specific Twitter list.

### Method
GET

### Endpoint
/twitter/list/{list_id}/tweets/{target_count}

### Parameters
#### Path Parameters
- **list_id** (string) - Required - The unique identifier for the Twitter list.
- **target_count** (integer) - Required - The number of tweets to retrieve.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message of the response.
- **data** (array) - A list of tweet objects.

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "tweet_id": "1803006263529541838",
      "text": "Example tweet content",
      "created_at": "Mon Jun 17 03:51:48 +0000 2024"
    }
  ]
}
```

--------------------------------

### User Information Structure

Source: https://docs.twitterxapi.com/api-reference/followers-&-following-endpoints/get-latest-followers

Details about the UserInfo object returned by the API.

```APIDOC
## UserInfo Object

### Description
User information structure containing various details about a Twitter user.

### Properties
- **userId** (integer) - Required - User ID
- **isBlueVerified** (boolean) - Required - Blue verified status
- **createdAt** (string) - Required - Account creation date
- **defaultProfile** (boolean) - Required - Default profile flag
- **defaultProfileImage** (boolean) - Required - Default profile image flag
- **description** (string) - Required - User description
- **location** (string) - Required - User location
- **fastFollowersCount** (integer) - Required - Fast followers count
- **favouritesCount** (integer) - Required - Favorites count
- **followersCount** (integer) - Required - Followers count
- **followingCount** (integer) - Required - Following count
- **hasCustomTimelines** (boolean) - Required - Custom timelines flag
- **isTranslator** (boolean) - Required - Translator flag
- **listedCount** (integer) - Required - Listed count
- **mediaCount** (integer) - Required - Media count
- **name** (string) - Required - Display name
- **normalFollowersCount** (integer) - Required - Normal followers count
- **possiblySensitive** (boolean) - Required - Possibly sensitive flag
- **profileImageUrlHttps** (string) - Required - Profile image URL
- **username** (string) - Required - Username
- **statusesCount** (integer) - Required - Tweets count
- **verified** (boolean) - Required - Legacy verification status
- **protected** (boolean) - Required - Protected account flag
- **url** (string) - Optional - User profile URL
- **descriptionUrls** (array) - Optional - Description URLs
- **urls** (array) - Optional - User URLs
- **pinnedTweetIds** (array) - Optional - Pinned tweet IDs
- **pinnedTweetIdsStr** (array) - Optional - Pinned tweet IDs as strings
- **translatorType** (string) - Optional - Translator type
- **withheldInCountries** (array) - Optional - Withheld in countries
```

--------------------------------

### GET /tweets/user/replies

Source: https://docs.twitterxapi.com/api-reference/all-tweets-replies-endpoints/get-all-tweets-and-replies-by-user-by-page

Retrieve a paginated list of a user's tweets and replies using cursor-based pagination.

```APIDOC
## GET /tweets/user/replies

### Description
Retrieve a paginated list of a user's tweets and replies using cursor-based pagination. Each page returns up to 20 items.

### Method
GET

### Endpoint
/tweets/user/replies

### Parameters
#### Query Parameters
- **next_cursor** (string) - Optional - The cursor value from the previous response to fetch the next page of results.

### Response
#### Success Response (200)
- **items** (array) - A list of up to 20 tweets and replies.
- **next_cursor** (string) - The cursor to be used for the next page request.
```

--------------------------------

### Security Configuration

Source: https://docs.twitterxapi.com/api-reference/communities-endpoints/get-community-tweets

Details regarding the authentication mechanism used for the TwitterX API.

```APIDOC
## Security Scheme

### Description
The API uses HTTP Bearer authentication to secure endpoints.

### Scheme
- **HTTPBearer** (http) - Bearer token authentication
```

--------------------------------

### GET /twitter/tweets/{tweet_id}/retweeters/{target_count}

Source: https://docs.twitterxapi.com/api-reference/tweet-engagement-endpoints/get-retweeters

Retrieves a list of users who have retweeted a specific tweet, up to a specified target count.

```APIDOC
## GET /twitter/tweets/{tweet_id}/retweeters/{target_count}

### Description
Get a list of users who retweeted the specified tweet.

### Method
GET

### Endpoint
/twitter/tweets/{tweet_id}/retweeters/{target_count}

### Parameters
#### Path Parameters
- **tweet_id** (string) - Required - The ID of the tweet to fetch retweeters for.
- **target_count** (integer) - Required - The number of retweeters to retrieve.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message of the response.
- **data** (array) - A list of user objects.

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "id": "1717001045992251392",
      "name": "Cryptoklepto",
      "screen_name": "CK_Cryptoklepto"
    }
  ]
}
```

--------------------------------

### Security Schemes

Source: https://docs.twitterxapi.com/api-reference/lists-endpoints/get-list-subscribers

Details the security schemes supported by the API.

```APIDOC
## Security Schemes

### HTTPBearer
- **type**: http
- **scheme**: bearer
```

--------------------------------

### Media Model

Source: https://docs.twitterxapi.com/api-reference/communities-endpoints/get-community-tweets-by-page

Defines the structure for media objects, including images, videos, and their associated metadata.

```APIDOC
## Media Model

### Description
Represents a media object associated with a tweet, such as an image or video.

### Properties
- **id** (string) - Required - The unique identifier for the media.
- **type** (string) - Required - The type of media (e.g., 'photo', 'video').
- **display_url** (string | null) - Optional - The URL of the media to display.
- **expanded_url** (string | null) - Optional - The expanded URL for the media.
- **media_url** (string | null) - Optional - The direct URL to the media file.
- **url** (string | null) - Optional - The t.co URL for the media.
- **height** (integer | null) - Optional - The height of the media in pixels.
- **width** (integer | null) - Optional - The width of the media in pixels.
- **features** (object | null) - Optional - Additional features of the media.
- **original_info** (object | null) - Optional - Original information about the media.
- **sizes** (object | null) - Optional - Available sizes of the media.
- **source_status_id** (string | null) - Optional - The source tweet ID if the media is a retweet.
- **source_user_id** (string | null) - Optional - The source user ID if the media is a retweet.
- **duration_millis** (integer | null) - Optional - The duration of the video in milliseconds.
- **aspect_ratio** (array[integer] | null) - Optional - The aspect ratio of the video.
- **video_info** (object | null) - Optional - Detailed video information.
- **streams** (array[StreamModel]) - Optional - A list of available video streams. Defaults to an empty array.

### Example
```json
{
  "id": "1802991873836883968",
  "type": "photo",
  "display_url": "pic.twitter.com/.",
  "media_url": "http://pbs.twimg.com/media/.",
  "url": "http://t.co/.",
  "height": 1080,
  "width": 1920,
  "aspect_ratio": [
    16,
    9
  ]
}
```
```

--------------------------------

### GET /dm/permissions

Source: https://docs.twitterxapi.com/api-reference/dm-endpoints/check-dm-permissions-v2

Retrieves the Direct Message (DM) availability status for a list of users based on their privacy settings and permissions.

```APIDOC
## GET /dm/permissions

### Description
Retrieves the Direct Message (DM) availability status for a list of users. This endpoint checks if the specified accounts can receive messages based on their privacy settings, follow status, or verified permissions.

### Method
GET

### Endpoint
/dm/permissions
```

--------------------------------

### POST /articles/batch

Source: https://docs.twitterxapi.com/api-reference/article-endpoints/batch-fetch-x-articles

Retrieves detailed article content for a specified list of X (Twitter) IDs.

```APIDOC
## POST /articles/batch

### Description
Retrieves detailed article content for a specified list of X (Twitter) IDs. Use this endpoint to fetch full text, metadata, and media links for multiple posts in a single request.

### Method
POST

### Endpoint
/articles/batch
```

--------------------------------

### Get Followers API

Source: https://docs.twitterxapi.com/api-reference/followers-&-following-endpoints/get-followers

Retrieves a list of followers for a specified Twitter user. This endpoint supports pagination and returns user information.

```APIDOC
## GET /twitter/followers/{screen_name}/{count}

### Description
Get followers of a user, $0.14/1000 followers.

### Method
GET

### Endpoint
/twitter/followers/{screen_name}/{count}

### Parameters
#### Path Parameters
- **screen_name** (string) - Required - The screen name of the user to get followers.
- **count** (integer) - Required - The number of followers to get.

### Request Example
```json
{
  "example": "Not applicable for GET request"
}
```

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code
- **msg** (string) - Response message
- **data** (array) - List of user info
  - **userId** (string) - User ID
  - **isBlueVerified** (boolean) - Blue verification status
  - **createdAt** (string) - Account creation date
  - **createdAtDatetime** (string or null) - Account creation datetime in ISO format
  - **defaultProfile** (boolean) - Default profile flag
  - **defaultProfileImage** (boolean) - Default profile image flag
  - **description** (string) - Bio description
  - **location** (string) - Location
  - **fastFollowersCount** (integer) - Fast followers count
  - **favouritesCount** (integer) - Likes count
  - **followersCount** (integer) - Followers count
  - **followingCount** (integer) - Following count

#### Response Example
```json
{
    "code": 200,
    "msg": "success", 
    "data": [
        {
            "userId": "1234567890",
            "isBlueVerified": true,
            "createdAt": "2020-01-01",
            "createdAtDatetime": "2020-01-01T10:00:00Z",
            "defaultProfile": false,
            "defaultProfileImage": false,
            "description": "Tech enthusiast and developer.",
            "location": "San Francisco, CA",
            "fastFollowersCount": 15000,
            "favouritesCount": 500,
            "followersCount": 100000,
            "followingCount": 200
        }
    ]
}
```

#### Error Response (422)
- **detail** (array) - Validation error details
```

--------------------------------

### GET /twitter/latest-followers/{screen_name}

Source: https://docs.twitterxapi.com/api-reference/followers-&-following-endpoints/get-latest-followers

Retrieves the latest followers for a specified Twitter user. This endpoint is billed at $0.14 per 1000 followers.

```APIDOC
## GET /twitter/latest-followers/{screen_name}

### Description
Get latest followers of a user, $0.14/1000 followers.

### Method
GET

### Endpoint
/twitter/latest-followers/{screen_name}

### Parameters
#### Path Parameters
- **screen_name** (string) - Required - The screen name of the user to get latest followers.

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code
- **msg** (string) - Response message
- **data** (array) - List of user info

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "userId": "12345",
      "isBlueVerified": true,
      "followersCount": 100
    }
  ]
}
```

--------------------------------

### POST /twitter/list/create

Source: https://docs.twitterxapi.com/api-reference/lists-endpoints/create-list

Creates a new Twitter list. This operation costs $0.0025 per call.

```APIDOC
## POST /twitter/list/create

### Description
Create a new Twitter list for the authenticated user.

### Method
POST

### Endpoint
/twitter/list/create

### Parameters
#### Request Body
- **cookie** (string) - Required - The user's Twitter authentication cookie or Twitter auth_token.
- **list_name** (string) - Required - The name of the list.
- **list_description** (string) - Required - The description of the list.
- **is_private** (boolean) - Required - Whether the list is private.

### Request Example
{
  "cookie": "ct0=abc123...",
  "list_name": "My New List",
  "list_description": "A description of my list",
  "is_private": true
}

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message of the response.
- **data** (object) - The list object containing id, name, description, is_private, member_count, and subscriber_count.

#### Response Example
{
  "code": 200,
  "msg": "success",
  "data": {
    "id": "12345",
    "name": "My New List",
    "description": "A description of my list",
    "is_private": true,
    "member_count": 0,
    "subscriber_count": 0
  }
}
```

--------------------------------

### DM Status API

Source: https://docs.twitterxapi.com/api-reference/dm-endpoints/dm-status

This API endpoint allows you to get the DM status of a user. It requires a list of usernames in the request body.

```APIDOC
## POST /dm/status

### Description
get DM status of a user

### Method
POST

### Endpoint
/dm/status

### Parameters
#### Request Body
- **Screen Names** (array of strings) - Required - The username of the user.

### Request Example
```json
[
  "elonmusk"
]
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **msg** (string) - The message of the response.
- **data** (array of objects) - A list of DM status objects.
  - **username** (string) - The username of the user.
  - **dm_status** (boolean) - The DM status of the user.

#### Response Example
```json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "username": "elonmusk",
      "dm_status": true
    }
  ]
}
```

#### Error Response (422)
- **detail** (array of objects) - Validation Error details.
```
Tokens:
Raw