> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# X X Profile Posts API

> Scrape an X profile's posts. Call the X X Profile Posts API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.

Scrape an X profile's posts. The profile or user is identified by its URL or username.

## Request

Exactly one of `profileUrl` or `username` is required. A request that sets both, or none, fails with `invalidRequest`.

<CodeGroup>
  ```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.x.profile.posts({ username: "nasa" });
  console.log(result.data.results);
  ```

  ```python Python icon="python" theme={null} theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.x.profile.posts(username="nasa")
  print(result["data"]["results"])
  ```

  ```bash cURL icon="terminal" theme={null} theme={null}
  curl -X POST https://api.stophy.dev/v1/x/profile/posts \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"username":"nasa"}'
  ```

  ```bash CLI icon="square-terminal" theme={null} theme={null}
  stophy x profile posts --username nasa
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data.results[]` contains the account's posts, each with its text, time, likes, replies and reposts.

The following example is a real response, truncated: each list shows one item and long strings are cut.

```json theme={null}
{
  "success": true,
  "data": {
    "order": "newest",
    "results": [
      {
        "postId": "2111180963661435219",
        "postUrl": "https://x.com/NASA/status/2111180963661435219",
        "text": "The aircraft lineup just keeps getting bigger. ✈️\n\nMAX POWER, a new aerospace expo, is set for Nov. 7-8 @NASAKennedy —…",
        "publishedAt": "2026-10-16T19:42:20.000Z",
        "language": "en",
        "likes": 1540,
        "replies": 145,
        "reposts": 211,
        "quotes": 24,
        "bookmarks": 62,
        "views": 359353,
        "authorId": "11348282",
        "authorUsername": "NASA",
        "authorName": "NASA",
        "authorUrl": "https://x.com/NASA",
        "authorAvatarUrl": "https://pbs.twimg.com/profile_images/1321163587679784960/0ZxKlEKB_400x400.jpg",
        "authorIsVerified": true,
        "media": [
          {
            "type": "video",
            "url": "https://video.twimg.com/amplify_video/2111180787802370048/vid/avc1/1080x1920/xLb-yr9GVdddx5sY.mp4?tag=29",
            "thumbnailUrl": "https://pbs.twimg.com/amplify_video_thumb/2111180787802370048/img/0nbyTdS0MRg5JqXk.jpg",
            "width": 1080,
            "height": 1920,
            "durationSeconds": 17.751
          }
        ],
        "links": ["https://www.nasa.gov/maxpower/"],
        "mentions": ["NASAKennedy"],
        "isEdited": false,
        "isSensitive": false,
        "isPinned": false,
        "isRepost": false
      }
    ],
    "cursor": "NDk5Mcxn11348282.DAAHCgABHU8DUlr__-wLAAIAAAATMjEwOTMyMDYyMjg4Mjg3MzQ2NAgAAwAAAAIAAA"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `cursor` | string | The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page. |
| `publishedAt` | string (ISO 8601) | The publication time, in UTC. |
| `likes` | integer | The number of likes. |

For every field, see the response schema on this page.

<Note>Newest first, about 20 a page, with a pinned post on top of the first page. A repost comes back as the original post with isRepost set. For some profiles X shows about 100 popular posts in one page instead, and order says popular.</Note>

## Optional parameters

| Parameter | Type | Description |
| - | - | - |
| `cursor` | string | The pagination token from the previous response. |

## Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

## Pagination

Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page.

## Related methods

* [X X Profile](/api-reference/endpoint/x-profile): Accepts `username`. Scrape an X profile.
* [X X Post](/api-reference/endpoint/x-post): Accepts `postUrl`. Scrape an X post.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/x/profile/posts
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/x/profile/posts:
    post:
      summary: Scrape an X profile's posts
      description: Costs 1 credit per call. Pages with cursor.
      operationId: xProfilePosts
      parameters:
        - $ref: '#/components/parameters/MaxTextLength'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                profileUrl:
                  type: string
                  description: >-
                    Link to the X profile, like https://x.com/nasa. Send this or
                    username.
                username:
                  type: string
                  description: X profile handle, like nasa. Send this or profileUrl.
                cursor:
                  type: string
                  minLength: 1
                  description: The cursor from the previous response. Send it as is.
              sendOne:
                - profileUrl
                - username
              additionalProperties: false
            example:
              username: nasa
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      order:
                        type: string
                        enum:
                          - newest
                          - popular
                        description: >-
                          newest is the profile's posts, newest first, paged
                          with cursor. popular is the set of popular posts X
                          shows for some profiles instead, all in one page.
                      results:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            postId:
                              type: string
                            postUrl:
                              type: string
                              format: uri
                            text:
                              type: string
                            publishedAt:
                              type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                            language:
                              type: string
                            likes:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            replies:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            reposts:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            quotes:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            bookmarks:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            views:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            authorId:
                              type: string
                            authorUsername:
                              type: string
                            authorName:
                              type: string
                            authorUrl:
                              type: string
                              format: uri
                            authorAvatarUrl:
                              type: string
                              format: uri
                            authorIsVerified:
                              type: boolean
                            media:
                              type: array
                              items:
                                type: object
                                additionalProperties: false
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - photo
                                      - video
                                      - gif
                                  url:
                                    type: string
                                    format: uri
                                  thumbnailUrl:
                                    type: string
                                    format: uri
                                  width:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  height:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  durationSeconds:
                                    type: number
                                  altText:
                                    type: string
                                required:
                                  - type
                                  - url
                            links:
                              type: array
                              items:
                                type: string
                                format: uri
                            hashtags:
                              type: array
                              items:
                                type: string
                            mentions:
                              type: array
                              items:
                                type: string
                            replyToUrl:
                              type: string
                              format: uri
                            quotedUrl:
                              type: string
                              format: uri
                            quotedText:
                              type: string
                            quotedAuthorUsername:
                              type: string
                            isEdited:
                              type: boolean
                            isSensitive:
                              type: boolean
                            isPinned:
                              type: boolean
                            isRepost:
                              type: boolean
                          required:
                            - postUrl
                            - isEdited
                            - isSensitive
                            - isPinned
                            - isRepost
                      cursor:
                        type: string
                    required:
                      - results
                      - order
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  parameters:
    MaxTextLength:
      name: maxTextLength
      in: query
      required: false
      description: >-
        Cut every text value in the response to this many characters. A value
        that was cut ends with …, and a page whose text was cut has isTruncated
        set to true. A screenshot is never cut. Leave it out to get the full
        text.
      schema:
        type: integer
        minimum: 1
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - inviteClaimed
                - inviteDisabled
                - inviteExpired
                - inviteUsedUp
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
            requiredCredits:
              type: number
            availableCredits:
              type: number
            billingUrl:
              type: string
              const: https://stophy.dev/billing
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.