TwitterAPI

https://docs.twitterapi.io
Admin
TwitterAPI.io is a reliable, high-performance, and cost-effective third-party API offering...
Tokens:61,621
Snippets:180
Trust Score:7.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### OpenAPI Specification for Get User Followings

Source: https://docs.twitterapi.io/api-reference/endpoint/get_user_followings

Defines the GET /twitter/user/followings endpoint, including parameters for username, pagination cursor, and page size.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/user/followings:
    get:
      description: >-
        Get user followings (with full profile metadata). Sorted by follow date
        — most recent followings appear on the first page. Use `cursor` for
        pagination.


        ## Tiered pricing (per following returned)


        > **Credits ↔ USD:** 100,000 credits = $1.00 (1 credit ≈ $0.00001)


        | Returned followings per call | Price | USD equivalent |

        |---|---|---|

        | 200 (max page size) | **1 credit / following** | **$0.01 / 1k
        followings** |

        | 100 - 199 | 2 credits / following | $0.02 / 1k followings |

        | 20 - 99 | 3 credits / following | $0.03 / 1k followings |


        💡 **At max page size, 100,000 following profiles cost just $1.00.**


        Minimum charge: **60 credits ($0.0006)** per call (20 followings × 3
        credits, the smallest page size).
      parameters:
        - name: userName
          in: query
          description: screen name of the user
          required: true
          schema:
            type: string
            format: string
        - name: cursor
          in: query
          description: The cursor to paginate through the results. First page is "".
          schema:
            type: string
            format: string
        - name: pageSize
          in: query
          description: >-
            The number of followings to return per page. Default is 200.min
            20,max 200
          schema:
            type: integer
            default: 200
      responses:
        '200':
          description: User followings
          content:
            application/json:
              schema:
                type: object
                properties:
                  followings:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserInfoBasic'
                    description: Array of followings
                  has_next_page:
                    type: boolean
                    description: Indicates if there are more results available
                  next_cursor:
                    type: string
                    description: Cursor for fetching the next page of results
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  message:
                    type: string
                    description: Message of the request.error message
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UserInfoBasic:
      type: object
      description: >-
        Basic user info without verification fields. Used by
        followers/followings endpoints.
      properties:
        type:
          type: string
          enum:
            - user
        userName:
          type: string
          description: The username of the Twitter user
        url:
          type: string
          description: The x.com URL of the user's profile
        id:
          type: string
          description: The unique identifier of the user
        name:
          type: string
          description: The display name of the user
        profilePicture:
          type: string
          description: URL of the user's profile picture
        coverPicture:
          type: string
          description: URL of the user's cover picture
        description:
          type: string
          description: The user's profile description
        location:
          type: string
```

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

### OpenAPI Specification for Get My Info

Source: https://docs.twitterapi.io/api-reference/endpoint/get_my_info

Defines the GET /oapi/my/info endpoint, including security requirements and response schemas.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /oapi/my/info:
    get:
      description: Get my info
      responses:
        '200':
          description: My info response
          content:
            application/json:
              schema:
                type: object
                properties:
                  recharge_credits:
                    type: integer
                    description: Remaining credits
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
```

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

### OpenAPI Specification for Get Article

Source: https://docs.twitterapi.io/api-reference/endpoint/get_article

Defines the GET /twitter/article endpoint, including parameters, security requirements, and the structure of the returned article object.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/article:
    get:
      description: get article by tweet id. cost 100 credit per article
      parameters:
        - name: tweet_id
          in: query
          description: The tweet id of the article.eg. 1905545699552375179
          required: true
          schema:
            type: string
            format: string
      responses:
        '200':
          description: Article response
          content:
            application/json:
              schema:
                type: object
                properties:
                  article:
                    type: object
                    properties:
                      author:
                        $ref: '#/components/schemas/UserInfo'
                        description: The user who posted the tweet
                      replyCount:
                        type: integer
                        description: The number of replies to the tweet
                      likeCount:
                        type: integer
                        description: The number of retweets of the tweet
                      quoteCount:
                        type: integer
                        description: The number of quotes of the tweet
                      viewCount:
                        type: integer
                        description: The number of views of the tweet
                      createdAt:
                        type: string
                        description: >-
                          The time when the tweet was posted.eg.Fri Mar 28
                          09:01:12 +0000 2025
                      title:
                        type: string
                        description: The title of the article
                      preview_text:
                        type: string
                        description: The preview text of the article.eg.
                      cover_media_img_url:
                        type: string
                        description: >-
                          The url of the cover media
                          image.eg.https://pbs.twimg.com/media/GnHXrznXUAEs-v5.jpg
                      contents:
                        type: array
                        description: Article content blocks
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              description: Block type
                              enum:
                                - unstyled
                                - header-one
                                - header-two
                                - header-three
                                - unordered-list-item
                                - ordered-list-item
                                - image
                                - gif
                                - markdown
                                - divider
                            text:
                              type: string
                              description: >-
                                Text content (for unstyled / header / list-item
                                / markdown blocks)
                            url:
                              type: string
                              description: >-
                                Media URL (for image: original image URL; for
                                gif: mp4 video URL)
                            previewUrl:
                              type: string
                              description: Preview thumbnail URL (gif only)
                            width:
                              type: integer
                              description: Original image width in pixels (image only)
                            height:
                              type: integer
                              description: Original image height in pixels (image only)
                            inlineStyleRanges:
                              type: array
                              description: >-
                                Inline style ranges for bold/italic etc.
                                (optional, text blocks only)
                              items:
                                type: object
                                properties:
                                  offset:
```

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

### OpenAPI Specification for Get Community Info

Source: https://docs.twitterapi.io/api-reference/endpoint/get_community_by_id

Defines the GET /twitter/community/info endpoint, including required parameters and the structure of the returned community object.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/community/info:
    get:
      description: >-
        Get community info by community id. Price: 20 credits per call. Note:
        This API is a bit slow, we are still optimizing it.
      parameters:
        - name: community_id
          in: query
          description: id of the community
          required: true
          schema:
            type: string
            format: string
      responses:
        '200':
          description: Community info response
          content:
            application/json:
              schema:
                type: object
                properties:
                  community_info:
                    type: object
                    properties:
                      id:
                        type: string
                        description: ID of the community
                      name:
                        type: string
                        description: Name of the community
                      description:
                        type: string
                        description: Description of the community
                      question:
                        type: string
                        description: Community question
                      member_count:
                        type: integer
                        description: Number of members in the community
                      moderator_count:
                        type: integer
                        description: Number of moderators in the community
                      created_at:
                        type: string
                        description: Creation date of the community
                      join_policy:
                        type: string
                        description: Join policy of the community
                      invites_policy:
                        type: string
                        description: Invites policy of the community
                      is_nsfw:
                        type: boolean
                        description: Whether the community is NSFW
                      is_pinned:
                        type: boolean
                        description: Whether the community is pinned
                      role:
                        type: string
                        description: User's role in the community
                      primary_topic:
                        type: object
                        properties:
                          id:
                            type: string
                            description: ID of the primary topic
                          name:
                            type: string
                            description: Name of the primary topic
                      banner_url:
                        type: string
                        description: URL of the community banner
                      search_tags:
                        type: array
                        items:
                          type: string
                        description: Search tags for the community
                      rules:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: ID of the rule
                            name:
                              type: string
                              description: Name of the rule
                            description:
                              type: string
                              description: Description of the rule
                        description: Community rules
                      creator:
                        $ref: '#/components/schemas/UserInfo'
                      admin:
                        $ref: '#/components/schemas/UserInfo'
                      members_preview:
                        type: array
                        items:
                          type: object
                          description: Member information with same structure as creator
                        description: Preview of community members
                  status:
                    type: string
```

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

### OpenAPI Specification for Get Users to Monitor Tweet

Source: https://docs.twitterapi.io/api-reference/endpoint/get_user_to_monitor_tweet

Defines the GET request structure, security requirements, and response schema for the user monitoring endpoint.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /oapi/x_user_stream/get_user_to_monitor_tweet:
    get:
      description: >-
        Get the list of users being monitored for real-time tweets. Returns all
        users that have been added for tweet monitoring. Please
        ref:https://twitterapi.io/twitter-stream
      responses:
        '200':
          description: List of monitored users
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  msg:
                    type: string
                    description: Message of the request
                  data:
                    type: array
                    description: List of monitored users
                    items:
                      type: object
                      properties:
                        id_for_user:
                          type: string
                          description: >-
                            Unique identifier for this monitoring entry. Use
                            this ID to remove the user from monitoring.
                        x_user_id:
                          type: integer
                          description: Twitter user ID
                        x_user_name:
                          type: string
                          description: Twitter display name
                        x_user_screen_name:
                          type: string
                          description: Twitter handle/screen name
                        is_monitor_tweet:
                          type: integer
                          description: Whether tweet monitoring is enabled (1=yes, 0=no)
                        is_monitor_profile:
                          type: integer
                          description: Whether profile monitoring is enabled (1=yes, 0=no)
                        monitor_tweet_config_status:
                          type: integer
                          description: Tweet monitoring configuration status
                        monitor_profile_config_status:
                          type: integer
                          description: Profile monitoring configuration status
                        created_at:
                          type: string
                          description: When the monitoring was created
                required:
                  - status
                  - msg
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
```

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

### OpenAPI Specification for Get User Info

Source: https://docs.twitterapi.io/api-reference/endpoint/get_user_by_username

Defines the GET /twitter/user/info endpoint, including request parameters, response schemas, and the UserInfo object structure.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/user/info:
    get:
      description: Get user info by screen name
      parameters:
        - name: userName
          in: query
          description: The screen name of the user
          schema:
            type: string
            format: string
      responses:
        '200':
          description: User info
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/UserInfo'
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  msg:
                    type: string
                    description: Message of the request.error message
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UserInfo:
      type: object
      properties:
        type:
          type: string
          enum:
            - user
        userName:
          type: string
          description: The username of the Twitter user
        url:
          type: string
          description: The x.com URL of the user's profile
        id:
          type: string
          description: The unique identifier of the user
        name:
          type: string
          description: The display name of the user
        isBlueVerified:
          type: boolean
          description: Whether the user has Twitter Blue verification
        verifiedType:
          type: string
          description: The type of verification. eg. "government" ,can be empty
        profilePicture:
          type: string
          description: URL of the user's profile picture
        coverPicture:
          type: string
          description: URL of the user's cover picture
        description:
          type: string
          description: The user's profile description
        location:
          type: string
          description: 'The user''s location.for example: 東京の端っこ . may be empty'
        followers:
          type: integer
          description: Number of followers
        following:
          type: integer
          description: Number of accounts following
        canDm:
          type: boolean
          description: Whether the user can receive DMs
        createdAt:
          type: string
          description: >-
            When the account was created.for example: Thu Dec 13 08:41:26 +0000
            2007
        favouritesCount:
          type: integer
          description: Number of favorites
        hasCustomTimelines:
          type: boolean
          description: Whether the user has custom timelines
        isTranslator:
          type: boolean
          description: Whether the user is a translator
        mediaCount:
          type: integer
          description: Number of media posts
        statusesCount:
          type: integer
          description: Number of status updates
        withheldInCountries:
          type: array
          items:
            type: string
          description: Countries where the account is withheld
        affiliatesHighlightedLabel:
          type: object
        possiblySensitive:
          type: boolean
          description: Whether the account may contain sensitive content
        pinnedTweetIds:
          type: array
          items:
            type: string
          description: IDs of pinned tweets
        isAutomated:
          type: boolean
          description: Whether the account is automated
        automatedBy:
          type: string
          description: The account that automated the account
        unavailable:
          type: boolean
          description: Whether the account is unavailable
        message:
          type: string
          description: >-
            The message of the account.eg. "This account is unavailable" or
            "This account is suspended"
        unavailableReason:
          type: string
          description: 'The reason the account is unavailable.eg. "suspended" '
        profile_bio:
          type: object
          properties:
            description:
              type: string
            entities:
              type: object
```

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

### OpenAPI Specification for Get List Followers

Source: https://docs.twitterapi.io/api-reference/endpoint/get_list_followers

Defines the GET /twitter/list/followers endpoint, including required parameters like list_id and optional cursor for pagination.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/list/followers:
    get:
      description: Get followers of a list. Page size is 20.
      parameters:
        - name: list_id
          in: query
          description: id of the list
          required: true
          schema:
            type: string
            format: string
        - name: cursor
          in: query
          description: cursor of the page
          required: false
          schema:
            type: string
            format: string
      responses:
        '200':
          description: List followers of the list
          content:
            application/json:
              schema:
                type: object
                properties:
                  followers:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserInfo'
                    description: Members of the list
                  has_next_page:
                    type: boolean
                    description: Indicates if there are more results available
                  next_cursor:
                    type: string
                    description: Cursor for fetching the next page of results
                  status:
                    type: string
                    description: 'Status of the request: success or error'
                    enum:
                      - success
                      - error
                  msg:
                    type: string
                    description: Message of the request, error message if status is error
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UserInfo:
      type: object
      properties:
        type:
          type: string
          enum:
            - user
        userName:
          type: string
          description: The username of the Twitter user
        url:
          type: string
          description: The x.com URL of the user's profile
        id:
          type: string
          description: The unique identifier of the user
        name:
          type: string
          description: The display name of the user
        isBlueVerified:
          type: boolean
          description: Whether the user has Twitter Blue verification
        verifiedType:
          type: string
          description: The type of verification. eg. "government" ,can be empty
        profilePicture:
          type: string
          description: URL of the user's profile picture
        coverPicture:
          type: string
          description: URL of the user's cover picture
        description:
          type: string
          description: The user's profile description
        location:
          type: string
          description: 'The user''s location.for example: 東京の端っこ . may be empty'
        followers:
          type: integer
          description: Number of followers
        following:
          type: integer
          description: Number of accounts following
        canDm:
          type: boolean
          description: Whether the user can receive DMs
        createdAt:
          type: string
          description: >-
            When the account was created.for example: Thu Dec 13 08:41:26 +0000
            2007
        favouritesCount:
          type: integer
          description: Number of favorites
        hasCustomTimelines:
          type: boolean
          description: Whether the user has custom timelines
        isTranslator:
          type: boolean
          description: Whether the user is a translator
        mediaCount:
          type: integer
          description: Number of media posts
        statusesCount:
          type: integer
          description: Number of status updates
        withheldInCountries:
          type: array
          items:
            type: string
          description: Countries where the account is withheld
        affiliatesHighlightedLabel:
          type: object
        possiblySensitive:
          type: boolean
          description: Whether the account may contain sensitive content
        pinnedTweetIds:
          type: array
          items:
            type: string
          description: IDs of pinned tweets
        isAutomated:
          type: boolean
          description: Whether the account is automated
```

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

### OpenAPI Specification for Get User Followers

Source: https://docs.twitterapi.io/api-reference/endpoint/get_user_followers

Defines the GET /twitter/user/followers endpoint, including parameters for userName, cursor, and pageSize, along with the response schema.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/user/followers:
    get:
      description: >-
        Get user followers (with full profile metadata) in reverse chronological
        order (newest first). Sorted by follow date — most recent followers
        appear on the first page. Use `cursor` for pagination through the
        complete followers list.


        ## Tiered pricing (per follower returned)


        > **Credits ↔ USD:** 100,000 credits = $1.00 (1 credit ≈ $0.00001)


        | Returned followers per call | Price | USD equivalent |

        |---|---|---|

        | 200 (max page size) | **1 credit / follower** | **$0.01 / 1k
        followers** |

        | 100 - 199 | 2 credits / follower | $0.02 / 1k followers |

        | 20 - 99 | 3 credits / follower | $0.03 / 1k followers |


        💡 **At max page size, 100,000 follower profiles cost just $1.00.**


        Minimum charge: **60 credits ($0.0006)** per call (20 followers × 3
        credits, the smallest page size).


        For pure follower-ID collection at scale, see the cheaper
        [`/twitter/user/followers_ids`](/api-reference/endpoint/get_user_followers_ids)
        endpoint — no profile metadata, up to 5,000 IDs per call, as low as
        $0.0045 per 1,000 IDs at the bulk tier.
      parameters:
        - name: userName
          in: query
          description: screen name of the user
          required: true
          schema:
            type: string
            format: string
        - name: cursor
          in: query
          description: The cursor to paginate through the results. First page is "".
          schema:
            type: string
            format: string
        - name: pageSize
          in: query
          description: >-
            The number of followings to return per page. Default is 200.min
            20,max 200
          schema:
            type: integer
            default: 200
      responses:
        '200':
          description: User info
          content:
            application/json:
              schema:
                type: object
                properties:
                  followers:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserInfoBasic'
                    description: Array of followers
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  message:
                    type: string
                    description: Message of the request.error message
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UserInfoBasic:
      type: object
      description: >-
        Basic user info without verification fields. Used by
        followers/followings endpoints.
      properties:
        type:
          type: string
          enum:
            - user
        userName:
          type: string
          description: The username of the Twitter user
        url:
          type: string
          description: The x.com URL of the user's profile
        id:
          type: string
          description: The unique identifier of the user
        name:
          type: string
```

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

### Authenticate API requests

Source: https://docs.twitterapi.io/authentication

Examples of how to include the x-api-key header in cURL, Python, and Java requests.

```bash
curl --location 'https://api.twitterapi.io/twitter/user/followings?userName=KaitoEasyAPI' \
--header 'x-api-key: my_test_xxxxx'
```

```python
import requests

url = 'https://api.twitterapi.io/twitter/user/followings?userName=KaitoEasyAPI'
headers = {'x-api-key': 'my_test_xxxxx'}
response = requests.get(url, headers=headers)
print(response.json())
```

```java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://api.twitterapi.io/twitter/user/followings?userName=KaitoEasyAPI")
    .addHeader("x-api-key", "my_test_xxxxx")
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
} catch (Exception e) {
    e.printStackTrace();
}
```

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

### OpenAPI Specification for Get Space Detail

Source: https://docs.twitterapi.io/api-reference/endpoint/get_space_detail

Defines the endpoint structure, parameters, and response schemas for retrieving space details.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/spaces/detail:
    get:
      description: Get spaces detail by space id
      parameters:
        - name: space_id
          in: query
          description: The id of the space
          schema:
            type: string
            format: string
      responses:
        '200':
          description: Spaces detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SpacesDetail'
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  msg:
                    type: string
                    description: Message of the request.error message
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SpacesDetail:
      type: object
      properties:
        id:
          type: string
          description: Space ID
        title:
          type: string
          description: Title of the Space
        state:
          type: string
          description: State of the Space, e.g. NotStarted/Live/Ended
        created_at:
          type: string
          description: 'When the Space was created. Example: 2025-12-13T05:54:20.327000Z'
        scheduled_start:
          type: string
          description: Scheduled start time of the Space
        updated_at:
          type: string
          description: When the Space was last updated
        media_key:
          type: string
          description: Media key associated with the Space
        is_subscribed:
          type: boolean
          description: Whether the current user is subscribed to the Space
        settings:
          type: object
          description: Settings of the Space
          properties:
            conversation_controls:
              type: integer
              description: Conversation control type
            disallow_join:
              type: boolean
              description: Whether users are disallowed from joining
            is_employee_only:
              type: boolean
              description: Whether only employees can join
            is_locked:
              type: boolean
              description: Whether the Space is locked
            is_muted:
              type: boolean
              description: Whether the Space is muted
            is_space_available_for_clipping:
              type: boolean
              description: Whether the Space is available for clipping
            is_space_available_for_replay:
              type: boolean
              description: Whether the Space is available for replay
            no_incognito:
              type: boolean
              description: Whether incognito mode is disabled
            narrow_cast_space_type:
              type: integer
              description: Narrow cast space type
            max_guest_sessions:
              type: integer
              description: Maximum number of guest sessions allowed
            max_admin_capacity:
              type: integer
              description: Maximum number of admins allowed
        stats:
          type: object
          description: Statistics of the Space
          properties:
            total_replay_watched:
              type: integer
              description: Total number of replay views
            total_live_listeners:
              type: integer
              description: Total number of live listeners
            total_participants:
              type: integer
              description: Total number of participants
        creator:
          type: object
          description: Creator of the Space
          properties:
            id:
              type: string
              description: User ID of the creator
            name:
              type: string
              description: Display name of the creator
            userName:
              type: string
              description: Username (handle) of the creator
            location:
              type: string
              description: Location of the creator
            url:
              type: string
```

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

### OpenAPI Specification for Get Tweets by IDs

Source: https://docs.twitterapi.io/api-reference/endpoint/get_tweet_by_ids

Defines the GET /twitter/tweets endpoint, including required parameters and the structure of the returned tweet objects.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/tweets:
    get:
      description: get tweet by tweet ids
      parameters:
        - name: tweet_ids
          in: query
          description: >-
            The tweet ids to get.eg.
            1846987139428634858,1866332309399781537,1868244766405870076. Use
            comma to separate multiple tweet ids
          required: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Tweets response
          content:
            application/json:
              schema:
                type: object
                properties:
                  tweets:
                    type: array
                    items:
                      $ref: '#/components/schemas/Tweet'
                    description: Array of tweets
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  message:
                    type: string
                    description: Message of the request.error message
                required:
                  - tweets
                  - status
                  - message
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Tweet:
      type: object
      properties:
        type:
          type: string
          enum:
            - tweet
        id:
          type: string
          description: The ID of the tweet
        url:
          type: string
          description: The URL of the tweet
        text:
          type: string
          description: The text of the tweet
        source:
          type: string
          description: The source of the tweet.eg. "Twitter for iPhone"
        retweetCount:
          type: integer
          description: The number of times the tweet has been retweeted
        replyCount:
          type: integer
          description: The number of times the tweet has been replied to
        likeCount:
          type: integer
          description: The number of times the tweet has been liked
        quoteCount:
          type: integer
          description: The number of times the tweet has been quoted
        viewCount:
          type: integer
          description: The number of times the tweet has been viewed
        createdAt:
          type: string
          description: >-
            The date and time the tweet was created.eg. Tue Dec 10 07:00:30
            +0000 2024
        lang:
          type: string
          description: The language of the tweet.eg. "en".may be empty
        bookmarkCount:
          type: integer
          description: The number of times the tweet has been bookmarked
        isReply:
          type: boolean
          description: Indicates if the tweet is a reply
        inReplyToId:
          type: string
          description: The ID of the tweet being replied to.may be empty
        conversationId:
          type: string
          description: The ID of the conversation the tweet is part of.may be empty
        displayTextRange:
          type: array
          description: >-
            specifies the UTF-16 code unit indices in full_text that define the
            visible portion of a Tweet.eg"@jack Thanks for the
            update!",display_text_range is [6, 28]
          items:
            type: integer
        inReplyToUserId:
          type: string
          description: The ID of the user being replied to.may be empty
        inReplyToUsername:
          type: string
          description: The username of the user being replied to.may be empty
        author:
          $ref: '#/components/schemas/UserInfo'
          description: The user who posted the tweet
        entities:
          $ref: '#/components/schemas/TweetEntities'
          description: The entities in the tweet.eg. hashtags,urls,mentions
        quoted_tweet:
          $ref: '#/components/schemas/Tweet'
          description: The tweet being quoted.may be null
        retweeted_tweet:
          $ref: '#/components/schemas/Tweet'
          description: The tweet being retweeted.may be null
        isLimitedReply:
          type: boolean
          description: >-
```

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

### OpenAPI Specification for user_login_v2

Source: https://docs.twitterapi.io/api-reference/endpoint/user_login_v2

Defines the POST request structure, including required authentication fields and proxy configuration, and the expected JSON response.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/user_login_v2:
    post:
      description: >-
        Log in directly using your email, username, password, and 2FA secret
        key. And obtain the Login_cookie,  to post tweets, etc. Please note that
        the Login_cookie obtained through login_v2 can only be used for APIs
        with the "v2" suffix, such as create_tweet_v2. Trial operation price:
        $0.005 per call. We highly recommend enabling 2FA for your login –
        otherwise, the login_cookie you obtain may be faulty, preventing you
        from posting tweets.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - user_name
                - email
                - password
                - proxy
              properties:
                user_name:
                  type: string
                  description: User name.Must be set
                email:
                  type: string
                  description: Email.Must be set
                password:
                  type: string
                  description: The password of the user
                totp_secret:
                  type: string
                  description: >-
                    TOTP/2FA secret (base32 seed, not a 6-digit code). Optional,
                    but strongly recommended — accounts without 2FA may yield a
                    login_cookie that gets flagged and can't post. To obtain: on
                    X, enable 2FA, choose "can't scan the QR code", and X shows
                    a 10+ character string — that's the TOTP secret.
                proxy:
                  type: string
                  description: >-
                    The proxy to use.Please use high-quality residential proxies
                    and avoid free proxies.Required.Example:
                    http://username:password@ip:port . You can get proxy from:
                    https://www.webshare.io/?referral_code=4e0q1n00a504
      responses:
        '200':
          description: Login response
          content:
            application/json:
              schema:
                type: object
                properties:
                  login_cookie:
                    type: string
                    description: >-
                      The login cookie of the user.Use this cookie to post
                      tweets, etc.You can only call v2 APIs with this cookie.If
                      your account is in good standing and you're using
                      residential proxies, the cookies will generally remain
                      valid indefinitely.
                  status:
                    type: string
                    description: Status of the request.success or error
                  msg:
                    type: string
                    description: Message of the request.error message
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
```

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

### OpenAPI Specification for Check Follow Relationship

Source: https://docs.twitterapi.io/api-reference/endpoint/check_follow_relationship

Defines the GET endpoint, required query parameters, and expected JSON response structure.

```yaml
openapi: 3.0.1
info:
  title: TwitterAPI.io the most stable/fastest/cheapest twitter api.
  description: Provide the most stable/fastest/cheapest twitter api.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twitterapi.io
security:
  - ApiKeyAuth: []
paths:
  /twitter/user/check_follow_relationship:
    get:
      description: >-
        Check if the user is following/followed by the target user. Trial
        operation price: 100 credits per call.
      parameters:
        - name: source_user_name
          in: query
          description: screen name of the source user
          required: true
          schema:
            type: string
            format: string
        - name: target_user_name
          in: query
          description: screen name of the target user
          schema:
            type: string
            format: string
      responses:
        '200':
          description: Check follow relationship response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      following:
                        type: boolean
                        description: Whether the source user is following the target user
                      followed_by:
                        type: boolean
                        description: Whether the source user is followed by the target user
                  status:
                    type: string
                    description: Status of the request.success or error
                    enum:
                      - success
                      - error
                  message:
                    type: string
                    description: Message of the request.error message
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
```
Tokens:
Raw