API-Übersicht

Authentifizierung, Anfrageformat, Antwortkuvert und die vollständige Endpunkt-Karte der RaxyProxy REST API.

Basis-URL

https://raxyproxy.com/api/v1

Alle Endpunkte sind versioniert unter /api/v1. HTTPS is required.

Authentifizierung

Jede Anfrage muss Ihren API-Schlüssel im Authorization Header im Bearer-Token-Format enthalten. Schlüssel generieren Sie auf der API Keys page.

Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

example.sh

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

Halten Sie Ihren Schlüssel geheim

API-Schlüssel gewähren vollen Zugriff auf Ihr Konto — nicht in Versionskontrolle committen. Verwenden Sie Umgebungsvariablen oder einen Secrets-Manager.

Endpunkte

Alle öffentlichen Endpunkte in v1. Jede Zeile verlinkt auf die eigene Seite mit Schema und Codebeispielen.

Methode	Pfad	Zweck
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

Antwortkuvert

Jede erfolgreiche Antwort ist in einem Standardkuvert verpackt:

response.json

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

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

Fehler

Bei einem Fehler gibt der HTTP-Statuscode die Problemkategorie an. Der Body enthält einen error key with a machine-readable code and a human-readable message.

Status	Code	Bedeutung
`400`	`invalid_request`	Ungültige Anfrage — fehlerhafte Parameter
`401`	`unauthorized`	API-Schlüssel fehlt oder ungültig
`402`	`payment_required`	Unzureichendes Guthaben — bitte Wallet aufladen
`403`	`forbidden` / `insufficient_scope`	Verboten — Schlüssel hat keinen Zugriff
`404`	`not_found`	Ressource nicht gefunden
`409`	`conflict`	Konflikt — Ressourcenzustand verhindert die Operation (z. B. IP bereits whitelisted)
`422`	`validation_failed`	Validierung fehlgeschlagen — siehe errors-Objekt
`429`	`rate_limited`	Ratenlimit überschritten — siehe Retry-After Header
`500`	`http_error`	Interner Serverfehler
`502`	`provider_error`	Upstream-Provider-Fehler — vorübergehend, später erneut versuchen

error.validation.json

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

Ratenlimits

Limits gelten pro API-Schlüssel und sind nach Endpunkttyp gruppiert. Bei Erreichen liefert der Server 429 + Retry-After.

Gruppe	Limit	Endpunkte
`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 / KI-Spezifikation

Maschinenlesbare Spezifikationen für Tools, SDKs und KI-Assistenten:

Format	URL	Anwendungsfall
OpenAPI 3.0 JSON	`/openapi.json`	Swagger UI, Postman, SDK-Generatoren
Plain text (LLM)	`/llms-api.txt`	ChatGPT, Claude, Cursor-Kontext