Allgemeine Anfragen
Aktualisiert:
Vier Endpunkte zum Lesen von kontobasierten Informationen. Alle verwenden die Basis-URL/client-api/v1/<apiKey>/. Alle Rückkehr200 OK mitsuccess: true bei Erfolg - siehe Mögliche Fehler für Fehlermodi.
Endpunkt | Methode | Rückgabe |
|---|---|---|
| Saldo der Leistungsbilanz. | |
| Alle Proxys, die Sie besitzen, gruppiert nach Typ. | |
| Gültig | |
| Länder, in denen Proxys gekauft werden können. |
Bilanz
Beispielanfrage
curl https://proxy-ipv4.com/client-api/v1/API_KEY/get/balanceBeispielhafte Antwort
{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD"
}Antwortfelder
Feld | Typ | Beschreibung |
|---|---|---|
| boolean | Betriebsstatus. |
| string | E-Mail-Konto. |
| nummer | Aktueller Saldo in |
| string | ISO-Währungscode. |
Liste der gekauften Vollmachten
Gibt alle aktiven Proxys des Kontos zurück, gruppiert nach Proxy-Typ.
Beispielanfrage
curl https://proxy-ipv4.com/client-api/v1/$KEY/get/proxiesBeispielhafte Antwort
Wechseln Sie die Registerkarten, um die Form pro Proxy-Typ zu sehen. Der Top-Level-Wrapper ist derselbe, die Proxy-Objekte unterscheiden sich.
{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD",
"countOfProxy": 6,
"ipv4": [
{
"id": "id1",
"ip": "185.81.112.215",
"country": "GBR",
"dateStart": "2022-08-29T14:55:38.293+00:00",
"dateEnd": "2022-08-30T23:59:38.293+00:00",
"httpsPort": "49162",
"socks5Port": "49163",
"authInfo": { "login": "authLogin123", "password": "authPassword" }
}
]
}{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD",
"countOfProxy": 6,
"ipv6": [
{
"orderId": "orderId1",
"ip": "2001:db8:abcd::1",
"country": "GBR",
"dateStart": "2022-08-29T14:55:38.293+00:00",
"dateEnd": "2022-08-30T23:59:38.293+00:00",
"port": "49162",
"protocol": "HTTP",
"authInfo": { "login": "authLogin123", "password": "authPassword" }
}
]
}{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD",
"countOfProxy": 6,
"isp": [
{
"id": "id1",
"ip": "185.81.112.215",
"country": "GBR",
"dateStart": "2022-08-29T14:55:38.293+00:00",
"dateEnd": "2022-08-30T23:59:38.293+00:00",
"httpsPort": "49162",
"socks5Port": "49163",
"authInfo": { "login": "authLogin123", "password": "authPassword" }
}
]
}{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD",
"countOfProxy": 6,
"mobile": [
{
"id": "id1",
"ip": "185.81.112.215",
"country": "GBR",
"dateStart": "2022-08-29T14:55:38.293+00:00",
"dateEnd": "2022-08-30T23:59:38.293+00:00",
"httpsPort": "49162",
"socks5Port": "49163",
"authInfo": { "login": "authLogin123", "password": "authPassword" },
"mobileOperator": "kyivstar",
"rotationTime": 5,
"rebootLink": "https://proxy-ipv4.com/link"
}
]
}Felder der obersten Ebene
Feld | Typ | Beschreibung |
|---|---|---|
| boolean | Betriebsstatus. |
| string | E-Mail-Konto. |
| nummer | Aktueller Saldo in |
| string | ISO-Währungscode. |
| nummer | Gesamtzahl der Vollmachten für alle Typen. |
| array | Liste der IPv4-Proxys. Leer, wenn Sie keine haben. |
| array | Liste der IPv6-Proxys. Leer, wenn Sie keine haben. |
| array | Liste der ISP-Proxys. Leer, wenn Sie keine haben. |
| array | Liste der mobilen Proxys. Leer, wenn Sie keine haben. |
Felder des Proxy-Objekts
Einige Felder erscheinen nur für bestimmte Proxy-Typen. Die Spalte "Vorhanden in" ist die Quelle der Wahrheit für die Variation pro Typ.
Feld | Typ | Anwesend in | Beschreibung |
|---|---|---|---|
| string | IPv4, ISP, Mobil | Proxy-ID. Verwenden Sie diese bei der Erweiterung des Proxys. |
| string | Nur IPv6 | Auftrags-ID. IPv6 kann nur für die gesamte Bestellung erweitert werden, nicht pro Proxy - verwenden Sie diese ID für Erweiterungsvorgänge. |
| string | Alle | Die IP-Adresse. |
| string | Alle | ISO 3166-1 Alpha-3 Ländercode. |
| string | Alle | ISO 8601 Zeitstempel für das Mietfenster. |
| string | IPv4, ISP, Mobil | Ports für HTTP/HTTPS und SOCKS5. |
| string | Nur IPv6 | Einzelner Anschluss. |
| string | Nur IPv6 | Immer |
| objekt | Alle |
|
| string | Nur mobil | Tag des Mobilfunkbetreibers. |
| nummer | Nur mobil | IP-Rotationsintervall in Minuten. |
| string | Nur mobil | URL, um die Rotation manuell auszulösen. |
Verfügbare Mietzeiträume
Gibt den gültigenrentPeriodDays werte, die Sie beim Kauf oder der Erneuerung von Vollmachten verwenden können. Die verfügbaren Zeiträume können je nach Proxy-Typ unterschiedlich sein.
Abfrage-Parameter
Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | ja | Einer von: |
Beispielanfrage
curl "https://proxy-ipv4.com/client-api/v1/$KEY/get/days?proxyType=ipv4"Beispielhafte Antwort
{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD",
"days": [1, 7, 14, 30, 60, 90]
}Antwortfelder
Feld | Typ | Beschreibung |
|---|---|---|
| boolean | Betriebsstatus. |
| string | E-Mail-Konto. |
| nummer | Aktueller Saldo in |
| string | ISO-Währungscode. |
| zahlenreihe | Gültige Mietzeitraumwerte für die angeforderte |
Verfügbare Länder
Gibt Länder an, in denen Sie Vollmachten kaufen können. Die verfügbaren Länder können sich je nach Proxy-Typ unterscheiden.
Abfrage-Parameter
Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | ja | Einer von: |
Beispielanfrage
curl "https://proxy-ipv4.com/client-api/v1/$KEY/get/countries?proxyType=ipv4"Beispielhafte Antwort
{
"success": true,
"user": "[email protected]",
"balance": 13.09,
"currency": "USD",
"countries": [
{ "name": "ENGLAND", "alpha3code": "GBR" },
{ "name": "USA", "alpha3code": "USA" },
{ "name": "FRANCE", "alpha3code": "FRA" }
]
}Antwortfelder
Feld | Typ | Beschreibung |
|---|---|---|
| boolean | Betriebsstatus. |
| string | E-Mail-Konto. |
| nummer | Aktueller Saldo in |
| string | ISO-Währungscode. |
| array | Verfügbare Länder für die angefragten |
| string | Name des Landes. |
| string | ISO 3166-1 Alpha-3-Code. Verwenden Sie diesen Wert, wenn Sie eine Bestellung aufgeben. |