API Documentation

Base URL: https://jetproxy.online/api/v1

Rate limits: 200/min per IP, 100/min per API key

Authentication

All API requests must include the x-api-key header with your API key. You can obtain the key in the API section of the dashboard.

Endpoints

Authentication Example

Every request must include the x-api-key header.

Example

curl -H "x-api-key: gpx_live_YOUR_KEY" \
  https://jetproxy.online/api/v1/packages

All keys start with the gpx_live_ prefix
After 5 failed attempts, the IP is blocked for 15 minutes
Rate limits: 200 req/min per IP, 100 req/min per API key

Packages

View active proxy packages and their traffic.

Endpoints

List Packages

Returns all packages of the current user with traffic information.

Response

json

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Residential 50GB",
      "status": "ACTIVE",
      "product_type": "RESIDENTIAL",
      "is_trial": false,
      "proxy_count": 0,
      "traffic_limits": { "common": 53687091200 },
      "expires_at": "2026-04-18T00:00:00.000Z",
      "created_at": "2026-03-18T14:30:00.000Z",
      "traffic": {
        "total_gb": 50,
        "used_gb": 12.45,
        "remaining_gb": 37.55
      }
    }
  ]
}

Proxy Generation

Main endpoint for creating proxy strings with geo-targeting, ASN and sessions.

Endpoints

Generate (Single)

Generates proxies for a single set of geo parameters.

Parameters

Parameter	Type	Default	Description
`package_id`*	string (uuid)	—	Package ID
`preset_name`	string	—	Saved preset name (optional)
`country_code`	string (2 chars)	any	ISO 3166-1 alpha-2 country code
`state`	string	—	Region/state ID (from /geo/states)
`city`	string	—	City name (from /geo/cities)
`isp`	string	—	ISP ID (from /geo/isps)
`asn`	string	—	Autonomous system number
`zip`	string	—	Postal code (works only with country_code)
`session_type`	"rotating" \| "sticky"	"rotating"	Session type
`session_ttl`	string	none	Sticky session TTL (30s, 15m, 1h)
`quantity`	number (1–1000)	10	Number of proxies
`format`	string	"login:password@host:port"	Output format (see below)
`protocol`	"http" \| "socks5"	"http"	Protocol

Request Body

json

{
  "package_id": "550e8400-e29b-41d4-a716-446655440000",
  "country_code": "US",
  "city": "New York",
  "session_type": "sticky",
  "session_ttl": "30s",
  "quantity": 5,
  "protocol": "socks5"
}

Response

json

{
  "count": 5,
  "package_id": "550e8400-e29b-41d4-a716-446655440000",
  "remaining_gb": 37.55,
  "format": "login:password@host:port",
  "protocol": "socks5",
  "proxies": [
    "user_c_US_city_New-York_s_a1b2c3d4:pass@proxy.example.com:10000",
    "user_c_US_city_New-York_s_e5f6g7h8:pass@proxy.example.com:10001",
    "..."
  ]
}

Output formats: protocol://login:password@host:port | host:port:login:password | login:password@host:port
When using preset_name, geo parameters from the preset are used as fallback
Explicitly passed parameters take priority over the preset

Generate (Bulk)

Generates proxies for multiple sets of geo parameters in a single request (up to 10 sets, up to 1000 proxies total).

Parameters

Parameter	Type	Default	Description
`package_id`*	string (uuid)	—	Package ID
`items`*	array (1–10)	—	Array of objects with geo parameters
`format`	string	"login:password@host:port"	Format for all items
`protocol`	"http" \| "socks5"	"http"	Protocol for all items

Request Body

json

{
  "package_id": "550e8400-e29b-41d4-a716-446655440000",
  "items": [
    { "country_code": "US", "quantity": 3 },
    { "country_code": "DE", "city": "Berlin", "quantity": 2 }
  ],
  "protocol": "http"
}

Response

json

{
  "total_count": 5,
  "package_id": "550e8400-...",
  "remaining_gb": 37.55,
  "format": "login:password@host:port",
  "protocol": "http",
  "results": [
    { "country_code": "US", "city": null, "count": 3, "proxies": ["..."] },
    { "country_code": "DE", "city": "Berlin", "count": 2, "proxies": ["..."] }
  ]
}

Total number of proxies across all items must not exceed 1000
Maximum 10 items per request

Geo Data

Reference endpoints for getting available countries, regions, cities and ISPs for targeting.

Endpoints

List Countries

Returns all available countries.

Response

json

{
  "results": [
    { "name": "United States", "code": "US" },
    { "name": "Germany", "code": "DE" },
    { "name": "Japan", "code": "JP" }
  ]
}

List States/Regions

Returns regions/states for the specified country.

Parameters

Parameter	Type	Default	Description
`country_code`*	string (2)	—	Country code

Response

json

{
  "results": [
    { "name": "California", "id": "1906" },
    { "name": "New York", "id": "1930" }
  ]
}

List Cities

Returns cities for the specified region.

Parameters

Parameter	Type	Default	Description
`country_code`*	string (2)	—	Country code
`state`*	string	—	Region ID

Response

json

{
  "results": [
    { "name": "Los Angeles", "id": "18031" },
    { "name": "San Francisco", "id": "18055" }
  ]
}

List ISPs

Returns internet service providers for the selected city.

Parameters

Parameter	Type	Default	Description
`country_code`*	string (2)	—	Country code
`state`*	string	—	Region ID
`city`*	string	—	City ID

Response

json

{
  "results": [
    { "name": "AT&T Services", "id": "7018" },
    { "name": "Comcast Cable", "id": "7922" }
  ]
}

Presets

Saved configurations for quick proxy generation. Can be used by name in /generate.

Endpoints

List Presets

Returns all presets of the current user.

Response

json

{
  "results": [
    {
      "id": "...",
      "name": "US California",
      "country_code": "US",
      "state": "1906",
      "city": "Los Angeles",
      "session_type": "rotating",
      "protocol": "http",
      "last_used_at": "2026-03-19T12:00:00.000Z",
      "created_at": "2026-03-18T10:00:00.000Z"
    }
  ]
}

Create Preset

Creates a new preset with specified geo parameters.

Parameters

Parameter	Type	Default	Description
`name`*	string (1–100)	—	Unique name
`country_code`	string (2)	—	Country code
`state`	string	—	Region ID
`city`	string	—	City
`isp`	string	—	ISP ID
`asn`	string	—	ASN number
`zip`	string	—	Postal code
`session_type`	"rotating" \| "sticky"	"rotating"	Session type
`protocol`	"http" \| "socks5"	—	Protocol

Request Body

json

{
  "name": "US California",
  "country_code": "US",
  "state": "1906",
  "city": "Los Angeles",
  "session_type": "rotating",
  "protocol": "http"
}

Response

json

{
  "id": "...",
  "name": "US California",
  "country_code": "US",
  "state": "1906",
  "city": "Los Angeles",
  "session_type": "rotating",
  "protocol": "http",
  "last_used_at": null,
  "created_at": "2026-03-20T10:00:00.000Z"
}

Delete Preset

Deletes a preset by ID.

Request Body

json

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Response

json

{ "success": true }

Error Codes

All errors are returned in the format { "error": "...", "code": "..." }

HTTP	Code	Description
404	`not_found`	Resource not found (package, preset)
400	`bad_request`	Invalid request parameters
401	`unauthorized`	Invalid or inactive API key
429	`rate_limited`	Rate limit exceeded
402	`package_inactive`	Package is not active
402	`package_expired`	Package has expired
402	`traffic_exhausted`	Traffic exhausted