# Overview

> TrueProxies customer API reference: base URL, bearer API keys, scopes, rate limits and every operation with code samples.

Source: https://docs.trueproxies.com/api/

## TrueProxies Customer API (1.0.0)

Manage existing proxy services using scoped Bearer keys. Default budget: 300 requests per minute per account, shared across keys and control replicas. On HTTP 429, wait for Retry-After. Protected responses use Cache-Control: no-store and X-Request-ID. Timestamps are ISO-8601; monetary amounts are cents. Use the dashboard for API key management. Creating and paying invoices requires billing:write or reseller:purchase.

**Information**

- OpenAPI version: `3.1.0`

## Operations

- `GET` [/v1/analytics](https://docs.trueproxies.com/api/operations/get_v1_analytics/)
- `GET` [/v1/catalog](https://docs.trueproxies.com/api/operations/get_v1_catalog/)
- `GET` [/v1/catalog/priced](https://docs.trueproxies.com/api/operations/get_v1_catalog_priced/)
- `GET` [/v1/invoices](https://docs.trueproxies.com/api/operations/get_v1_invoices/)
- `POST` [/v1/invoices](https://docs.trueproxies.com/api/operations/post_v1_invoices/)
- `GET` [/v1/invoices/{id}](https://docs.trueproxies.com/api/operations/get_v1_invoices_id/)
- `POST` [/v1/invoices/{id}/cancel](https://docs.trueproxies.com/api/operations/post_v1_invoices_id_cancel/)
- `POST` [/v1/invoices/{id}/pay](https://docs.trueproxies.com/api/operations/post_v1_invoices_id_pay/)
- `GET` [/v1/invoices/{id}/pdf](https://docs.trueproxies.com/api/operations/get_v1_invoices_id_pdf/)
- `GET` [/v1/me](https://docs.trueproxies.com/api/operations/get_v1_me/)
- `GET` [/v1/reseller/customers](https://docs.trueproxies.com/api/operations/get_v1_reseller_customers/)
- `POST` [/v1/reseller/customers](https://docs.trueproxies.com/api/operations/post_v1_reseller_customers/)
- `GET` [/v1/reseller/customers/{id}](https://docs.trueproxies.com/api/operations/get_v1_reseller_customers_id/)
- `DELETE` [/v1/reseller/customers/{id}](https://docs.trueproxies.com/api/operations/delete_v1_reseller_customers_id/)
- `PATCH` [/v1/reseller/customers/{id}](https://docs.trueproxies.com/api/operations/patch_v1_reseller_customers_id/)
- `POST` [/v1/reseller/customers/{id}/resume](https://docs.trueproxies.com/api/operations/post_v1_reseller_customers_id_resume/)
- `POST` [/v1/reseller/customers/{id}/suspend](https://docs.trueproxies.com/api/operations/post_v1_reseller_customers_id_suspend/)
- `GET` [/v1/services](https://docs.trueproxies.com/api/operations/get_v1_services/)
- `GET` [/v1/services/{id}](https://docs.trueproxies.com/api/operations/get_v1_services_id/)
- `GET` [/v1/services/{id}/analytics](https://docs.trueproxies.com/api/operations/get_v1_services_id_analytics/)
- `POST` [/v1/services/{id}/check](https://docs.trueproxies.com/api/operations/post_v1_services_id_check/)
- `POST` [/v1/services/{id}/endpoints](https://docs.trueproxies.com/api/operations/post_v1_services_id_endpoints/)
- `GET` [/v1/services/{id}/live-metrics](https://docs.trueproxies.com/api/operations/get_v1_services_id_live_metrics/)
- `POST` [/v1/services/{id}/rotate-password](https://docs.trueproxies.com/api/operations/post_v1_services_id_rotate_password/)
- `GET` [/v1/services/{id}/secret](https://docs.trueproxies.com/api/operations/get_v1_services_id_secret/)
- `GET` [/v1/services/{id}/usage](https://docs.trueproxies.com/api/operations/get_v1_services_id_usage/)
- `GET` [/v1/services/{id}/whitelist](https://docs.trueproxies.com/api/operations/get_v1_services_id_whitelist/)
- `POST` [/v1/services/{id}/whitelist](https://docs.trueproxies.com/api/operations/post_v1_services_id_whitelist/)
- `DELETE` [/v1/services/{id}/whitelist/{entryId}](https://docs.trueproxies.com/api/operations/delete_v1_services_id_whitelist_entryid/)
- `GET` [/v1/wallet](https://docs.trueproxies.com/api/operations/get_v1_wallet/)
- `GET` [/v1/wallet/ledger](https://docs.trueproxies.com/api/operations/get_v1_wallet_ledger/)
- `POST` [/v1/wallet/topups](https://docs.trueproxies.com/api/operations/post_v1_wallet_topups/)

## Authentication

### customerAPIKey

Send Authorization: Bearer tp\_api\_… . Create a named, scoped key in the customer dashboard. Keys expire after 30, 90 or 365 days and can be revoked immediately.

**Security scheme type:** http

**Bearer format:** API key