Getting Started

Everything you need to start using the ProxyHat API to manage residential proxies programmatically.

Base URL

All API requests are made to:

https://api.proxyhat.com/v1

Quick Start

Make your first API call in three steps:

1. Get Your API Key

Create an API key in your dashboard API settings, or create one programmatically after logging in via the API.

2. Make a Request

Include your API key as a Bearer token in the Authorization header:

curl https://api.proxyhat.com/v1/auth/user \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

3. Handle the Response

All responses use a consistent JSON envelope:

{
  "success": true,
  "payload": { ... },
  "meta": { ... },
  "errors": [],
  "description": ""
}

Explore the API

Rate Limiting

API requests are rate-limited to 60 requests per minute per user. Rate limit headers are included in every response:

Content Type

All requests should include the following headers:

Accept: application/json
Content-Type: application/json

Request bodies must be valid JSON for POST and PUT requests.