Visão geral da API

Autenticação, formato de requisição, envelope de resposta e mapa completo de endpoints da API REST RaxyProxy.

URL base

https://raxyproxy.com/api/v1

Todos os endpoints são versionados sob /api/v1. HTTPS is required.

Autenticação

Cada requisição deve incluir sua chave no header Authorization no formato Bearer. Gere sua chave em API Keys page.

Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

example.sh

curl https://raxyproxy.com/api/v1/account \
     -H "Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Mantenha sua chave secreta

Chaves API concedem acesso total — não as inclua no controle de versão. Use variáveis de ambiente ou um gerenciador de segredos.

Endpoints

Todos os endpoints públicos da v1. Cada linha leva à página detalhada.

Método	Caminho	Propósito
GET	`/account`	Profile, balance, 30d traffic, API key info
GET	`/packages`	List active and suspended packages
GET	`/packages/{id}`	Detailed package (includes proxy password)
GET	`/packages/{id}/proxies`	Generate ready-to-use proxy strings
GET	`/packages/{id}/stats`	Time-series usage (minute / hour / day)
GET	`/packages/{id}/stats/hosts`	Top destinations by traffic
GET	`/packages/{id}/stats/errors`	Recent error events per host / code
POST	`/packages/{id}/rotate-password`	Generate a new proxy password
PATCH	`/packages/{id}/threads`	Update max concurrent connections
PATCH	`/packages/{id}/protocols`	Enable/disable HTTP & SOCKS5
GET	`/packages/{id}/allowed-ips`	List whitelisted client IPs
POST	`/packages/{id}/allowed-ips`	Add an IP to the whitelist
DELETE	`/packages/{id}/allowed-ips/{ip}`	Remove an IP from the whitelist
GET	`/packages/{id}/blocked-hosts`	List domains the package may not reach
PUT	`/packages/{id}/blocked-hosts`	Replace the blocked-hosts list
GET	`/packages/{id}/default-geo`	Default geo applied without per-request params
PUT	`/packages/{id}/default-geo`	Update default geo (countries/states/cities/ASNs…)
POST	`/packages/{id}/top-up`	Add GB to the package using wallet balance
GET	`/packages/{id}/top-ups`	History of top-ups for this package
GET	`/locations/countries`	Available countries for a pool type
GET	`/locations/states`	States within selected countries
GET	`/locations/cities`	Cities within selected countries/states
GET	`/locations/zipcodes`	ZIP codes within selected countries/states
GET	`/locations/asns`	ASNs within selected countries/states/cities

Envelope de resposta

Cada resposta bem-sucedida vem em um envelope padrão:

response.json

{
  "data": { ... },
  "meta": {
    "version": "v1"
  }
}

O campo data field contains the actual payload (object or array depending on the endpoint). Paginated endpoints include additional keys inside meta.

Erros

Em caso de erro, o código HTTP reflete a categoria. O body contém uma chave error key with a machine-readable code and a human-readable message.

Status	Código	Significado
`400`	`invalid_request`	Requisição incorreta — parâmetros inválidos
`401`	`unauthorized`	Chave API ausente ou inválida
`402`	`payment_required`	Saldo insuficiente — recarregue sua carteira
`403`	`forbidden` / `insufficient_scope`	Proibido — a chave não tem scope
`404`	`not_found`	Recurso não encontrado
`409`	`conflict`	Conflito — o estado impede a operação (ex. IP já whitelisted)
`422`	`validation_failed`	Validação falhou — veja o objeto errors
`429`	`rate_limited`	Limite excedido — veja o header Retry-After
`500`	`http_error`	Erro interno do servidor
`502`	`provider_error`	Erro do provedor upstream — temporário, tente mais tarde

error.validation.json

{
  "error": {
    "code":    "validation_failed",
    "message": "Validation failed",
    "errors":  { "threads": ["The threads field must be between 1 and 2000."] }
  },
  "meta": { "version": "v1" }
}

Limites de taxa

Limites por chave API, agrupados por tipo. Ao atingir: 429 + Retry-After.

Grupo	Limite	Endpoints
`api`	120 / min	/account, /packages, /packages/{id}
`stats-api`	60 / min	/stats, /stats/hosts, /stats/errors, /top-ups
`proxies-api`	30 / min	/proxies
`settings-api`	30 / min	all package mutations (rotate-password, allowed-ips, …)
`locations-api`	60 / min	/locations/*
`topup-api`	10 / min	/packages/{id}/top-up

HTTP/1.1 429 Too Many Requests
Retry-After: 12
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0

OpenAPI / IA

Especificações legíveis por máquina para ferramentas, SDKs e assistentes IA:

Formato	URL	Caso de uso
OpenAPI 3.0 JSON	`/openapi.json`	Swagger UI, Postman, geradores de SDK
Plain text (LLM)	`/llms-api.txt`	ChatGPT, Claude, contexto do Cursor

← Anterior

Scrapy

Conta