Quickstart

Three steps to your first HProxy API call: create a key, verify it, then run a scraper or price a proxy plan.

Three steps from zero to a working call.

1
Create a key
In your dashboard under Settings → API keys. The full key (prefixed hpx_) is shown once at creation, so store it somewhere safe.
2
Verify it
GET /me accepts any valid key and echoes the account it acts for, the fastest way to confirm everything is wired up.
3
Make your first real call
Run a scraper, or price a proxy product before buying it. Both examples below work as-is once you paste your key.

Verify your key

GET /me

curl https://hproxy.com/api/v1/me -H "X-API-Key: hpx_your_key_here"

Response

{
  "userId": "usr_1a2b3c",
  "email": "[email protected]",
  "scopes": ["buy", "scrape"],
  "dailySpendCapCents": null
}

Your first real call

curl "https://hproxy.com/api/v1/scrape/threads/search?query=coffee" \
  -H "X-API-Key: hpx_your_key_here"

Scraper calls are billed per successful call at the exact listed price, most social endpoints are $0.003 per call, with no per-call minimum. Failed calls are never charged.

Authentication→

How keys, scopes and the spend cap work.

Proxy API→

Products, quotes, orders and plans.

Scraper API→

Endpoints, billing and the envelope.

← Previous

Introduction

Authentication

Need a hand wiring this up? Email [email protected]. A real person reads every message.