# TrueProxies Customer API

**Canonical:** https://apis.io/apis/trueproxies/trueproxies-customer-api/  
**Provider:** TrueProxies — https://apis.io/providers/trueproxies/  
**Base URL:** https://api.trueproxies.com  
**Documentation:** https://docs.trueproxies.com/overview/

TrueProxies Customer API is published by [TrueProxies](https://apis.io/providers/trueproxies/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Proxies, Proxy Management, Billing, Analytics, and IP Whitelisting. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

Manage existing TrueProxies proxy services using scoped Bearer keys (tp_api_…): list services and their connection details, build endpoint strings, rotate proxy passwords, manage IP whitelists, run service checks, read usage, analytics and live metrics, browse the public and priced catalog, and create, pay and download invoices. Default budget of 300 requests per minute per account.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/analytics` | Get account analytics |
| GET | `/v1/catalog` | Browse offers and locations |
| GET | `/v1/catalog/priced` | Browse your current prices |
| GET | `/v1/invoices` | List invoices |
| POST | `/v1/invoices` | Create a purchase invoice |
| GET | `/v1/invoices/{id}` | Get an invoice |
| POST | `/v1/invoices/{id}/pay` | Pay an invoice |
| GET | `/v1/invoices/{id}/pdf` | Download an invoice PDF |
| GET | `/v1/me` | Get your account |
| GET | `/v1/services` | List your services |
| GET | `/v1/services/{id}` | Get a service |
| GET | `/v1/services/{id}/analytics` | Get service analytics |
| POST | `/v1/services/{id}/check` | Check a service end to end |
| POST | `/v1/services/{id}/endpoints` | Generate connection strings |
| GET | `/v1/services/{id}/live-metrics` | Get live service metrics |
| POST | `/v1/services/{id}/rotate-password` | Change the proxy password |
| GET | `/v1/services/{id}/secret` | Get proxy username and password |
| GET | `/v1/services/{id}/usage` | Get service usage |
| GET | `/v1/services/{id}/whitelist` | List trusted IPs |
| POST | `/v1/services/{id}/whitelist` | Add a trusted IP |
| DELETE | `/v1/services/{id}/whitelist/{entryId}` | Remove a trusted IP |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/openapi/trueproxies-openapi.yml
- **OpenAPI** — https://api.trueproxies.com/v1/openapi.json
- **Documentation** — https://docs.trueproxies.com/overview/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/json-schema/trueproxies-live-metrics-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/json-schema/trueproxies-service-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/json-schema/trueproxies-usage-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/json-schema/trueproxies-endpoint-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/json-schema/trueproxies-invoice-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/json-schema/trueproxies-me-schema.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/trueproxies/refs/heads/main/apis.yml

## Tags

Proxies, Proxy Management, Billing, Analytics, IP Whitelisting

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/trueproxies/trueproxies-customer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/trueproxies/.