HProxy The response envelope API

openapi: 3.2.0
info:
  title: HProxy The response envelope API
  version: 1.0.0
  description: 'Buy and manage proxies from a prepaid wallet, run the Scraper API, or use the free no-key APIs: a live proxy list, a proxy checker and an IP lookup. JSON in, JSON out. Money is always integer cents (120 = $1.20), never floats.'
  contact:
    url: https://hproxy.com/contact
  license:
    name: Proprietary
servers:
- url: https://hproxy.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: The response envelope
paths:
  /api/v1/scrape/{platform}/{action}:
    get:
      operationId: scrapers-envelope
      summary: The envelope, field by field
      description: 'Every scraper call returns the same stable envelope. `data` is the platform''s structured payload; everything else is bookkeeping. `costUsd` is the call''s exact price (for a $0.00149 scraper it reads `0.00149`, there is no minimum). `walletDebitUsd` is what actually left your wallet on **this** call: fractional costs accrue on a running tab and settle in whole cents, so it reads `0` on most calls and `0.01` as the tab crosses each cent. Summing either field over many calls converges on the same total.'
      tags:
      - The response envelope
      parameters:
      - name: platform
        in: path
        required: true
        schema:
          type: string
      - name: action
        in: path
        required: true
        schema:
          type: string
      - name: scraper
        in: query
        required: false
        description: Internal scraper id the path resolved to.
        schema:
          type: string
      - name: input
        in: query
        required: false
        description: Echo of the inputs the run used.
        schema:
          type: object
      - name: data
        in: query
        required: false
        description: The scraped payload, exactly as structured by the platform.
        schema:
          type: object
      - name: records
        in: query
        required: false
        description: 'Result count heuristic (longest array in data). Informational only: billing is per call, never per record.'
        schema:
          type: integer
      - name: costUsd
        in: query
        required: false
        description: The call's exact price in USD. 0 on an idempotent replay.
        schema:
          type: number
      - name: walletDebitUsd
        in: query
        required: false
        description: Whole cents actually settled from the wallet on this call.
        schema:
          type: number
      - name: idempotentReplay
        in: query
        required: false
        description: Present and true when X-Request-Id matched a previous run and its result was replayed free.
        schema:
          type: boolean
      - name: requestId
        in: query
        required: false
        description: The run id. Quote it in support tickets.
        schema:
          type: string
      - name: elapsedMs
        in: query
        required: false
        description: Server-side duration of the call.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              example:
                error: Invalid input.
                details: '''trim'' must be a boolean'
                requestId: null
        '400':
          description: Invalid input. The body names the field and the accepted set.
        '401':
          description: Missing or invalid API key.
        '429':
          description: Rate limited. Retry after the delay in the response.
      security:
      - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key. Free keyless endpoints ignore it.
x-endpoint-count: 163
x-generated-from: https://hproxy.com/docs
x-llms: https://hproxy.com/llms-full.txt