Lumaktaw sa nilalaman

HiProxy API guide

Ang ginagawa mo sa dashboard ay magagawa mo rin mula sa sarili mong code. Basahin ang balance at connection details, i-check ang presyo, mag-order mula sa balance at gumawa ng proxy username na may mga opsyon, lahat sa REST API.

Paano magsimula?

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

Paano gumagana ang authentication?

Kailangan ng API key ang mga request tungkol sa sarili mong account (account, orders, proxy-user). Ipadala ito sa header bilang Authorization: Bearer hpk_... Bukas sa lahat ang presyo, mga bansa at quote at hindi kailangan ng key.

Hash lang ng key mo ang iniimbak ng HiProxy, hindi ang mismong key. Kapag nawala ito, gumawa ng bago sa dashboard at agad na mabo-block ang lumang key. Ilagay lang ang key sa server-side code, hindi sa code na tumatakbo sa browser o sa pampublikong repository.

HTTP header
Authorization: Bearer hpk_your_api_key

Base URL at format ng data

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

May rate limit ba?

Bawat API key ay puwedeng gumawa ng hanggang 60 call kada minuto. Ang mga public endpoint na tinawag nang walang key ay 60 call kada minuto kada IP. Kapag lumampas sa limit, HTTP 429 ang makukuha mo. Maghintay ng isang minuto, tapos ipadala ulit.

Ano ang itsura ng error response?

Makakakuha ka ng HTTP status code at 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 tinatanggap ng produktong ito ang value.
unauthorizedHTTP 401Walang naipadalang API key, o mali ang key.
insufficient_balanceHTTP 402Mas mababa ang balance mo kaysa sa kabuuan ng order. Hindi ginalaw ang balance mo.
not_foundHTTP 404Walang order sa account mo na may ganitong id.
rate_limitedHTTP 429Lumampas ka sa limit ng request kada minuto.
server_errorHTTP 500Hindi natapos ng server ang request. Hindi ginalaw ang balance mo.

Mga endpoint

Basahin ang account mo

GET/api/v1/accountKailangan ng API key

Ipinapakita ang balance mo, proxy host at mga port, proxy username at password, at ang listahan ng Allowed IPs.

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

Basahin ang mga produkto at presyo

GET/api/v1/productsWalang key

Ipinapakita ang order limit ng bawat produkto, presyo kada tier at period discount. Pareho ang price table nito sa pricing page.

Request
curl https://hiproxy.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/countriesWalang key

Ipinapakita ang mga bansang sinusuportahan ng bawat produkto at ang mga city value na gagamitin sa -city- na opsyon sa username.

FieldIbig sabihin
productOpsyonalIsa sa unlimited, residential, isp, datacenter. Kapag walang laman, residential.
Request
curl "https://hiproxy.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/quoteWalang key

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

FieldIbig sabihin
productKailanganIsa sa unlimited, residential, isp, datacenter.
quantityKailanganAraw para sa unlimited (1~365), GB para sa residential (5~5,000), bilang ng IP para sa isp (1~1,000) o datacenter (5~5,000).
concurrencyOpsyonalPara sa unlimited lang. Pumili ng 200, 500, 1000 o 2000.
bandwidthOpsyonalPara sa unlimited lang, sa Mbps. Pumili ng 100, 200, 500 o 1000.
monthsOpsyonalPara sa isp at datacenter lang. Pumili ng 1, 3, 6 o 12.
countryOpsyonalPara sa isp at datacenter lang. Dalawang-letrang country code gaya ng jp. Nakalista sa /countries ang mga valid na value.
Request
curl -X POST https://hiproxy.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.78,
  "unit": "day",
  "total_usd": 263.4
}

Mag-order

POST/api/v1/ordersKailangan ng API key

Ibinabawas ang kabuuan sa balance mo at ginagawa ang order. Nagsisimula ito bilang pending (activating) at nagiging active kapag handa na. Ang order na hindi ma-activate ay nagiging refunded, at babalik sa balance mo ang lahat ng binayad mo. Kung kulang ang balance mo, 402 ang makukuha mo.

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

Listahan ng order

GET/api/v1/ordersKailangan ng API key

Ipinapakita ang hanggang 100 sa mga order mo, pinakabago muna.

FieldIbig sabihin
statusOpsyonalIsa sa pending, active, refunded. Kapag walang laman, ibinabalik ang mga order sa kahit anong status.
Request
curl "https://hiproxy.shop/api/v1/orders?status=pending" \
  -H "Authorization: Bearer hpk_your_api_key"
Response
{
  "orders": [
    {
      "id": "HP-7KQ2M-X4HTD",
      "product": "unlimited",
      "quantity": 30,
      "months": null,
      "concurrency": 1000,
      "bandwidth_mbps": 200,
      "country": null,
      "unit_price_usd": 8.78,
      "total_usd": 263.4,
      "status": "pending",
      "created_at": "2026-10-31T09:12:44.120Z",
      "updated_at": "2026-10-31T09:12:44.120Z"
    }
  ]
}

Basahin ang isang order

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

Ipinapakita ang isang order ayon sa id nito. Kapaki-pakinabang para malaman kung tapos na ang activation.

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

Bumuo ng proxy username

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

Nagbibigay ng proxy username na may mga opsyon mo, pati HTTP at SOCKS5 URL na puwede mong i-paste agad. Kapag walang session, nagbabago ang IP sa bawat request.

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

Halimbawa, hakbang-hakbang

Isang script na nagche-check ng presyo, nag-o-order mula sa balance mo at kumokonekta sa IP sa Japan.

Python (requests)
import requests

API = "https://hiproxy.shop/api/v1"
HEAD = {"Authorization": "Bearer hpk_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://hiproxy.shop/api/v1";
const HEAD = { Authorization: "Bearer hpk_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);

Ang mga order sa API ay inaasikaso nang pareho sa mga order sa dashboard at lumalabas sa History tab. Palitan ang hpk_your_api_key sa mga halimbawa ng sarili mong API key.

Tawagin ang HiProxy mula sa sarili mong code

Mag-sign up gamit ang username, gumawa ng API key sa dashboard at handa ka na.