Proxy API documentation: Pagkuha ng proxy list sa pamamagitan ng REST API

Ano ang pwedeng gawin sa API?

Gamitin ang API kapag gusto mong kumuha ng latest list ang program mismo. Pwedeng kumuha ng list tuwing magsisimula ang crawler o kapag nag-expire na ang plan. Parehong data lang ang nasa dashboard download at API.

Read-only ang API. Suportado ang balance check, listahan ng plans, at proxy list retrieval. Ang payment at purchase ay sa dashboard. Lahat ng response ay UTF-8 at ang mga date ay nasa ISO 8601 UTC format.

Paano gumawa at magpadala ng API key?

Gumawa ng key sa API key screen sa dashboard. Ang key ay nagsisimula sa spx_ at may 44 na karakter, at makikita lang ito ng isang beses sa oras ng paggawa. Kung nawala ang key, gumawa lang ng bago, at ang lumang key ay hindi na gagana.

Ilagay ang API key sa Authorization header gamit ang Bearer method sa bawat request. Hindi tinatanggap ang paglalagay ng key sa URL query. Magre-response ng 401 unauthorized kung walang key o mali ang key.

curl -H "Authorization: Bearer spx_your_api_key" https://socks5proxy.io/api/v1/account

Balance at account info query: GET /account

Ibinabalik ang account code, balance, bilang ng mga aktibong plano, at bilang ng mga proxy. Ang balance ay hanggang sa dalawang decimal place (USD).

curl -H "Authorization: Bearer spx_your_api_key" https://socks5proxy.io/api/v1/account

{
  "code": "S5-7KQ2-M8PX-4HDA",
  "balance": "125.40",
  "currency": "USD",
  "active_plans": 2,
  "proxies": 125,
  "created_at": "2026-10-22T08:15:02.114Z"
}

Listahan ng plans: GET /plans

Ibinabalik ang biniling plan mula sa pinakabago. Ang status ay maaaring active (ginagamit), expired (tapos na ang duration), o canceled (kinansela). Ang id ay ang plan code (nagsisimula sa P-) at magagamit bilang plan value sa /proxies.

{
  "plans": [
    {
      "id": "P-8WQ4C-NM2KT",
      "product": "dc-private",
      "product_name": "Private Datacenter Proxy",
      "ips": 100,
      "months": 1,
      "country": "us",
      "status": "active",
      "amount": "49.40",
      "created_at": "2026-10-22T08:20:11.002Z",
      "expires_at": "2026-11-22T08:20:11.002Z"
    }
  ]
}

Proxy list query: GET /proxies

Ibinabalik ang mga proxy ng kasalukuyang plan sa JSON format. Kasama ang address, HTTP port, SOCKS5 port, username, password, bansa, lungsod, plan code, at expiration time para sa bawat proxy.

Maaari mong i-filter gamit ang country (two-letter country code, hal. us) at plan (plan code). Ang protocol value ay makikita sa response, at ang JSON ay naglalaman ng parehong ports.

curl -H "Authorization: Bearer spx_your_api_key" \
  "https://socks5proxy.io/api/v1/proxies?country=us&protocol=socks5"

{
  "count": 1,
  "protocol": "socks5",
  "proxies": [
    {
      "host": "198.51.100.23",
      "http_port": 8231,
      "socks5_port": 1080,
      "username": "spx_k2m8qa",
      "password": "q7rbx2wd9n",
      "country": "us",
      "city": "New York",
      "plan": "P-8WQ4C-NM2KT",
      "product": "dc-private",
      "product_name": "Private Datacenter Proxy",
      "expires_at": "2026-11-22T08:20:11.002Z"
    }
  ]
}

I-download ang list: GET /proxies/download

Ibinabalik namin ang isang proxy bawat linya para madaling basahin ng programa. Kung ang protocol ay socks5, isasama ang SOCKS5 port; kung http, isasama ang HTTP port. Ang format=url ay nagdaragdag ng prefix (socks5:// o http://) na naaayon sa protocol.

Sa server na naka-enable ang IP authorization, maaaring kumonekta nang direkta gamit ang format na ip:port nang walang username. Ang csv file ay may column name sa unang linya at naglalaman ng parehong port.

curl -H "Authorization: Bearer spx_your_api_key" \
  "https://socks5proxy.io/api/v1/proxies/download?format=url&protocol=socks5" -o proxies.txt

Code examples: Python, Node.js, PHP

Ang halimbawa sa ibaba ay tumatanggap ng listahan at nagpapadala ng kahilingan sa unang proxy. Para magamit ang SOCKS5 sa Python, kailangan ang requests[socks] package, at kapag ginamit ang socks5h, ang domain name resolution ay ginagawa rin sa proxy side.

import requests

API = "https://socks5proxy.io/api/v1"
H = {"Authorization": "Bearer spx_your_api_key"}

proxies = requests.get(f"{API}/proxies", headers=H, params={"country": "us"}).json()["proxies"]
p = proxies[0]
url = f"socks5h://{p['username']}:{p['password']}@{p['host']}:{p['socks5_port']}"
r = requests.get("https://api.ipify.org?format=json", proxies={"http": url, "https": url}, timeout=30)
print(r.json())

import { ProxyAgent, fetch } from "undici";

const API = "https://socks5proxy.io/api/v1";
const H = { Authorization: "Bearer spx_your_api_key" };

const { proxies } = await (await fetch(`${API}/proxies?country=us`, { headers: H })).json();
const p = proxies[0];
const agent = new ProxyAgent(`http://${p.username}:${p.password}@${p.host}:${p.http_port}`);
const r = await fetch("https://api.ipify.org?format=json", { dispatcher: agent });
console.log(await r.json());

<?php
$ch = curl_init("https://socks5proxy.io/api/v1/proxies/download?format=ip:port:user:pass&protocol=http");
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER => ["Authorization: Bearer spx_your_api_key"],
  CURLOPT_RETURNTRANSFER => true,
]);
$lines = explode("\n", trim(curl_exec($ch)));
[$host, $port, $user, $pass] = explode(":", $lines[0]);
echo "$host:$port\n";

Error codes at call limits

Ang errors ay ibinibigay sa format na { "error": { "code", "message" } } kasama ang HTTP status code. Hanggang 300 calls per minute bawat key, at kapag lumagpas, magre-respond ng 429 for 1 minute. Ang list ay nagbabago lang sa purchase o expiration, kaya recommended na i-download every few minutes at gamitin ulit sa program.

Walang bayad ang API calls. Ang balance ay babawasan lang kapag bumili ng plan sa dashboard.