The response envelope

The envelope, field by field

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.0015, 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.

get/api/v1/scrape/{platform}/{action}

Request

  • Base URL: https://hproxy.com
  • URL: https://hproxy.com/api/v1/scrape/{platform}/{action}
  • Auth: API key in header X-API-Key

Path parameters

platformstring required
actionstring required

Query parameters

scraperstring

Internal scraper id the path resolved to.

inputobject

Echo of the inputs the run used.

dataobject

The scraped payload, exactly as structured by the platform.

recordsinteger

Result count heuristic (longest array in data). Informational only: billing is per call, never per record.

costUsdnumber

The call's exact price in USD. 0 on an idempotent replay.

walletDebitUsdnumber

Whole cents actually settled from the wallet on this call.

idempotentReplayboolean

Present and true when X-Request-Id matched a previous run and its result was replayed free.

requestIdstring

The run id. Quote it in support tickets.

elapsedMsinteger

Server-side duration of the call.

Response

Success

object required

Changes

No recorded changes to this operation across all 1 revision of this API.