check_connection

Sends one request through the service from TrueProxies and reports the outcome and exit IP, to tell a proxy problem apart from a website refusing you. It counts as use of the service: it uses a little traffic and starts an unused free trial. Does not measure speed. Limited to a few checks a minute.

Argument	Type	Description
asn	string	ASN digits without the AS prefix, if the service supports ASN targeting
city	string	City in lowercase letters, digits and underscores, if the service supports city targeting
region	string	Region code, if the service supports region targeting
country	string	Two-letter country code, if the service supports country targeting
session	string	Session type. sticky (Sticky) reuses an IP while available, for the session lifetime. rotate (Rotating) requests a new IP per connection, and the same IP can appear again. none uses the service default.
lifetime	integer	Sticky session lifetime in seconds, only with session sticky: 60 to 86400, or from 1 when the service has session_lifetime_seconds, at most 1800 with session_lifetime_30m, and whole minutes on Residential IPv4 Unlimited and Unlimited Pro
protocol	string	http, https or socks5
service_id*	string	Service ID (a UUID) from list_services

Input schema (JSON)

{
  "type": "object",
  "required": [
    "service_id"
  ],
  "properties": {
    "asn": {
      "type": "string",
      "description": "ASN digits without the AS prefix, if the service supports ASN targeting"
    },
    "city": {
      "type": "string",
      "description": "City in lowercase letters, digits and underscores, if the service supports city targeting"
    },
    "region": {
      "type": "string",
      "description": "Region code, if the service supports region targeting"
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code, if the service supports country targeting"
    },
    "session": {
      "enum": [
        "none",
        "sticky",
        "rotate"
      ],
      "type": "string",
      "description": "Session type. sticky (Sticky) reuses an IP while available, for the session lifetime. rotate (Rotating) requests a new IP per connection, and the same IP can appear again. none uses the service default."
    },
    "lifetime": {
      "type": "integer",
      "maximum": 86400,
      "minimum": 1,
      "description": "Sticky session lifetime in seconds, only with session sticky: 60 to 86400, or from 1 when the service has session_lifetime_seconds, at most 1800 with session_lifetime_30m, and whole minutes on Residential IPv4 Unlimited and Unlimited Pro"
    },
    "protocol": {
      "enum": [
        "http",
        "https",
        "socks5"
      ],
      "type": "string",
      "description": "http, https or socks5"
    },
    "service_id": {
      "type": "string",
      "description": "Service ID (a UUID) from list_services"
    }
  },
  "additionalProperties": false
}

generate_endpoints

Builds proxy connection lines for a service with the chosen protocol, format, location targeting and session type: one line, or up to 1,000 sticky sessions with session sticky. Does not change the service. The output contains the proxy username and password, which let anyone who has them use the service.

read-only

Argument	Type	Description
asn	string	ASN digits without the AS prefix, if the service supports ASN targeting
city	string	City in lowercase letters, digits and underscores, if the service supports city targeting
count	integer	With session sticky, how many sticky sessions to return, 1 to 1000. Other session types return one line.
format	string	Line format: host:port:user:pass (default), user:pass@host:port, user:pass, host:port, url or curl
region	string	Region code, if the service supports region targeting
country	string	Two-letter country code, if the service supports country targeting
session	string	Session type. sticky (Sticky) reuses an IP while available, for the session lifetime. rotate (Rotating) requests a new IP per connection, and the same IP can appear again. none uses the service default.

get_account

Returns the TrueProxies account that owns the API key: account reference, email, role, status and billing details.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "additionalProperties": false
}

get_invoice

Returns one invoice: status, amounts in cents, payment attempts and its service. Does not start a payment.

read-only

Argument	Type	Description
invoice_id*	string	Invoice ID (a UUID) from list_invoices

Input schema (JSON)

{
  "type": "object",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice ID (a UUID) from list_invoices"
    }
  },
  "additionalProperties": false
}

get_live_traffic

Returns live traffic for one service: download and upload speed in bits per second over the last ten seconds, traffic used today (UTC) and recent connection outcomes. last_activity_at shows how fresh the data is.

read-only

Argument	Type	Description
service_id*	string	Service ID (a UUID) from list_services

Input schema (JSON)

{
  "type": "object",
  "required": [
    "service_id"
  ],
  "properties": {
    "service_id": {
      "type": "string",
      "description": "Service ID (a UUID) from list_services"
    }
  },
  "additionalProperties": false
}

get_service

Returns one service: status, expiry, connection hosts and ports, capabilities (the targeting and session options it supports) and effective limits. Does not return the proxy password.

read-only

Argument	Type	Description
service_id*	string	Service ID (a UUID) from list_services

Input schema (JSON)

{
  "type": "object",
  "required": [
    "service_id"
  ],
  "properties": {
    "service_id": {
      "type": "string",
      "description": "Service ID (a UUID) from list_services"
    }
  },
  "additionalProperties": false
}

get_traffic_used

Returns traffic for one service, in bytes: bytes_out is downloaded and bytes_in is uploaded since the service started, remaining_bytes is traffic remaining and allowance_bytes is the allowance. traffic_batches lists traffic packs with their expiry. Traffic can take about a minute to appear.

read-only

Argument	Type	Description
service_id*	string	Service ID (a UUID) from list_services

Input schema (JSON)

{
  "type": "object",
  "required": [
    "service_id"
  ],
  "properties": {
    "service_id": {
      "type": "string",
      "description": "Service ID (a UUID) from list_services"
    }
  },
  "additionalProperties": false
}

get_usage_history

Returns usage history for one service, or for the whole account when service_id is empty: connection success, traffic and connection errors over the last 24h, 7d or 30d. In series, bytes_out is downloaded and bytes_in is uploaded. Can lag recent traffic.

read-only

Argument	Type	Description
range	string	24h, 7d or 30d
service_id	string	Service ID (a UUID) from list_services. Leave empty for the whole account.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "range": {
      "enum": [
        "24h",
        "7d",
        "30d"
      ],
      "type": "string",
      "description": "24h, 7d or 30d"
    },
    "service_id": {
      "type": "string",
      "description": "Service ID (a UUID) from list_services. Leave empty for the whole account."
    }
  },
  "additionalProperties": false
}

list_invoices

Lists invoices with status (open, paid or cancelled), kind, amount in cents and the service each belongs to. Paginated: pass next_cursor from the previous response as cursor.

read-only

Argument	Type	Description
kind	string	purchase, renewal, topup, custom, wallet_topup or white_label
limit	integer	Page size, 1 to 100. Default 25.
cursor	string	next_cursor from the previous page
status	string	open, paid or cancelled
service_id	string	Only invoices for this service ID (a UUID)

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "kind": {
      "enum": [
        "purchase",
        "renewal",
        "topup",
        "custom",
        "wallet_topup",
        "white_label"
      ],
      "type": "string",
      "description": "purchase, renewal, topup, custom, wallet_topup or white_label"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1 to 100. Default 25."
    },
    "cursor": {
      "type": "string",
      "description": "next_cursor from the previous page"
    },
    "status": {
      "enum": [
        "open",
        "paid",
        "cancelled"
      ],
      "type": "string",
      "description": "open, paid or cancelled"
    },
    "service_id": {
      "type": "string",
      "description": "Only invoices for this service ID (a UUID)"
    }
  },
  "additionalProperties": false
}

list_plans

Lists TrueProxies plans and traffic packs: price in US cents, term, speed, connection limits, traffic allowance and targeting capabilities. Also returns the cities available for city targeting and whether the free trial is open. Traffic packs (residential_ipv4_gb) have no term; their traffic is valid for 30 days. No API key needed.

read-only

Argument	Type	Description
term	string	Only this billing term: hour, day, week or month. Traffic packs have no term.
product	string	Only this product: datacenter_ipv6, residential_ipv4_unlimited, residential_ipv4_unlimited_pro or residential_ipv4_gb

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "term": {
      "enum": [
        "hour",
        "day",
        "week",
        "month"
      ],
      "type": "string",
      "description": "Only this billing term: hour, day, week or month. Traffic packs have no term."
    },
    "product": {
      "enum": [
        "datacenter_ipv6",
        "residential_ipv4_unlimited",
        "residential_ipv4_unlimited_pro",
        "residential_ipv4_gb"
      ],
      "type": "string",
      "description": "Only this product: datacenter_ipv6, residential_ipv4_unlimited, residential_ipv4_unlimited_pro or residential_ipv4_gb"
    }
  },
  "additionalProperties": false
}

list_services

Lists the services on the account with status, product, plan, expiry and connection hosts. Paginated: pass next_cursor from the previous response as cursor.

read-only

Argument	Type	Description
view	string	current (default) lists every service that is not closed; history lists closed services; all lists both
limit	integer	Page size, 1 to 100. Default 25.
cursor	string	next_cursor from the previous page

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "view": {
      "enum": [
        "current",
        "history",
        "all"
      ],
      "type": "string",
      "description": "current (default) lists every service that is not closed; history lists closed services; all lists both"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1 to 100. Default 25."
    },
    "cursor": {
      "type": "string",
      "description": "next_cursor from the previous page"
    }
  },
  "additionalProperties": false
}

list_trusted_ips

Lists the trusted IPs of a service: addresses allowed to connect without the proxy password.

read-only

Argument	Type	Description
service_id*	string	Service ID (a UUID) from list_services

Input schema (JSON)

{
  "type": "object",
  "required": [
    "service_id"
  ],
  "properties": {
    "service_id": {
      "type": "string",
      "description": "Service ID (a UUID) from list_services"
    }
  },
  "additionalProperties": false
}

TrueProxies

Try it

check_connection

TrueProxies

Try it

check_connection

Tools (12)