twexapi-io Timeline Endpoints API

openapi: 3.2.0
info:
  title: Twexapi Io Timeline Endpoints API
  version: 1.0.0
  license:
    name: MIT
  description: 'Operations tagged Timeline Endpoints across 2 of this provider''s published API definitions: twexapi-io-docs-openapi.json, twexapi-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.twexapi.io
  description: Development server
tags:
- name: Timeline Endpoints
paths:
  /twitter/{screen_name}/timeline/page:
    post:
      tags:
      - Timeline Endpoints
      summary: Get User Timeline by Page
      description: Fetch a single page from a user's timeline using POST. Pass next_cursor in the body to continue.
      operationId: get_user_timeline_page_api_twitter__screen_name__timeline_page_post
      security:
      - HTTPBearer: []
      parameters:
      - name: screen_name
        in: path
        required: true
        schema:
          type: string
          description: Twitter screen name of the target user (with or without @).
          examples:
          - elonmusk
          title: Screen Name
        description: Twitter screen name of the target user (with or without @).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserTimelinePageQuery'
      responses:
        '200':
          description: Current page data and pagination metadata (has_next_page, next_cursor).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserTimelinePageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.twexapi.io
      description: Development server
  /twitter/{screen_name}/timeline:
    post:
      tags:
      - Timeline Endpoints
      summary: Get User Timeline and Fill Count
      description: Fetch a user's timeline across pages using POST and try to fill the requested count.
      operationId: get_user_timeline_fill_api_twitter__screen_name__timeline_post
      security:
      - HTTPBearer: []
      parameters:
      - name: screen_name
        in: path
        required: true
        schema:
          type: string
          description: Twitter screen name of the target user (with or without @).
          examples:
          - elonmusk
          title: Screen Name
        description: Twitter screen name of the target user (with or without @).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserTimelineFillQuery'
      responses:
        '200':
          description: All fetched tweets and pagination summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserTimelineResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.twexapi.io
      description: Production API
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserTimelinePageQuery:
      properties:
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
          description: Cursor returned by the previous page. Leave empty to fetch the first page.
          examples:
          - ''
        count:
          type: integer
          maximum: 100
          minimum: 1
          title: Count
          description: Maximum number of tweets to return for this page.
          default: 20
          examples:
          - 20
      type: object
      title: UserTimelinePageQuery
    UserTimelinePageResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code
          default: 200
        msg:
          type: string
          title: Msg
          description: Response message
          default: success
        data:
          items:
            $ref: '#/components/schemas/UserTweetItem'
          type: array
          title: Data
          description: Current page tweet items.
        has_next_page:
          type: boolean
          title: Has Next Page
          description: Whether another page is available.
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
          description: Use this cursor to fetch the next page when has_next_page is true.
          examples:
          - DAAHCgABHFeD5h9__-cLAAIAAAATMjAzODIzMzA5NTM4ODY4MDU5NAgAAwAAAAIAAA
        requested_count:
          type: integer
          title: Requested Count
          description: Original count requested by the client.
        effective_count:
          type: integer
          title: Effective Count
          description: Count after credit throttling was applied.
        parsed_count:
          type: integer
          title: Parsed Count
          description: Number of tweets actually parsed from the response.
      type: object
      required:
      - data
      - has_next_page
      - requested_count
      - effective_count
      - parsed_count
      title: UserTimelinePageResponse
    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
    UserTweetItem:
      properties:
        tweet_id:
          type: string
          title: Tweet Id
          description: Tweet ID
        is_paid_promotion:
          type: boolean
          title: Is Paid Promotion
          description: Whether the tweet is associated with a paid promotion
          default: false
        full_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Full Text
          description: Tweet text
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: Tweet creation time
        lang:
          anyOf:
          - type: string
          - type: 'null'
          title: Lang
          description: Tweet language
        conversation_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Conversation Id
          description: Conversation ID
        bookmark_count:
          type: integer
          title: Bookmark Count
          description: Bookmark count
          default: 0
        favorite_count:
          type: integer
          title: Favorite Count
          description: Like count
          default: 0
        reply_count:
          type: integer
          title: Reply Count
          description: Reply count
          default: 0
        retweet_count:
          type: integer
          title: Retweet Count
          description: Retweet count
          default: 0
        quote_count:
          type: integer
          title: Quote Count
          description: Quote count
          default: 0
        view_count:
          anyOf:
          - type: string
          - type: 'null'
          title: View Count
          description: View count
        view_count_state:
          anyOf:
          - type: string
          - type: 'null'
          title: View Count State
          description: View count state
        author_user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Author User Id
          description: Author user ID
        author_screen_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Author Screen Name
          description: Author screen name
        author_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Author Name
          description: Author display name
        author_is_blue_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Author Is Blue Verified
          description: Blue verification flag
        author_verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Author Verified
          description: Legacy verification flag
        author_is_verified_organization_affiliate:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Author Is Verified Organization Affiliate
          description: Verified organization affiliate flag
      type: object
      required:
      - tweet_id
      title: UserTweetItem
    UserTimelineResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code
          default: 200
        msg:
          type: string
          title: Msg
          description: Response message
          default: success
        data:
          items:
            $ref: '#/components/schemas/UserTweetItem'
          type: array
          title: Data
          description: All fetched tweets.
        total_fetched_count:
          type: integer
          title: Total Fetched Count
          description: Total number of tweets fetched across pages.
        page_count:
          type: integer
          title: Page Count
          description: Number of pages fetched.
      type: object
      required:
      - data
      - total_fetched_count
      - page_count
      title: UserTimelineResponse
    UserTimelinePageQuery_2:
      properties:
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
          description: Cursor returned by the previous page. Leave empty to fetch the first page.
          examples:
          - DAAHCgABHFeD5h9__-cLAAIAAAATMjAzODIzMzA5NTM4ODY4MDU5NAgAAwAAAAIAAA
        count:
          type: integer
          maximum: 100
          minimum: 1
          title: Count
          description: Maximum number of tweets to return for this page.
          default: 20
          examples:
          - 20
      type: object
      title: UserTimelinePageQuery
    UserTimelineFillQuery:
      properties:
        count:
          type: integer
          maximum: 1000
          minimum: 1
          title: Count
          description: Maximum number of tweets to return across all pages.
          default: 20
          examples:
          - 20
      type: object
      title: UserTimelineFillQuery
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: TwexAPI developer documentation
  url: https://docs.twexapi.io
x-refined-from:
- twexapi-io-docs-openapi.json
- twexapi-io-openapi.json