Browse offers and locations

GET

/v1/catalog

curl --request GET \
  --url https://api.trueproxies.com/v1/catalog

Public price list. No API key required. Check each service’s capabilities before using targeting options.

Parameters

Query Parameters

customer_id

string format: uuid

Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes.

Responses

200

Ok

Media typeapplication/json

object

cities

required

Array<object>

object

available

required

The city can take a new Datacenter IPv6 service now

boolean

code

required

string

country_code

required

string

name

required

string

hosts

required

Public proxy hostnames per product

object

key

additional properties

string

offers

required

Array<object>

object

allowance_bytes

integer format: int64

capabilities

required

Array<string>

currency

required

string

Allowed values: USD

display_name

required

string

duration_seconds

Trial offers only. How long the trial serves once its first request arrives.

integer format: int64

>= 1

enabled

required

boolean

floor_price_cents

Always 0 here. The floor is the reseller wholesale limit, an internal pricing control that the public catalog does not disclose. Staff read the real value from the admin catalog.

integer

offer_key

required

string

pool

The ISPPool key an isp_dedicated offer sells; absent for every other product.

string | null

price_cents

required

integer

product

required

string

Allowed values: residential_ipv4_gb residential_ipv4_unlimited datacenter_ipv6 trial residential_ipv6 isp_dedicated residential_ipv4_premium residential_ipv4_lite residential_ipv4_unlimited_pro

speed_bps

0 for paid residential_ipv4_gb means no additional TrueProxies speed cap. residential_ipv4_unlimited retains its positive plan speed. Upstream capacity and availability still apply. Trials and datacenter plans retain their speed limits.

integer format: int64

term

string

Allowed values: hour day week month

payment_minimums

The least one checkout on each listed rail charges, in cents ($10 by card, $3 by crypto); a smaller order is charged this and the rest goes to the wallet

object

key

additional properties

integer format: int64

payment_providers

Available payment providers in the dashboard.

Array<string>

pools

The carriers an operator has enabled for isp_dedicated, with their stock

Array<object>

A carrier sold as isp_dedicated, a country and the provider its IPs are registered to.

object

carrier

required

string

country

required

string

in_stock

required

boolean

key

required

string

terms

required

Array<string>

Allowed values: day week month

residential_ipv6_plan

The payer’s Residential IPv6 prices, listed only for a buyer with access; a plan costs its speed plus its open connections for the term

object

connections

required

Open-connection counts sold and each one’s price per term; a term is absent where that count is not sold for it

Array<object>

object

cents

required

object

key

additional properties

integer format: int64

value

required

integer

speeds

required

Plan speeds sold at checkout (value in Mbps) and each one’s price per term

Array<object>

object

cents

required

object

key

additional properties

integer format: int64

value

required

integer

trial_available

The operator trial switch; false means the trial offer is listed but cannot be claimed

boolean

trial_product

The Unlimited product a free trial claimed now starts as; absent while trial_available is false

string

Allowed values: residential_ipv4_unlimited residential_ipv4_unlimited_pro

Example

{
  "offers": [
    {
      "currency": "USD",
      "product": "residential_ipv4_gb",
      "term": "hour"
    }
  ],
  "pools": [
    {
      "terms": [
        "day"
      ]
    }
  ],
  "trial_product": "residential_ipv4_unlimited"
}

400

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

401

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

403

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

404

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

409

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

429

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

500

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}

503

Error

Media typeapplication/json

object

code

required

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL

details

What a client needs to act on the error (ids, flags), never display text.

object

key

additional properties

any

message

required

string

Example

{
  "code": "BAD_REQUEST"
}