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

# Read a scrape

> Read a scrape again by its id. Results are kept for 24 hours. Send one request and get JSON back. Examples in cURL, TypeScript and Python.

## Price

Free.

See [Pricing](https://docs.stophy.dev/account/pricing.md).

```bash cURL theme={null}
curl https://api.stophy.dev/v1/scrape/ac28ed59-d0d8-4639-92e1-e1b0db5e9abb \
  -H "Authorization: Bearer $STOPHY_API_KEY"
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/scrape/ac28ed59-d0d8-4639-92e1-e1b0db5e9abb", {
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
  },
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.get(
    "https://api.stophy.dev/v1/scrape/ac28ed59-d0d8-4639-92e1-e1b0db5e9abb",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
)
print(response.json())
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "markdown": "# bunfig.toml\n\n> Configure Bun's behavior using its configuration file bunfig.toml\n\n`bunfig.toml` is Bun's…",
    "metadata": {
      "proxyUsed": "basic",
      "title": "bunfig.toml",
      "sourceURL": "https://bun.com/docs/runtime/bunfig",
      "url": "https://bun.com/docs/runtime/bunfig",
      "statusCode": 200,
      "contentType": "text/markdown",
      "cacheState": "hit",
      "cachedAt": "2026-11-16T09:58:50.588Z",
      "scrapeId": "ac28ed59-d0d8-4639-92e1-e1b0db5e9abb",
      "creditsUsed": 1,
      "costUsd": 0.001
    }
  },
  "id": "ac28ed59-d0d8-4639-92e1-e1b0db5e9abb",
  "costUsd": 0.001,
  "creditsUsed": 1,
  "requestId": "ac28ed59-d0d8-4639-92e1-e1b0db5e9abb"
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/scrape/{id}
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Each operation shows its method and its input: a JSON object body, path and
    query parameters, or a file upload.


    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-cost-usd is what one call costs, in dollars. Every call costs the same,
    whatever it returns, unless an operation's description says it costs per 10
    results, or per hour of audio. Then x-cost-usd is the lowest price and
    x-cost-usd-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/scrape/{id}:
    get:
      summary: Read a scrape again by its id. Results are kept for 24 hours.
      description: Free. The id is the scrapeId a scrape returned.
      operationId: scrapeResult
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The scrape's answer.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            x-cost-usd:
              $ref: '#/components/headers/CostUsd'
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      markdown:
                        type: string
                      summary:
                        type: string
                      html:
                        type: string
                      rawHtml:
                        type: string
                      links:
                        type: array
                        items:
                          type: string
                      images:
                        type: array
                        items:
                          type: string
                      attributes:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            selector:
                              type: string
                            attribute:
                              type: string
                            values:
                              type: array
                              items:
                                type: string
                          required: []
                      screenshot:
                        type: string
                      json:
                        $ref: '#/components/schemas/scrape.schema0'
                      highlights:
                        type: string
                      nextOffset:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      changeTracking:
                        type: object
                        additionalProperties: false
                        properties:
                          previousScrapeAt:
                            type: string
                          changeStatus:
                            type: string
                            enum:
                              - new
                              - same
                              - changed
                          visibility:
                            type: string
                          diff:
                            type: string
                        required: []
                      branding:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties:
                          $ref: '#/components/schemas/scrape.schema0'
                      actions:
                        type: object
                        additionalProperties: false
                        properties:
                          screenshots:
                            type: array
                            items:
                              type: string
                          scrapes:
                            type: array
                            items:
                              type: object
                              additionalProperties: false
                              properties:
                                url:
                                  type: string
                                html:
                                  type: string
                              required: []
                          javascriptReturns:
                            type: array
                            items:
                              type: object
                              additionalProperties: false
                              properties:
                                type:
                                  type: string
                                value:
                                  $ref: '#/components/schemas/scrape.schema0'
                              required: []
                          pdfs:
                            type: array
                            items:
                              type: string
                        required: []
                      warning:
                        type: string
                      metadata:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Facts about the page. Named page facts such as ogTitle
                          or keywords appear when the page has them, and every
                          meta tag also appears under its own name, such as
                          og:title.
                        properties:
                          title:
                            type: string
                          description:
                            type: string
                          language:
                            type: string
                          ogImage:
                            type: string
                          sourceURL:
                            type: string
                          url:
                            type: string
                          statusCode:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          contentType:
                            type: string
                          numPages:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          totalPages:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          cacheState:
                            type: string
                            enum:
                              - hit
                              - miss
                              - stale
                          cachedAt:
                            type: string
                          scrapeId:
                            type: string
                          creditsUsed:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          costUsd:
                            type: number
                        required:
                          - statusCode
                    required:
                      - metadata
                  creditsUsed:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  costUsd:
                    type: number
                  requestId:
                    type: string
                required:
                  - success
                  - data
                  - creditsUsed
                  - costUsd
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: >-
        Older header: what this call cost, as whole steps of $0.002. Use
        x-cost-usd.
      schema:
        type: integer
    CostUsd:
      description: What this call cost, in dollars.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  schemas:
    scrape.schema0:
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/scrape.schema0'
        - type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/scrape.schema0'
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: What went wrong and what to do next.
        code:
          type: string
          enum:
            - apiKeyRequired
            - busy
            - checkRunning
            - cliSessionCompleted
            - cliSessionExists
            - cliSessionNotFound
            - forbidden
            - freeLimit
            - insufficientCredits
            - internalError
            - inviteClaimed
            - inviteDisabled
            - inviteExpired
            - inviteUsedUp
            - invalidCliSession
            - invalidCliVerifier
            - invalidRequest
            - jobFinished
            - methodNotAllowed
            - notFound
            - payloadTooLarge
            - profileBusy
            - profileTooLarge
            - prohibitedPermission
            - promptInjectionDetected
            - rateLimited
            - sourceChanged
            - sourceRefused
            - siteNotRead
            - sourceTimeout
            - sourceUnavailable
            - unauthorized
            - unsupportedMediaType
        retryable:
          type: boolean
          description: true when trying again can help.
        retryAfterSeconds:
          type: integer
        requestId:
          type: string
        requiredCredits:
          type: number
          description: >-
            Older field: the most the call can cost, in $0.002 steps. Sent when
            the balance is too low.
        availableCredits:
          type: number
          description: 'Older field: the balance in $0.002 steps. Sent with requiredCredits.'
        requiredUsd:
          type: number
          description: >-
            The most the call can cost, in dollars. Sent when the balance is too
            low.
        availableUsd:
          type: number
          description: What is left on the account, in dollars. Sent with requiredUsd.
        billingUrl:
          type: string
          description: Where to add money. Sent with requiredUsd.
        signupUrl:
          type: string
          const: https://stophy.dev/signup
          description: >-
            Where a person gets a key. Sent with apiKeyRequired, freeLimit and
            an invalid key.
        signup:
          type: string
          const: POST https://api.stophy.dev/v1/signup
          description: >-
            The call that gets an agent a key with no human. Sent next to
            signupUrl.
  responses:
    Error:
      description: The request failed. Retry-After says when 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'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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