Lumaktaw sa nilalaman
starproxy
Magsimula

StarProxy API

Karamihan ng dashboard ay magagamit mula sa code. Tingnan ang balance, alamin ang presyo, mag-order mula sa balance at kumuha ng proxy username na may opsyon, lahat sa iisang REST API.

Saan ako magsisimula?

  1. 1Mag-sign up gamit ang username at mag-log in sa dashboard.
  2. 2Gumawa ng API key sa tab na Connect. Isang beses lang ipapakita ang buong key, pagkagawa mo, kaya itago ito agad sa ligtas na lugar.
  3. 3Ipadala ang key sa Authorization header sa bawat request na nangangailangan nito.
  4. 4Tawagin muna ang /account para matiyak na gumagana ang key, tapos mag-order gamit ang /orders.

Authentication

Kailangan ng API key ang mga request tungkol sa sarili mong account (account, orders, proxy-user), na ipinapadala sa header bilang Authorization: Bearer spk_... Public ang presyo, bansa at quote at gumagana nang walang key.

Hash lang ng bawat key ang itinatago ng StarProxy, hindi ang key mismo. Kapag nawala ang key, gumawa ng bago sa dashboard. Titigil agad sa paggana ang lumang key. Itago lang ang key sa server code. Huwag itong ilagay sa code na tumatakbo sa browser o sa public repository.

HTTP header
Authorization: Bearer spk_your_api_key

Base URL at format ng data

Base URL
https://starproxy.shop/api/v1
Body ng request at response
application/json
Halaga
USD bilang numero, hal. 1047.70
Timestamp
ISO 8601 (UTC)

May rate limit ba?

Ang isang API key ay puwedeng tumawag nang hanggang 60 beses kada minuto. Ang mga public endpoint na walang key ay 60 tawag kada minuto bawat IP. Kapag lumampas, makakatanggap ka ng HTTP 429, kaya maghintay ng isang minuto at magpadala ulit.

Ano ang itsura ng error?

HTTP status code, kasama ang JSON body na may maikling error code at mensahe.

Halimbawa
{
  "error": {
    "code": "insufficient_balance",
    "message": "Your balance is too low for this order. Top up in the dashboard."
  }
}
code
bad_requestHTTP 400May kulang na kailangang value, o hindi valid ang value para sa produktong ito.
unauthorizedHTTP 401Walang API key o hindi ito tugma.
insufficient_balanceHTTP 402Mas mababa ang balance mo kaysa sa kabuuan ng order. Walang nabawas.
not_foundHTTP 404Walang order na may ganitong id sa account mo.
rate_limitedHTTP 429Masyadong maraming request sa loob ng isang minuto.
server_errorHTTP 500Hindi natapos ng server ang request. Walang nabawas.

Mga endpoint

Kunin ang account

GET/api/v1/accountKailangan ng API key

Ibinabalik ang balance mo, proxy host at port, proxy username at password, at ang mga Allowed IP mo.

Request
curl https://starproxy.shop/api/v1/account \
  -H "Authorization: Bearer spk_your_api_key"
Response
{
  "username": "star_user01",
  "balance_usd": 1300,
  "proxy": {
    "host": "gate.starproxy.shop",
    "http_port": 6100,
    "socks5_port": 6200,
    "username": "spexample1",
    "password": "your_password"
  },
  "allowed_ips": [
    "203.0.113.10"
  ]
}

Kunin ang mga produkto at presyo

GET/api/v1/productsHindi kailangan ng key

Ibinabalik ang saklaw ng order ng bawat produkto, presyo sa bawat antas ng dami at discount sa tagal, mula sa parehong price table ng pricing page.

Request
curl https://starproxy.shop/api/v1/products
Response
{
  "currency": "USD",
  "prices_as_of": "2026-10-31",
  "products": [
    {
      "id": "unlimited",
      "unit": "day",
      "quantity": {
        "meaning": "days",
        "min": 1,
        "max": 365
      },
      "...": "..."
    },
    {
      "id": "residential",
      "unit": "gb",
      "...": "..."
    }
  ]
}

Listahan ng bansa at lungsod

GET/api/v1/countriesHindi kailangan ng key

Ibinabalik ang mga bansang sinusuportahan ng bawat produkto, kasama ang mga city value para sa -city- na opsyon sa username.

FieldIbig sabihin
productOpsyonalIsa sa unlimited, residential, isp, datacenter. Residential ang default.
Request
curl "https://starproxy.shop/api/v1/countries?product=datacenter"
Response
{
  "product": "datacenter",
  "countries": [
    {
      "code": "us",
      "name": "United States",
      "region": "americas",
      "datacenter": true,
      "cities": [
        {
          "name": "New York",
          "value": "new_york"
        },
        {
          "name": "Los Angeles",
          "value": "los_angeles"
        }
      ]
    }
  ]
}

Kumuha ng quote

POST/api/v1/quoteHindi kailangan ng key

Kinukuwenta ang kabuuan ng order nang hindi ginagalaw ang balance mo. Ipadala ang parehong body na gagamitin mo sa order.

FieldIbig sabihin
productKailanganIsa sa unlimited, residential, isp, datacenter.
quantityKailanganAraw para sa unlimited (1~365), GB para sa residential (5~5,000), dami ng IP para sa isp (1~1,000) o datacenter (5~5,000).
concurrencyOpsyonalPara sa unlimited lang. Isa sa 200, 500, 1000, 2000.
bandwidthOpsyonalPara sa unlimited lang, sa Mbps. Isa sa 100, 200, 500, 1000.
monthsOpsyonalPara sa isp at datacenter lang. Isa sa 1, 3, 6, 12.
countryOpsyonalPara sa isp at datacenter lang. Dalawang-letrang country code gaya ng jp. Tingnan ang /countries para sa mga valid na value.
Request
curl -X POST https://starproxy.shop/api/v1/quote \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'
Response
{
  "product": "unlimited",
  "quantity": 30,
  "unit_price_usd": 8.41,
  "unit": "day",
  "total_usd": 252.3
}

Gumawa ng order

POST/api/v1/ordersKailangan ng API key

Kinukuha ang kabuuan sa balance mo at ginagawa ang order. Nagsisimula ang status bilang pending (ina-activate) at nagiging active kapag handa na ang order. Kapag hindi ito ma-activate, nagiging refunded ito at babalik sa balance mo ang buong halaga. Kapag kulang ang balance, 402 ang ibinabalik.

FieldIbig sabihin
productKailanganIsa sa unlimited, residential, isp, datacenter.
quantityKailanganAraw para sa unlimited (1~365), GB para sa residential (5~5,000), dami ng IP para sa isp (1~1,000) o datacenter (5~5,000).
concurrencyOpsyonalPara sa unlimited lang. Isa sa 200, 500, 1000, 2000.
bandwidthOpsyonalPara sa unlimited lang, sa Mbps. Isa sa 100, 200, 500, 1000.
monthsOpsyonalPara sa isp at datacenter lang. Isa sa 1, 3, 6, 12.
countryOpsyonalPara sa isp at datacenter lang. Dalawang-letrang country code gaya ng jp. Tingnan ang /countries para sa mga valid na value.
Request
curl -X POST https://starproxy.shop/api/v1/orders \
  -H "Authorization: Bearer spk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'
Response
{
  "order": {
    "id": "SP-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.41,
    "total_usd": 252.3,
    "status": "pending",
    "created_at": "2026-10-31T09:12:44.120Z",
    "updated_at": "2026-10-31T09:12:44.120Z"
  },
  "balance_usd": 1047.7
}

Listahan ng order

GET/api/v1/ordersKailangan ng API key

Ibinabalik ang hanggang 100 order, pinakabago muna.

FieldIbig sabihin
statusOpsyonalIsa sa pending, active, refunded. Iwanang blangko para sa lahat ng status.
Request
curl "https://starproxy.shop/api/v1/orders?status=pending" \
  -H "Authorization: Bearer spk_your_api_key"
Response
{
  "orders": [
    {
      "id": "SP-7KQ2M-X4HTD",
      "product": "unlimited",
      "quantity": 30,
      "months": null,
      "concurrency": 1000,
      "bandwidth_mbps": 200,
      "country": null,
      "unit_price_usd": 8.41,
      "total_usd": 252.3,
      "status": "pending",
      "created_at": "2026-10-31T09:12:44.120Z",
      "updated_at": "2026-10-31T09:12:44.120Z"
    }
  ]
}

Kunin ang isang order

GET/api/v1/orders/{id}Kailangan ng API key

Ibinabalik ang isang order ayon sa id. Gamitin ito para makita kung tapos na ang activation.

FieldIbig sabihin
idKailanganAng order id, halimbawa SP-7KQ2M-X4HTD.
Request
curl https://starproxy.shop/api/v1/orders/SP-7KQ2M-X4HTD \
  -H "Authorization: Bearer spk_your_api_key"
Response
{
  "order": {
    "id": "SP-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.41,
    "total_usd": 252.3,
    "status": "active",
    "created_at": "2026-10-31T09:12:44.120Z",
    "updated_at": "2026-10-31T09:40:02.511Z"
  }
}

Gumawa ng proxy username

GET/api/v1/proxy-userKailangan ng API key

Ibinabalik ang proxy username na kasama na ang mga opsyon mo, pati ang HTTP at SOCKS5 URL na handang i-paste. Kapag walang session, bagong IP ang bawat request.

FieldIbig sabihin
productOpsyonalIsa sa unlimited, residential, isp, datacenter. Unlimited ang default.
countryOpsyonalDalawang-letrang country code gaya ng jp.
cityOpsyonalCity value mula sa /countries, gaya ng tokyo. Kailangan kasama ang country.
sessionOpsyonal1~32 letra o numero. Iisang IP ang gamit ng mga request na may parehong session.
ttlOpsyonalIlang minuto hahawakan ang IP ng session, 1~60. 30 ang default.
Request
curl "https://starproxy.shop/api/v1/proxy-user?product=residential&country=jp&city=tokyo&session=job42&ttl=30" \
  -H "Authorization: Bearer spk_your_api_key"
Response
{
  "username": "spexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30",
  "password": "your_password",
  "http": "http://spexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.starproxy.shop:6100",
  "socks5": "socks5h://spexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.starproxy.shop:6200"
}

Buong halimbawa

Isang script na kumukuha ng quote, nag-o-order mula sa balance mo at kumokonekta sa pamamagitan ng Japanese IP.

Python (requests)
import requests

API = "https://starproxy.shop/api/v1"
HEAD = {"Authorization": "Bearer spk_your_api_key"}

# 1) Check the price first
plan = {"product": "residential", "quantity": 100}
print(requests.post(f"{API}/quote", json=plan).json())

# 2) Order from your balance
r = requests.post(f"{API}/orders", json=plan, headers=HEAD)
order = r.json()["order"]
print(order["id"], order["status"])

# 3) Get a username for Japanese IPs
u = requests.get(f"{API}/proxy-user", headers=HEAD,
                 params={"product": "residential", "country": "jp"}).json()
proxies = {"http": u["http"], "https": u["http"]}
print(requests.get("https://ipinfo.io/json", proxies=proxies, timeout=30).json())
Node.js 18+
const API = "https://starproxy.shop/api/v1";
const HEAD = { Authorization: "Bearer spk_your_api_key", "Content-Type": "application/json" };

// Check the balance
const acc = await fetch(`${API}/account`, { headers: HEAD }).then((r) => r.json());
console.log(acc.balance_usd);

// Order 7 days of unlimited
const res = await fetch(`${API}/orders`, {
  method: "POST",
  headers: HEAD,
  body: JSON.stringify({ product: "unlimited", quantity: 7, concurrency: 500, bandwidth: 100 }),
});
if (res.status === 402) console.log("Top up first");
else console.log((await res.json()).order.id);

Pinoproseso ang order sa API tulad ng order sa dashboard at lumalabas sa tab na History. Palitan ang spk_your_api_key sa mga halimbawa ng sarili mong key.

Gamitin ang StarProxy mismo mula sa code mo

Mag-sign up gamit ang username, gumawa ng API key sa dashboard at simulang tawagin ang API.