Vue d'ensemble de l'API

Authentification, format de requête, enveloppe de réponse et carte complète des endpoints de l'API REST RaxyProxy.

URL de base

https://raxyproxy.com/api/v1

Tous les endpoints sont versionnés sous /api/v1. HTTPS is required.

Authentification

Chaque requête doit inclure votre clé API dans le header Authorization au format Bearer. Générez votre clé sur API Keys page.

Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

example.sh

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

Gardez votre clé secrète

Les clés API accordent un accès complet — ne les committez pas. Utilisez des variables d'environnement ou un gestionnaire de secrets.

Endpoints

Tous les endpoints publics en v1. Chaque ligne renvoie à sa page détaillée.

Méthode	Chemin	Rôle
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

Enveloppe de réponse

Chaque réponse réussie est enveloppée dans une enveloppe standard :

response.json

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

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

Erreurs

En cas d'erreur, le code HTTP reflète la catégorie. Le corps contient une clé error key with a machine-readable code and a human-readable message.

Statut	Code	Signification
`400`	`invalid_request`	Requête incorrecte — paramètres invalides
`401`	`unauthorized`	Clé API manquante ou invalide
`402`	`payment_required`	Solde insuffisant — rechargez votre wallet
`403`	`forbidden` / `insufficient_scope`	Interdit — la clé n'a pas le scope
`404`	`not_found`	Ressource non trouvée
`409`	`conflict`	Conflit — l'état empêche l'opération (ex. IP déjà whitelisté)
`422`	`validation_failed`	Validation échouée — voir l'objet errors
`429`	`rate_limited`	Limite dépassée — voir le header Retry-After
`500`	`http_error`	Erreur interne du serveur
`502`	`provider_error`	Erreur du fournisseur upstream — temporaire, réessayez plus tard

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 débit

Limites par clé API, groupées par type. Au dépassement : 429 + Retry-After.

Groupe	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

Spécifications lisibles par machine pour les outils, SDKs et assistants IA :

Format	URL	Cas d'utilisation
OpenAPI 3.0 JSON	`/openapi.json`	Swagger UI, Postman, générateurs de SDK
Plain text (LLM)	`/llms-api.txt`	ChatGPT, Claude, contexte Cursor

← Précédent

Scrapy

Compte