Langkau ke kandungan

Panduan API HiProxy

Apa yang anda lakukan dalam dashboard juga boleh dilakukan dari kod anda sendiri. Baca baki dan butiran sambungan, semak harga, pesan daripada baki dan bina nama pengguna proxy dengan pilihan, semuanya melalui REST API.

Bagaimana cara bermula?

  1. 1Daftar dengan nama pengguna dan log masuk ke dashboard.
  2. 2Jana kunci API pada tab Sambung. Kunci penuh hanya dipaparkan sekali, jadi simpan di tempat selamat dengan segera.
  3. 3Letakkan kunci dalam header Authorization bagi setiap permintaan yang memerlukannya.
  4. 4Panggil /account dahulu untuk memastikan kunci berfungsi, kemudian pesan dengan /orders.

Bagaimana pengesahan berfungsi?

Permintaan tentang akaun anda sendiri (account, orders, proxy-user) memerlukan kunci API. Hantar dalam header sebagai Authorization: Bearer hpk_... Harga, negara dan sebut harga terbuka kepada sesiapa sahaja dan tidak memerlukan kunci.

HiProxy hanya menyimpan hash kunci anda, bukan kunci itu sendiri. Jika anda kehilangannya, jana kunci baharu dalam dashboard dan kunci lama disekat pada saat itu juga. Simpan kunci dalam kod sebelah pelayan sahaja, jangan sekali-kali dalam kod yang berjalan di pelayar atau dalam repositori awam.

HTTP header
Authorization: Bearer hpk_your_api_key

URL asas dan format data

URL asas
https://hiproxy.shop/api/v1
Badan permintaan dan respons
application/json
Jumlah
USD sebagai nombor, cth. 1036.60
Cap masa
ISO 8601 (UTC)

Adakah terdapat had kadar?

Setiap kunci API boleh membuat sehingga 60 panggilan seminit. Endpoint awam yang dipanggil tanpa kunci membenarkan 60 panggilan seminit bagi setiap IP. Jika melebihi had, anda menerima HTTP 429. Tunggu seminit, kemudian hantar semula.

Bagaimanakah rupa respons ralat?

Anda menerima kod status HTTP serta badan JSON dengan kod ralat ringkas dan mesej.

Contoh
{
  "error": {
    "code": "insufficient_balance",
    "message": "Your balance is too low for this order. Top up in the dashboard."
  }
}
code
bad_requestHTTP 400Nilai yang diperlukan tiada, atau produk ini tidak menerima nilai tersebut.
unauthorizedHTTP 401Tiada kunci API dihantar, atau kunci salah.
insufficient_balanceHTTP 402Baki anda kurang daripada jumlah pesanan. Baki anda tidak diusik.
not_foundHTTP 404Akaun anda tiada pesanan dengan id ini.
rate_limitedHTTP 429Anda telah melebihi had permintaan seminit.
server_errorHTTP 500Pelayan tidak dapat menyelesaikan permintaan. Baki anda tidak diusik.

Endpoint

Baca akaun anda

GET/api/v1/accountPerlu kunci API

Memaparkan baki, host dan port proxy, nama pengguna dan kata laluan proxy, serta senarai IP Dibenarkan.

Permintaan
curl https://hiproxy.shop/api/v1/account \
  -H "Authorization: Bearer hpk_your_api_key"
Respons
{
  "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"
  ]
}

Baca produk dan harga

GET/api/v1/productsTanpa kunci

Memaparkan had pesanan setiap produk, harga bagi setiap peringkat dan potongan tempoh. Ia menggunakan jadual harga yang sama dengan halaman harga.

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

Senarai negara dan bandar

GET/api/v1/countriesTanpa kunci

Memaparkan negara yang disokong setiap produk dan nilai bandar untuk digunakan dalam pilihan nama pengguna -city-.

MedanMaksudnya
productPilihanSalah satu daripada unlimited, residential, isp, datacenter. Kosong bermaksud residential.
Permintaan
curl "https://hiproxy.shop/api/v1/countries?product=datacenter"
Respons
{
  "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"
        }
      ]
    }
  ]
}

Dapatkan sebut harga

POST/api/v1/quoteTanpa kunci

Mengira jumlah pesanan tanpa menyentuh baki anda. Hantar badan yang sama seperti semasa membuat pesanan.

MedanMaksudnya
productWajibSalah satu daripada unlimited, residential, isp, datacenter.
quantityWajibHari untuk unlimited (1~365), GB untuk residential (5~5,000), bilangan IP untuk isp (1~1,000) atau datacenter (5~5,000).
concurrencyPilihanUntuk unlimited sahaja. Pilih 200, 500, 1000 atau 2000.
bandwidthPilihanUntuk unlimited sahaja, dalam Mbps. Pilih 100, 200, 500 atau 1000.
monthsPilihanUntuk isp dan datacenter sahaja. Pilih 1, 3, 6 atau 12.
countryPilihanUntuk isp dan datacenter sahaja. Kod negara dua huruf seperti jp. Nilai yang sah disenaraikan dalam /countries.
Permintaan
curl -X POST https://hiproxy.shop/api/v1/quote \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'
Respons
{
  "product": "unlimited",
  "quantity": 30,
  "unit_price_usd": 8.78,
  "unit": "day",
  "total_usd": 263.4
}

Buat pesanan

POST/api/v1/ordersPerlu kunci API

Menolak jumlah daripada baki anda dan mencipta pesanan. Ia bermula sebagai pending (mengaktifkan) dan bertukar kepada active apabila sedia. Pesanan yang tidak dapat diaktifkan menjadi refunded, dan semua yang anda bayar dikembalikan ke baki anda. Jika baki tidak mencukupi, anda menerima 402.

MedanMaksudnya
productWajibSalah satu daripada unlimited, residential, isp, datacenter.
quantityWajibHari untuk unlimited (1~365), GB untuk residential (5~5,000), bilangan IP untuk isp (1~1,000) atau datacenter (5~5,000).
concurrencyPilihanUntuk unlimited sahaja. Pilih 200, 500, 1000 atau 2000.
bandwidthPilihanUntuk unlimited sahaja, dalam Mbps. Pilih 100, 200, 500 atau 1000.
monthsPilihanUntuk isp dan datacenter sahaja. Pilih 1, 3, 6 atau 12.
countryPilihanUntuk isp dan datacenter sahaja. Kod negara dua huruf seperti jp. Nilai yang sah disenaraikan dalam /countries.
Permintaan
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}'
Respons
{
  "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
}

Senarai pesanan

GET/api/v1/ordersPerlu kunci API

Memaparkan sehingga 100 pesanan anda, yang terbaharu dahulu.

MedanMaksudnya
statusPilihanSalah satu daripada pending, active, refunded. Kosong memaparkan pesanan dalam apa-apa status.
Permintaan
curl "https://hiproxy.shop/api/v1/orders?status=pending" \
  -H "Authorization: Bearer hpk_your_api_key"
Respons
{
  "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"
    }
  ]
}

Baca satu pesanan

GET/api/v1/orders/{id}Perlu kunci API

Memaparkan satu pesanan berdasarkan id. Berguna untuk menyemak sama ada pengaktifan sudah selesai.

MedanMaksudnya
idWajibId pesanan, seperti HP-7KQ2M-X4HTD.
Permintaan
curl https://hiproxy.shop/api/v1/orders/HP-7KQ2M-X4HTD \
  -H "Authorization: Bearer hpk_your_api_key"
Respons
{
  "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"
  }
}

Bina nama pengguna proxy

GET/api/v1/proxy-userPerlu kunci API

Memberi anda nama pengguna proxy yang mengandungi pilihan anda, serta URL HTTP dan SOCKS5 yang boleh terus ditampal. Tanpa session, IP bertukar pada setiap permintaan.

MedanMaksudnya
productPilihanSalah satu daripada unlimited, residential, isp, datacenter. Kosong bermaksud unlimited.
countryPilihanKod negara dua huruf seperti jp.
cityPilihanNilai bandar daripada /countries seperti tokyo. Hanya berfungsi bersama country.
sessionPilihan1~32 huruf atau nombor. Permintaan dengan session yang sama menggunakan IP yang sama.
ttlPilihanBerapa minit IP sesi dikekalkan, 1~60. Kosong bermaksud 30.
Permintaan
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"
Respons
{
  "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"
}

Contoh langkah demi langkah

Satu skrip yang menyemak harga, memesan daripada baki anda dan menyambung melalui IP Jepun.

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);

Pesanan yang dibuat melalui API dikendalikan sama seperti pesanan dashboard dan dipaparkan pada tab Sejarah. Gantikan hpk_your_api_key dalam contoh dengan kunci API anda sendiri.

Panggil HiProxy dari kod anda sendiri

Daftar dengan nama pengguna, jana kunci API dalam dashboard dan anda sudah sedia.