ProxyWorld API Guide: Account, Order, Proxy Username

Bago ka rito? Sundin ang mga hakbang na ito

1Mag-sign up gamit ang email at password, o gamit ang token, at buksan ang dashboard.
2Gumawa ng API key sa tab na Connect. Isang beses lang lalabas ang buong key, sa mismong oras na ginawa mo ito, kaya i-save ito agad doon.
3Ilagay ang key sa Authorization header ng bawat request na nangangailangan nito.
4Tawagin muna ang /account para matiyak na tinatanggap ang key, tapos mag-order gamit ang /orders.

Paano gumagana ang authentication?

Kailangan ng API key ang mga request na tungkol sa sarili mong account (account, orders, proxy-user). Ipadala ito sa header bilang Authorization: Bearer pwk_... Bukas sa lahat ang presyo, bansa at quote at puwedeng tawagin nang walang key.

Hindi kailanman sine-save ng mga server ng ProxyWorld ang key mismo, hash lang nito. Kapag nawala ang key, gumawa ng bago sa dashboard, at agad mabo-block ang luma. Ilagay lang ang key sa server side code. Kapag napunta ang key sa code na tumatakbo sa browser o sa public repository, puwede itong gamitin ng iba.

HTTP header

Authorization: Bearer pwk_your_api_key

Base URL at format ng data

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

Ilang tawag ang puwede kong gawin?

Bawat API key ay puwedeng tumawag nang 60 beses kada minuto. Ang mga public endpoint na tinatawag nang walang key ay 60 tawag kada minuto sa bawat IP. Kapag lumampas ka, makakatanggap ka ng HTTP 429. Maghintay nang mga isang minuto at subukan ulit.

Ano ang ibinabalik kapag may pumalya?

Makakatanggap ka ng HTTP status code at JSON body na may maikling error code at paliwanag.

Halimbawa

{
  "error": {
    "code": "insufficient_balance",
    "message": "Your balance is too low for this order. Top up in the dashboard."
  }
}

HTTP	code	Ibig sabihin
400	bad_requestHTTP 400May kulang na kailangang value, o may ipinadalang value na hindi tinatanggap ng produktong ito.	May kulang na kailangang value, o may ipinadalang value na hindi tinatanggap ng produktong ito.
401	unauthorizedHTTP 401Walang API key o hindi ito valid na key.	Walang API key o hindi ito valid na key.
402	insufficient_balanceHTTP 402Mas maliit ang balance mo kaysa sa kabuuan ng order. Walang nabawas sa balance mo.	Mas maliit ang balance mo kaysa sa kabuuan ng order. Walang nabawas sa balance mo.
404	not_foundHTTP 404Walang order na may ganitong numero sa account mo.	Walang order na may ganitong numero sa account mo.
429	rate_limitedHTTP 429Lumampas ka sa bilang ng tawag na pinapayagan kada minuto.	Lumampas ka sa bilang ng tawag na pinapayagan kada minuto.
500	server_errorHTTP 500Hindi natapos ng server ang request. Walang nabawas sa balance mo.	Hindi natapos ng server ang request. Walang nabawas sa balance mo.

Mga endpoint

Tingnan ang account mo

GET/api/v1/accountKailangan ng API key

Ibinabalik kung paano ka nagla-log in (login: email o token), ang email mo, balance, proxy host at port, proxy username at password, at mga Allowed IP. Sa mga account na ginawa gamit ang token, null ang email.

Request

curl https://proxyworld.shop/api/v1/account \
  -H "Authorization: Bearer pwk_your_api_key"

Response

{
  "login": "email",
  "email": "you@example.com",
  "balance_usd": 1300,
  "proxy": {
    "host": "gate.proxyworld.shop",
    "http_port": 6100,
    "socks5_port": 6200,
    "username": "pwexample1",
    "password": "your_password"
  },
  "allowed_ips": [
    "203.0.113.10"
  ]
}

Tingnan ang mga produkto at presyo

GET/api/v1/productsGumagana nang walang key

Ibinabalik ang saklaw ng order sa bawat produkto, ang presyo bawat unit sa bawat antas ng dami at ang mga discount sa tagal. Parehong price table ang gamit nito sa pricing page.

Request

curl https://proxyworld.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",
      "...": "..."
    }
  ]
}

Bansa at lungsod

GET/api/v1/countriesGumagana nang walang key

Ibinabalik ang mga bansang mapipili sa bawat produkto, kasama ang mga city value na gagamitin sa -city- na opsyon sa username.

Pangalan	Uri	Ibig sabihin
`product`Opsyonal	string	Isa sa unlimited, residential, isp, datacenter. Kapag wala, residential ang gagamitin.

Request

curl "https://proxyworld.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/quoteGumagana nang walang key

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

Pangalan	Uri	Ibig sabihin
`product`Kailangan	string	Isa sa unlimited, residential, isp, datacenter.
`quantity`Kailangan	integer	Gaano karami ang ioorder: araw 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).
`concurrency`Opsyonal	integer	Para sa unlimited lang. Pumili ng isa sa 200, 500, 1000, 2000.
`bandwidth`Opsyonal	integer	Para sa unlimited lang, sa Mbps. Isa sa 100, 200, 500, 1000.
`months`Opsyonal	integer	Para sa isp at datacenter lang. Isa sa 1, 3, 6, 12.
`country`Opsyonal	string	Para sa isp at datacenter lang. Dalawang-letrang country code gaya ng jp. Nakalista sa /countries ang mga tinatanggap na value.

Request

curl -X POST https://proxyworld.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.05,
  "unit": "day",
  "total_usd": 241.5
}

Mag-order

POST/api/v1/ordersKailangan ng API key

Ibinabawas ang kabuuan sa balance mo at ginagawa ang order. Nagsisimula ito bilang pending (ina-activate) at nagiging active kapag handa na. Ang order na hindi ma-activate ay nagiging refunded, at ibabalik sa balance mo ang lahat ng ibinayad mo. Kapag kulang ang balance, makakatanggap ka ng 402.

Pangalan	Uri	Ibig sabihin
`product`Kailangan	string	Isa sa unlimited, residential, isp, datacenter.
`quantity`Kailangan	integer	Gaano karami ang ioorder: araw 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).
`concurrency`Opsyonal	integer	Para sa unlimited lang. Pumili ng isa sa 200, 500, 1000, 2000.
`bandwidth`Opsyonal	integer	Para sa unlimited lang, sa Mbps. Isa sa 100, 200, 500, 1000.
`months`Opsyonal	integer	Para sa isp at datacenter lang. Isa sa 1, 3, 6, 12.
`country`Opsyonal	string	Para sa isp at datacenter lang. Dalawang-letrang country code gaya ng jp. Nakalista sa /countries ang mga tinatanggap na value.

Request

curl -X POST https://proxyworld.shop/api/v1/orders \
  -H "Authorization: Bearer pwk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'

Response

{
  "order": {
    "id": "PW-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.05,
    "total_usd": 241.5,
    "status": "pending",
    "created_at": "2026-10-31T09:12:44.120Z",
    "updated_at": "2026-10-31T09:12:44.120Z"
  },
  "balance_usd": 1058.5
}

Tingnan ang mga order mo

GET/api/v1/ordersKailangan ng API key

Ipinapakita ang hanggang 100 order, simula sa pinakabago.

Pangalan	Uri	Ibig sabihin
`status`Opsyonal	string	Isa sa pending, active, refunded. Huwag ilagay para makuha ang mga order sa kahit anong status.

Request

curl "https://proxyworld.shop/api/v1/orders?status=pending" \
  -H "Authorization: Bearer pwk_your_api_key"

Response

{
  "orders": [
    {
      "id": "PW-7KQ2M-X4HTD",
      "product": "unlimited",
      "quantity": 30,
      "months": null,
      "concurrency": 1000,
      "bandwidth_mbps": 200,
      "country": null,
      "unit_price_usd": 8.05,
      "total_usd": 241.5,
      "status": "pending",
      "created_at": "2026-10-31T09:12:44.120Z",
      "updated_at": "2026-10-31T09:12:44.120Z"
    }
  ]
}

Tingnan ang isang order

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

Ibinabalik ang order na tugma sa order number. Magagamit para tingnan kung tapos na ang activation.

Pangalan	Uri	Ibig sabihin
`id`Kailangan	string	Ang order number, halimbawa PW-7KQ2M-X4HTD.

Request

curl https://proxyworld.shop/api/v1/orders/PW-7KQ2M-X4HTD \
  -H "Authorization: Bearer pwk_your_api_key"

Response

{
  "order": {
    "id": "PW-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.05,
    "total_usd": 241.5,
    "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

Ibinabalik ang proxy username na may mga opsyon mo, kasama ang HTTP at SOCKS5 URL na puwedeng i-paste nang diretso. Kapag hindi ka nagpadala ng session, nagbabago ang IP sa bawat request.

Pangalan	Uri	Ibig sabihin
`product`Opsyonal	string	Isa sa unlimited, residential, isp, datacenter. Kapag wala, unlimited ang gagamitin.
`country`Opsyonal	string	Dalawang-letrang country code, halimbawa jp.
`city`Opsyonal	string	City value na nakalista sa /countries, halimbawa tokyo. Ipadala kasama ang country.
`session`Opsyonal	string	1~32 letra at numero. Pareho ang IP ng mga request na may parehong session.
`ttl`Opsyonal	integer	Gaano katagal hawak ng session ang IP nito, 1~60 minuto. Kapag wala, 30 minuto.

Request

curl "https://proxyworld.shop/api/v1/proxy-user?product=residential&country=jp&city=tokyo&session=job42&ttl=30" \
  -H "Authorization: Bearer pwk_your_api_key"

Response

{
  "username": "pwexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30",
  "password": "your_password",
  "http": "http://pwexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.proxyworld.shop:6100",
  "socks5": "socks5h://pwexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.proxyworld.shop:6200"
}

Buong halimbawa

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

Python (requests)

import requests

API = "https://proxyworld.shop/api/v1"
HEAD = {"Authorization": "Bearer pwk_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://proxyworld.shop/api/v1";
const HEAD = { Authorization: "Bearer pwk_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 pinoproseso tulad ng order sa dashboard at lumalabas sa tab na History kasama ng iba. Palitan ang pwk_your_api_key sa mga halimbawa ng sarili mong API key.

ProxyWorld API

Bago ka rito? Sundin ang mga hakbang na ito

Paano gumagana ang authentication?

Base URL at format ng data

Ilang tawag ang puwede kong gawin?

Ano ang ibinabalik kapag may pumalya?

Tingnan ang account mo

Tingnan ang mga produkto at presyo

Bansa at lungsod

Kumuha ng quote

Mag-order

Tingnan ang mga order mo

Tingnan ang isang order

Bumuo ng proxy username

Buong halimbawa

Ikonekta ang ProxyWorld sa code mo