Skip to main content
POST
/
orders
Create order
curl --request POST \
  --url https://api.proxyjam.com/public/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "offer_id": 123,
  "payment_method": "<string>",
  "proxy_type": "<string>",
  "ip_version": "<string>",
  "protocol": "<string>",
  "country": "<string>",
  "city": "<string>",
  "isp": "<string>",
  "quantity": 123,
  "period_days": 123,
  "tarification_index": 123,
  "bandwidth_gb": 123,
  "auto_renew": true,
  "notes": "<string>",
  "idempotency_key": "<string>"
}
'
{
  "id": "<string>",
  "status": "<string>",
  "total_usd": 123,
  "payment_info": {
    "payment_method": "<string>",
    "payment_intent_id": "<string>",
    "payment_url": "<string>"
  },
  "proxy_access": [
    {
      "id": "<string>",
      "host": "<string>",
      "port": 123,
      "username": "<string>",
      "password": "<string>",
      "protocol": "<string>",
      "status": "<string>",
      "expires_at": "<string>",
      "whitelisted_ips": [
        {}
      ],
      "bandwidth_total_gb": 123,
      "bandwidth_used_gb": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.proxyjam.com/llms.txt

Use this file to discover all available pages before exploring further.

Places a new proxy order. The proxies are provisioned immediately after a successful payment. Use "payment_method": "wallet" to deduct from your wallet balance instantly, or "payment_method": "cryptocloud" to pay with crypto and receive a redirect URL.
Send an idempotency_key to make this request safe to retry. See Idempotency.

​
Request body

​
offer_id
integer
required
ID of the proxy offer from the catalog.
​
payment_method
string
required
wallet or cryptocloud.
​
proxy_type
string
default:"residential"
Proxy type: datacenter, residential, or mobile.
​
ip_version
string
default:"IPv4"
IPv4 or IPv6.
​
protocol
string
default:"HTTP"
HTTP, HTTPS, or SOCKS5.
​
country
string
default:"US"
ISO 3166-1 alpha-2 country code.
​
city
string
Optional city for geo-targeting.
​
isp
string
Optional ISP filter.
​
quantity
integer
default:"1"
Number of proxies.
​
period_days
integer
default:"30"
Rental period in days. For offers that require a tarification_index, must match the chosen option’s period_days exactly.
​
tarification_index
integer
Index into the offer’s options array. Required for mobile rotating offers, which sell only pre-registered tariff triples; pass the index of the option the user picked. Ignored for other offers and rejected with 422 if supplied for them.
​
bandwidth_gb
integer
Optional traffic limit in GB. Leave unset for unlimited (where supported).
​
auto_renew
boolean
default:"false"
Automatically renew when the period ends.
​
notes
string
Optional private notes for your reference.
​
idempotency_key
string
UUID for idempotent request handling.

​
Response

​
id
string
Order UUID.
​
status
string
Order status. One of: pending, pending_payment, active, failed, cancelled, expired.
​
total_usd
number
Total charged in USD.
​
payment_info
object
​
proxy_access
array
Populated once the order is active. Each item:

​
Example — wallet payment

curl -X POST https://api.proxyjam.com/public/v1/orders \
  -H "X-API-Key: pj_AbCdEf..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -d '{
    "offer_id": 42,
    "payment_method": "wallet",
    "proxy_type": "residential",
    "ip_version": "IPv4",
    "protocol": "HTTP",
    "country": "US",
    "quantity": 2,
    "period_days": 30
  }'