Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

Endpoint

http://127.0.0.1:8000/

All requests go to the root endpoint. The target URL and options are specified via headers.

Request Headers

Required Headers

X-Url

The target URL to request.

X-Url: https://example.com/api/data

Optional Headers

X-Profile

Browser profile to emulate. Default: chrome

X-Profile: chrome|safari|edge|firefox|okhttp|custom|http11

X-Proxy

Proxy server URL with optional authentication.

X-Proxy: http://proxy.example.com:8080
X-Proxy: http://user:[email protected]:8080
X-Proxy: socks5://user:[email protected]:1080

X-Timeout

Request timeout in seconds. Default: 30

X-Timeout: 60

X-Redirect

Maximum number of redirects to follow. Default: 10

X-Redirect: 5

X-Shuffle

Shuffle request headers. Default: false

X-Shuffle: true

Request Methods

All standard HTTP methods are supported:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • HEAD
  • OPTIONS

Request Body

Pass request body as you would with any HTTP client. Supports:

  • JSON
  • Form data
  • Plain text
  • Binary data

Examples

Basic GET Request

curl -X GET "http://localhost:8000/" \
     -H "X-Url: https://api.example.com/users"

POST with JSON

curl -X POST "http://localhost:8000/" \
     -H "X-Url: https://api.example.com/users" \
     -H "Content-Type: application/json" \
     -d '{"name": "John Doe"}'

Using Proxy

curl -X GET "http://localhost:8000/" \
     -H "X-Url: https://example.com" \
     -H "X-Proxy: socks5://user:[email protected]:1080" \
     -H "X-Profile: firefox"

Custom Headers

curl -X GET "http://localhost:8000/" \
     -H "X-Url: https://api.example.com/data" \
     -H "Authorization: Bearer token123" \
     -H "X-Custom-Header: value"

Response

The response from the target server is returned as-is, including:

  • Status code
  • Headers
  • Body
  • Cookies

Error Handling

Errors are returned with appropriate HTTP status codes:

  • 400: Bad request (missing X-Url header)
  • 500: Internal server error
  • 502: Bad gateway (target server error)