### Get User Info by Screen Name Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_user_by_username Fetches comprehensive user information based on their unique screen name. ```APIDOC ## GET /users/:screen_name ### Description Retrieves detailed information about a specific user identified by their screen name. ### Method GET ### Endpoint /users/:screen_name ### Parameters #### Path Parameters - **screen_name** (string) - Required - The screen name of the user to retrieve information for. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **id** (integer) - The user's ID. - **screen_name** (string) - The user's screen name. - **name** (string) - The user's display name. - **description** (string) - The user's profile description. - **followers_count** (integer) - The number of followers the user has. - **following_count** (integer) - The number of users the user is following. #### Response Example { "id": 123456789, "screen_name": "exampleuser", "name": "Example User", "description": "This is an example user profile.", "followers_count": 1500, "following_count": 300 } ``` -------------------------------- ### GET /users/{id} Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_community_by_id Retrieves detailed information about a specific user by their ID. ```APIDOC ## GET /users/{id} ### Description Retrieves detailed information about a specific user, including their profile details, follower counts, and verification status. ### Method GET ### Endpoint /users/{id} #### Path Parameters - **id** (string) - Required - The unique identifier of the user. ### Response #### Success Response (200) - **type** (string) - The type of the entity, expected to be 'user'. - **userName** (string) - The username of the Twitter user. - **url** (string) - The x.com URL of the user's profile. - **id** (string) - The unique identifier of the user. - **name** (string) - The display name of the user. - **isBlueVerified** (boolean) - Whether the user has Twitter Blue verification. - **verifiedType** (string) - The type of verification (e.g., "government"), can be empty. - **profilePicture** (string) - URL of the user's profile picture. - **coverPicture** (string) - URL of the user's cover picture. - **description** (string) - The user's profile description. - **location** (string) - The user's location (e.g., '東京の端っこ'), may be empty. - **followers** (integer) - Number of followers. - **following** (integer) - Number of accounts following. - **canDm** (boolean) - Whether the user can receive DMs. - **createdAt** (string) - When the account was created (e.g., 'Thu Dec 13 08:41:26 +0000 2007'). - **favouritesCount** (integer) - Number of favorites. - **hasCustomTimelines** (boolean) - Whether the user has custom timelines. - **isTranslator** (boolean) - Whether the user is a translator. - **mediaCount** (integer) - Number of media posts. - **statusesCount** (integer) - Number of status updates. - **withheldInCountries** (array of strings) - Countries where the account is withheld. - **affiliatesHighlightedLabel** (object) - Details about highlighted affiliate labels. - **possiblySensitive** (boolean) - Whether the account may contain sensitive content. - **pinnedTweetIds** (array of strings) - IDs of pinned tweets. - **isAutomated** (boolean) - Whether the account is automated. - **automatedBy** (string) - The account that automated the account. - **unavailable** (boolean) - Whether the account is unavailable. - **message** (string) - The message related to the account's availability (e.g., "This account is unavailable"). - **unavailableReason** (string) - The reason the account is unavailable (e.g., "suspended"). - **profile_bio** (object) - Contains the user's profile bio description and entities. - **description** (string) - The user's profile bio description. - **entities** (object) - **description** (object) - **urls** (array of objects) - URLs found in the description. - **url** (object) - **urls** (array of objects) - URLs found in the user's profile URL field. #### Error Response (404) - **error** (integer) - Error code. - **message** (string) - Error message. #### Response Example ```json { "type": "user", "userName": "exampleUser", "url": "https://x.com/exampleUser", "id": "1234567890", "name": "Example User", "isBlueVerified": true, "verifiedType": "", "profilePicture": "https://pbs.twimg.com/profile_images/123/abc.jpg", "coverPicture": "https://pbs.twimg.com/profile_banners/123/xyz.jpg", "description": "This is an example user description.", "location": "Example City", "followers": 10000, "following": 500, "canDm": true, "createdAt": "Tue Aug 28 21:16:23 +0000 2012", "favouritesCount": 150, "hasCustomTimelines": false, "isTranslator": false, "mediaCount": 75, "statusesCount": 5000, "withheldInCountries": [], "affiliatesHighlightedLabel": {}, "possiblySensitive": false, "pinnedTweetIds": ["111111111111111111", "222222222222222222"], "isAutomated": false, "automatedBy": "", "unavailable": false, "message": "", "unavailableReason": "", "profile_bio": { "description": "Bio text.", "entities": { "description": { "urls": [] }, "url": { "urls": [ { "display_url": "example.com", "expanded_url": "https://www.example.com", "indices": [0, 23], "url": "https://t.co/abcdefghij" } ] } } } } ``` ``` -------------------------------- ### Get Community Members Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_community_members Fetches a list of members belonging to a specific community. The default page size is 20. ```APIDOC ## GET /communities/{communityId}/members ### Description Retrieves a list of members associated with a given community ID. The results are paginated with a default page size of 20. ### Method GET ### Endpoint /communities/{communityId}/members ### Parameters #### Path Parameters - **communityId** (string) - Required - The unique identifier of the community. #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. - **pageSize** (integer) - Optional - The number of members to return per page (defaults to 20). ### Request Example ``` GET /communities/123e4567-e89b-12d3-a456-426614174000/members?page=1&pageSize=20 ``` ### Response #### Success Response (200) - **members** (array) - A list of community member objects. - **userId** (string) - The unique identifier of the user. - **username** (string) - The username of the member. - **joinedAt** (string) - The timestamp when the member joined the community. #### Response Example ```json { "members": [ { "userId": "user-abc-123", "username": "john_doe", "joinedAt": "2023-10-27T10:00:00Z" }, { "userId": "user-def-456", "username": "jane_smith", "joinedAt": "2023-10-26T15:30:00Z" } ] } ``` ``` -------------------------------- ### Get User Followers Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_user_followers Fetches a list of user followers in reverse chronological order. Supports pagination to retrieve all followers. ```APIDOC ## GET /users/:id/followers ### Description Get user followers in reverse chronological order (newest first). Returns exactly 200 followers per page, sorted by follow date. Most recent followers appear on the first page. Use cursor for pagination through the complete followers list. ### Method GET ### Endpoint /users/:id/followers ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the user whose followers to retrieve. #### Query Parameters - **cursor** (string) - Optional - The cursor for fetching the next page of followers. - **count** (integer) - Optional - The number of followers to return per page (default: 200). ### Request Example ``` GET /users/12345/followers?cursor=next_cursor_string ``` ### Response #### Success Response (200) - **users** (array) - A list of follower user objects. - **next_cursor** (string) - The cursor to use for fetching the next page of results. #### Response Example ```json { "users": [ { "id": "follower_id_1", "name": "Follower Name 1", "username": "follower_username_1" }, { "id": "follower_id_2", "name": "Follower Name 2", "username": "follower_username_2" } ], "next_cursor": "next_page_cursor" } ``` ``` -------------------------------- ### Get My Account Info Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_my_info Retrieves information about the authenticated user's account, including remaining credits. ```APIDOC ## GET /oapi/my/info ### Description Get my info ### Method GET ### Endpoint /oapi/my/info ### Parameters #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **recharge_credits** (integer) - Remaining credits #### Response Example ```json { "recharge_credits": 1000 } ``` #### Error Response (400) - **error** (integer) - Error code - **message** (string) - Error message #### Response Example ```json { "error": 1, "message": "An unexpected error occurred." } ``` ``` -------------------------------- ### Get Community Moderators Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_community_moderators Fetches a list of moderators for a specific community. The default page size is 20. ```APIDOC ## GET /community/moderators ### Description Get moderators of a community. Page size is 20. ### Method GET ### Endpoint /community/moderators ### Parameters #### Query Parameters - **community_id** (string) - Required - The ID of the community to retrieve moderators for. - **page_size** (integer) - Optional - The number of moderators to return per page. Defaults to 20. ### Request Example ``` GET /community/moderators?community_id=example_community_id&page_size=20 ``` ### Response #### Success Response (200) - **moderators** (array) - A list of moderator objects. - **user_id** (string) - The ID of the moderator. - **username** (string) - The username of the moderator. - **role** (string) - The role of the moderator within the community. #### Response Example ```json { "moderators": [ { "user_id": "user123", "username": "moderator_one", "role": "admin" }, { "user_id": "user456", "username": "moderator_two", "role": "editor" } ] } ``` ``` -------------------------------- ### GET /users/{userId} Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_space_detail Retrieves detailed information about a specific user, including their profile metrics, verification status, and account details. ```APIDOC ## GET /users/{userId} ### Description Retrieves detailed information about a specific user, including their profile metrics, verification status, and account details. ### Method GET ### Endpoint /users/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The unique identifier of the user. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **protected** (boolean) - Whether the creator's tweets are protected. - **isVerified** (boolean) - Whether the creator is legacy verified. - **isBlueVerified** (boolean) - Whether the creator has Twitter Blue verification. - **verifiedType** (string) - Type of verification, may be null. - **followers** (integer) - Number of followers. - **following** (integer) - Number of following. - **favouritesCount** (integer) - Number of favorites. - **statusesCount** (integer) - Number of status updates. - **mediaCount** (integer) - Number of media posts. - **createdAt** (string) - When the creator account was created. - **coverPicture** (string) - URL of the cover picture. - **profilePicture** (string) - URL of the profile picture. - **canDm** (boolean) - Whether the creator can receive DMs. - **affiliatesHighlightedLabel** (object) - Affiliate label information, may be empty object. - **isAutomated** (boolean) - Whether the account is automated. - **automatedBy** (string) - The account that automated this account, if any. - **participants** (object) - Participants of the Space grouped by role. - **admins** (array) - Admin participants. - **id** (string) - User ID of the participant, may be null. - **name** (string) - Display name of the participant. - **userName** (string) - Username (handle) of the participant. - **location** (string) - Location of the participant, may be null. - **url** (string) - URL in participant profile, may be null. - **description** (string) - Profile description, may be null. - **protected** (boolean) - Whether the participant's tweets are protected. - **isVerified** (boolean) - Whether the participant is legacy verified. - **isBlueVerified** (boolean) - Whether the participant has Twitter Blue verification. - **verifiedType** (string) - Type of verification, may be null. - **followers** (integer) - Number of followers. - **following** (integer) - Number of following. - **favouritesCount** (integer) - Number of favorites. - **statusesCount** (integer) - Number of status updates. - **mediaCount** (integer) - Number of media posts. - **createdAt** (string) - When the participant account was created, may be null. - **coverPicture** (string) - URL of the cover picture, may be null. - **profilePicture** (string) - URL of the profile picture. - **canDm** (boolean) - Whether the participant can receive DMs. - **affiliatesHighlightedLabel** (object) - Affiliate label information, may be empty object. - **isAutomated** (boolean) - Whether the account is automated. - **automatedBy** (string) - The account that automated this account, if any. #### Response Example ```json { "protected": false, "isVerified": true, "isBlueVerified": false, "verifiedType": "Community", "followers": 10000, "following": 500, "favouritesCount": 2500, "statusesCount": 15000, "mediaCount": 3000, "createdAt": "2020-01-15T10:00:00Z", "coverPicture": "https://example.com/cover.jpg", "profilePicture": "https://example.com/profile.jpg", "canDm": true, "affiliatesHighlightedLabel": {}, "isAutomated": false, "automatedBy": null, "participants": { "admins": [ { "id": "12345", "name": "Admin User", "userName": "@adminuser", "location": "Earth", "url": "https://example.com/admin", "description": "Administrator", "protected": false, "isVerified": true, "isBlueVerified": true, "verifiedType": "Blue", "followers": 15000, "following": 600, "favouritesCount": 3000, "statusesCount": 20000, "mediaCount": 4000, "createdAt": "2019-05-20T08:00:00Z", "coverPicture": "https://example.com/admin_cover.jpg", "profilePicture": "https://example.com/admin_profile.jpg", "canDm": true, "affiliatesHighlightedLabel": {}, "isAutomated": false, "automatedBy": null } ] } } ``` ``` -------------------------------- ### GET /twitter/user/batch_info_by_ids Source: https://kaikaikai.mintlify.app/api-reference/endpoint/batch_get_user_by_userids Batch get user info by user ids. This endpoint is designed for cost optimization by allowing bulk requests for multiple user profiles. ```APIDOC ## GET /twitter/user/batch_info_by_ids ### Description Batch get user info by user ids. Pricing: - Single user request: 18 credits per user - Bulk request (100+ users): 10 credits per user Note: For cost optimization, we recommend batching requests when fetching multiple user profiles. ### Method GET ### Endpoint /twitter/user/batch_info_by_ids ### Parameters #### Query Parameters - **userIds** (string) - Required - The user ids to get. eg. 1234567890,1234567891,1234567892. Use comma to separate multiple user ids ### Request Example ``` GET https://api.twitterapi.io/twitter/user/batch_info_by_ids?userIds=1234567890,1234567891 ``` ### Response #### Success Response (200) - **users** (array) - Array of user infos. Each user object contains: - **type** (string) - Enum: "user" - **userName** (string) - The username of the Twitter user - **url** (string) - The x.com URL of the user's profile - **id** (string) - The unique identifier of the user - **name** (string) - The display name of the user - **isBlueVerified** (boolean) - Whether the user has Twitter Blue verification - **verifiedType** (string) - The type of verification. eg. "government" ,can be empty - **profilePicture** (string) - URL of the user's profile picture - **coverPicture** (string) - URL of the user's cover picture - **description** (string) - The user's profile description - **location** (string) - The user's location. for example: 東京の端っこ . may be empty - **followers** (integer) - Number of followers - **following** (integer) - Number of accounts following - **canDm** (boolean) - Whether the user can receive DMs - **createdAt** (string) - When the account was created. for example: Thu Dec 13 08:41:26 +0000 2007 - **favouritesCount** (integer) - Number of favorites - **hasCustomTimelines** (boolean) - Whether the user has custom timelines - **isTranslator** (boolean) - Whether the user is a translator - **mediaCount** (integer) - Number of media posts - **statusesCount** (integer) - Number of status updates - **withheldInCountries** (array) - Countries where the account is withheld - **affiliatesHighlightedLabel** (object) - **possiblySensitive** (boolean) - Whether the account may contain sensitive content - **pinnedTweetIds** (array) - IDs of pinned tweets - **isAutomated** (boolean) - Whether the account is automated - **automatedBy** (string) - The account that automated the account - **unavailable** (boolean) - Whether the account is unavailable - **message** (string) - The message of the account. eg. "This account is unavailable" or "This account is suspended" - **status** (string) - Status of the request. enum: ["success", "error"] - **msg** (string) - Message of the request. error message #### Response Example ```json { "users": [ { "type": "user", "userName": "exampleUser", "url": "https://x.com/exampleUser", "id": "1234567890", "name": "Example User", "isBlueVerified": true, "verifiedType": "", "profilePicture": "https://pbs.twimg.com/profile_images/123/abc.jpg", "coverPicture": "https://pbs.twimg.com/profile_banners/123/xyz.jpg", "description": "This is an example user description.", "location": "Example Location", "followers": 10000, "following": 500, "canDm": true, "createdAt": "Thu Dec 13 08:41:26 +0000 2007", "favouritesCount": 150, "hasCustomTimelines": false, "isTranslator": false, "mediaCount": 200, "statusesCount": 5000, "withheldInCountries": [], "affiliatesHighlightedLabel": {}, "possiblySensitive": false, "pinnedTweetIds": ["1111111111111111111"], "isAutomated": false, "automatedBy": "", "unavailable": false, "message": "" } ], "status": "success", "msg": "" } ``` #### Error Response (400) - Description: Unexpected error - Content: application/json schema referencing `#/components/schemas/Error` ``` -------------------------------- ### Documentation Index Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_user_followings Fetches the complete documentation index, which can be used to discover all available API pages. ```APIDOC ## GET /websites/kaikaikai_mintlify_app/documentation/index ### Description Retrieves the complete documentation index for the project. This index lists all available API pages and can be used for discovery. ### Method GET ### Endpoint /websites/kaikaikai_mintlify_app/documentation/index ### Parameters None ### Request Example ``` GET /websites/kaikaikai_mintlify_app/documentation/index ``` ### Response #### Success Response (200) - **documentationUrl** (string) - A URL pointing to the documentation index file (e.g., a .txt file). #### Response Example ```json { "documentationUrl": "https://docs.twitterapi.io/llms.txt" } ``` ``` -------------------------------- ### API Key Authentication Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_community_by_id This section details how to authenticate your requests to the Kaikaikai Mintlify App API using an API key. The API key should be provided in the request headers. ```APIDOC ## API Key Authentication ### Description Requests to the Kaikaikai Mintlify App API must be authenticated using an API key. This key should be included in the `X-API-Key` header of your requests. ### Method All ### Endpoint All ### Parameters #### Header Parameters - **X-API-Key** (string) - Required - Your unique API key for authentication. ``` -------------------------------- ### GET /twitter/community/moderators OpenAPI Specification Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_community_moderators This OpenAPI 3.0.1 specification defines the GET /twitter/community/moderators endpoint. It allows retrieval of community moderators, including pagination details and user information. The API requires an ApiKeyAuth security scheme. ```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/moderators: get: description: Get moderators of a community. Page size is 20. parameters: - name: community_id in: query description: id of the community 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: Community moderator response content: application/json: schema: type: object properties: members: type: array items: $ref: '#/components/schemas/UserInfo' description: Moderators of the community has_next_page: type: boolean description: Whether there is a next page next_cursor: type: string description: Cursor of the next page 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 automatedBy: type: string description: The account that automated the account unavailable: type: boolean description: Whether the account is unavailable message: type: string ``` -------------------------------- ### Batch Get User Info By UserIds Source: https://kaikaikai.mintlify.app/api-reference/endpoint/batch_get_user_by_userids Retrieves information for multiple users by their IDs in a single request. This is recommended for cost optimization when fetching more than 100 user profiles. ```APIDOC ## POST /users/batch ### Description Batch get user info by user ids. Pricing: - Single user request: 18 credits per user - Bulk request (100+ users): 10 credits per user Note: For cost optimization, we recommend batching requests when fetching multiple user profiles. ### Method POST ### Endpoint /users/batch ### Parameters #### Query Parameters - **userIds** (array[string]) - Required - A list of user IDs to fetch information for. ### Request Body (Not applicable for this endpoint, use query parameters) ### Request Example ```json { "userIds": ["user123", "user456", "user789"] } ``` ### Response #### Success Response (200) - **users** (array[object]) - A list of user objects, each containing user information. - **userId** (string) - The unique identifier for the user. - **username** (string) - The username of the user. - **email** (string) - The email address of the user. #### Response Example ```json { "users": [ { "userId": "user123", "username": "john_doe", "email": "john.doe@example.com" }, { "userId": "user456", "username": "jane_smith", "email": "jane.smith@example.com" } ] } ``` ``` -------------------------------- ### GET /twitter/community/members OpenAPI Specification Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_community_members This OpenAPI 3.0.1 specification defines the GET endpoint for retrieving Twitter community members. It includes details on request parameters, response schemas for success and errors, and component schemas for user information. ```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/members: get: description: Get members of a community. Page size is 20. parameters: - name: community_id in: query description: id of the community 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: Community members response content: application/json: schema: type: object properties: members: type: array items: $ref: '#/components/schemas/UserInfo' description: Members of the community has_next_page: type: boolean description: Whether there is a next page next_cursor: type: string description: Cursor of the next page 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 profile 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: >- ``` -------------------------------- ### GET /twitter/tweets Endpoint Definition (OpenAPI) Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_tweet_by_ids Defines the GET /twitter/tweets endpoint in OpenAPI 3.0.1 format. This endpoint allows fetching tweets by their IDs, specifying query parameters, and outlining success and error responses. ```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: >- Whether the tweet is a limited reply. Possible restrictions: only mentioned users, verified users, or followed accounts can reply Error: required: - error - message type: object properties: ``` -------------------------------- ### Get User Followings Source: https://kaikaikai.mintlify.app/api-reference/endpoint/get_user_followings Retrieves a list of users that a specific user is following. The results are paginated, with each page containing 200 followings, sorted by follow date in descending order. ```APIDOC ## GET /users/:userId/followings ### Description Fetches the list of users that the specified user is following. Results are paginated and sorted by follow date, with the most recent followings appearing first. ### Method GET ### Endpoint /users/:userId/followings ### Parameters #### Path Parameters - **userId** (string) - Required - The unique identifier of the user whose followings are to be retrieved. #### Query Parameters - **cursor** (string) - Optional - A token indicating the starting point for the next page of results. Use this for pagination. ### Request Example ``` GET /users/12345/followings?cursor=next_cursor_token ``` ### Response #### Success Response (200) - **followings** (array) - A list of user objects representing the followed users. - **userId** (string) - The unique identifier of a followed user. - **username** (string) - The username of the followed user. - **followDate** (string) - The date and time when the follow action occurred. - **nextCursor** (string) - A token to retrieve the next page of results. Null if there are no more pages. #### Response Example ```json { "followings": [ { "userId": "67890", "username": "example_user", "followDate": "2023-10-27T10:00:00Z" } ], "nextCursor": "another_cursor_token" } ``` ```