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

# Fetch a web page with X402 payment

> X402 payment endpoint. First request returns 402 with payment requirements. Retry with PAYMENT-SIGNATURE header containing cryptographic proof to get the actual data. See https://x402.gitbook.io/x402 for protocol details.



## OpenAPI

````yaml /openapi.json POST /x402/web/fetch
openapi: 3.0.1
info:
  title: Hyperbrowser API
  version: 1.0.0
servers:
  - url: https://api.hyperbrowser.ai
    description: Production server
security: []
paths:
  /x402/web/fetch:
    post:
      summary: Fetch a web page with X402 payment
      description: >-
        X402 payment endpoint. First request returns 402 with payment
        requirements. Retry with PAYMENT-SIGNATURE header containing
        cryptographic proof to get the actual data. See
        https://x402.gitbook.io/x402 for protocol details.
      parameters:
        - name: PAYMENT-SIGNATURE
          in: header
          required: false
          description: >-
            Base64-encoded JSON containing payment proof (x402Version, resource,
            accepted payment method, and cryptographic payload with signature
            and payer address)
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchParams'
      responses:
        '200':
          description: Page fetched successfully (after valid payment)
          headers:
            PAYMENT-RESPONSE:
              description: Base64-encoded JSON with settlement information
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: >-
            Payment Required - returned on first request without
            PAYMENT-SIGNATURE header
          headers:
            PAYMENT-REQUIRED:
              description: >-
                Base64-encoded JSON containing X402 payment requirements
                (x402Version, resource info, and array of accepted payment
                methods with network, asset, amount, payTo address, and timeout)
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    FetchParams:
      type: object
      properties:
        url:
          type: string
        stealth:
          $ref: '#/components/schemas/FetchStealthMode'
        outputs:
          $ref: '#/components/schemas/FetchOutputOptions'
        browser:
          $ref: '#/components/schemas/FetchBrowserOptions'
        navigation:
          $ref: '#/components/schemas/FetchNavigationOptions'
        cache:
          $ref: '#/components/schemas/FetchCacheOptions'
      required:
        - url
    FetchResponse:
      type: object
      properties:
        jobId:
          type: string
        status:
          $ref: '#/components/schemas/FetchStatus'
        error:
          type: string
          nullable: true
        data:
          $ref: '#/components/schemas/FetchResponseData'
      required:
        - jobId
        - status
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
    FetchStealthMode:
      type: string
      enum:
        - none
        - auto
        - ultra
    FetchOutputOptions:
      type: object
      properties:
        formats:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/FetchOutputMarkdown'
              - $ref: '#/components/schemas/FetchOutputHtml'
              - $ref: '#/components/schemas/FetchOutputLinks'
              - $ref: '#/components/schemas/FetchOutputScreenshot'
              - $ref: '#/components/schemas/FetchOutputJson'
              - $ref: '#/components/schemas/FetchOutputBranding'
              - type: string
                enum:
                  - markdown
                  - html
                  - links
                  - screenshot
                  - branding
        sanitize:
          $ref: '#/components/schemas/FetchSanitizeMode'
        includeSelectors:
          type: array
          items:
            type: string
        excludeSelectors:
          type: array
          items:
            type: string
        storageState:
          $ref: '#/components/schemas/FetchStorageStateOptions'
    FetchBrowserOptions:
      type: object
      properties:
        screen:
          $ref: '#/components/schemas/ScreenConfig'
        profileId:
          type: string
        solveCaptchas:
          type: string
        location:
          $ref: '#/components/schemas/FetchBrowserLocationOptions'
    FetchNavigationOptions:
      type: object
      properties:
        waitUntil:
          $ref: '#/components/schemas/FetchWaitUntil'
        timeoutMs:
          type: integer
        waitFor:
          type: integer
    FetchCacheOptions:
      type: object
      properties:
        maxAgeSeconds:
          type: integer
    FetchStatus:
      type: string
      enum:
        - completed
        - failed
        - pending
        - running
    FetchResponseData:
      type: object
      properties:
        metadata:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
        html:
          type: string
        markdown:
          type: string
        links:
          type: array
          items:
            type: string
        screenshot:
          type: string
        json:
          type: object
        branding:
          $ref: '#/components/schemas/BrandingProfile'
    FetchOutputMarkdown:
      type: object
      properties:
        type:
          type: string
          enum:
            - markdown
      required:
        - type
    FetchOutputHtml:
      type: object
      properties:
        type:
          type: string
          enum:
            - html
      required:
        - type
    FetchOutputLinks:
      type: object
      properties:
        type:
          type: string
          enum:
            - links
      required:
        - type
    FetchOutputScreenshot:
      allOf:
        - $ref: '#/components/schemas/FetchOutputScreenshotOptions'
        - type: object
          properties:
            type:
              type: string
              enum:
                - screenshot
          required:
            - type
    FetchOutputJson:
      allOf:
        - $ref: '#/components/schemas/FetchOutputJsonOptions'
        - type: object
          properties:
            type:
              type: string
              enum:
                - json
          required:
            - type
    FetchOutputBranding:
      type: object
      properties:
        type:
          type: string
          enum:
            - branding
      required:
        - type
    FetchSanitizeMode:
      type: string
      enum:
        - none
        - basic
        - advanced
    FetchStorageStateOptions:
      type: object
      properties:
        localStorage:
          type: object
          additionalProperties:
            type: string
        sessionStorage:
          type: object
          additionalProperties:
            type: string
    ScreenConfig:
      type: object
      properties:
        width:
          type: number
          default: 1280
        height:
          type: number
          default: 720
    FetchBrowserLocationOptions:
      type: object
      properties:
        country:
          type: string
        state:
          type: string
        city:
          type: string
    FetchWaitUntil:
      type: string
      enum:
        - load
        - domcontentloaded
        - networkidle
    BrandingProfile:
      type: object
      description: >-
        Visual brand profile extracted via DOM analysis + LLM enhancement. All
        fields optional; the server may return a partial profile when the LLM
        refuses or fails.
      properties:
        colorScheme:
          type: string
          description: 'Page color scheme. Common values: light, dark.'
        colors:
          type: object
          description: >-
            Color role assignments. Common keys: primary, secondary, accent,
            background, textPrimary, textSecondary, link.
        fonts:
          type: array
          description: Cleaned brand fonts with roles.
          items:
            type: object
            properties:
              family:
                type: string
              role:
                type: string
        typography:
          type: object
          description: >-
            Font families, stacks, and sizes. Keys: fontFamilies, fontStacks,
            fontSizes, lineHeights, fontWeights.
        spacing:
          type: object
          description: >-
            Spacing scale. Common keys: baseUnit, borderRadius, padding,
            margins, gridGutter.
        components:
          type: object
          description: >-
            Per-component style dictionaries. Common keys: buttonPrimary,
            buttonSecondary, input. Each value has background, textColor,
            borderColor, borderRadius, borderRadiusCorners, shadow.
        images:
          type: object
          description: >-
            Brand images. Common keys: logo, logoHref, logoAlt, favicon,
            ogImage.
        personality:
          type: object
          description: 'Brand personality. Common keys: tone, energy, targetAudience.'
        designSystem:
          type: object
          description: 'Detected design system. Common keys: framework, componentLibrary.'
        confidence:
          type: object
          description: 'Confidence scores (0-1). Common keys: buttons, colors, overall.'
    FetchOutputScreenshotOptions:
      type: object
      properties:
        fullPage:
          type: boolean
        format:
          $ref: '#/components/schemas/FetchScreenshotFormat'
        cropToContent:
          type: boolean
        cropToContentMaxHeight:
          type: integer
        cropToContentMinHeight:
          type: integer
    FetchOutputJsonOptions:
      type: object
      properties:
        schema:
          type: object
        prompt:
          type: string
          description: >-
            Natural language prompt describing what data to extract. If only
            prompt is provided, a schema is auto-generated from it. If both
            prompt and schema are provided, the schema defines the output
            structure while the prompt provides additional guidance for the
            extraction.
    FetchScreenshotFormat:
      type: string
      enum:
        - jpeg
        - png
        - webp

````