Descripción general de la API

Autenticación, formato de solicitud, sobre de respuesta y el mapa completo de endpoints de la API REST de RaxyProxy.

URL base

https://raxyproxy.com/api/v1

Todos los endpoints están versionados bajo /api/v1. HTTPS is required.

Autenticación

Cada solicitud debe incluir su clave API en el header Authorization usando formato Bearer. Genere su clave en API Keys page.

Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

example.sh

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

Mantenga su clave en secreto

Las claves API otorgan acceso completo — no las incluya en control de versiones. Use variables de entorno o un gestor de secretos.

Endpoints

Todos los endpoints públicos en v1. Cada fila enlaza con su página de detalle.

Método	Ruta	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

Sobre de respuesta

Cada respuesta exitosa está envuelta en un sobre estándar:

response.json

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

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

Errores

En caso de error, el código HTTP refleja la categoría. El cuerpo contiene una clave error key with a machine-readable code and a human-readable message.

Estado	Código	Significado
`400`	`invalid_request`	Solicitud incorrecta — parámetros inválidos
`401`	`unauthorized`	Clave API ausente o inválida
`402`	`payment_required`	Saldo insuficiente — recarga tu wallet
`403`	`forbidden` / `insufficient_scope`	Prohibido — la clave no tiene scope
`404`	`not_found`	Recurso no encontrado
`409`	`conflict`	Conflicto — el estado del recurso impide la operación (ej. IP ya en whitelist)
`422`	`validation_failed`	Validación fallida — revise el objeto errors
`429`	`rate_limited`	Límite excedido — vea el header Retry-After
`500`	`http_error`	Error interno del servidor
`502`	`provider_error`	Error del proveedor upstream — temporal, reintente más 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" }
}

Límites de velocidad

Los límites son por clave API y se agrupan por tipo de endpoint. Al alcanzarse, devolvemos 429 + Retry-After.

Grupo	Límite	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

Especificaciones legibles por máquina para integraciones:

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

← Anterior

Scrapy

Cuenta