नए हैं? ये कदम अपनाएं
- 1ईमेल और पासवर्ड से, या टोकन से साइन अप करें और डैशबोर्ड खोलें।
- 2"कनेक्ट" टैब पर API कुंजी जारी करें। पूरी कुंजी सिर्फ़ एक बार, जारी करते समय दिखती है, इसलिए उसे वहीं सेव कर लें।
- 3जिस भी अनुरोध में कुंजी चाहिए, उसके Authorization हेडर में कुंजी डालें।
- 4कुंजी स्वीकार हो रही है यह पक्का करने के लिए पहले /account को कॉल करें, फिर /orders से ऑर्डर करें।
ऑथेंटिकेशन कैसे काम करता है?
जो अनुरोध आपके अपने अकाउंट से जुड़े हैं (account, orders, proxy-user), उनके लिए API कुंजी चाहिए। इसे हेडर में Authorization: Bearer pwk_... के रूप में भेजें। कीमतें, देश और अनुमान सबके लिए खुले हैं और बिना कुंजी के कॉल किए जा सकते हैं।
ProxyWorld सर्वर कुंजी को कभी स्टोर नहीं करते, सिर्फ़ उसका हैश रखते हैं। अगर कुंजी खो जाए, तो डैशबोर्ड में नई बनाएं, पुरानी तुरंत ब्लॉक हो जाती है। कुंजी सिर्फ़ सर्वर साइड कोड में रखें। अगर कुंजी ब्राउज़र में चलने वाले कोड या किसी पब्लिक रिपॉज़िटरी में पहुंच जाए, तो कोई और उसका इस्तेमाल कर सकता है।
Authorization: Bearer pwk_your_api_key
बेस URL और डेटा फ़ॉर्मैट
- बेस URL
- https://proxyworld.shop/api/v1
- अनुरोध और जवाब की बॉडी
- application/json
- रकम
- USD संख्या के रूप में, जैसे 1058.50
- टाइमस्टैम्प
- ISO 8601 (UTC)
मैं कितने कॉल कर सकता हूं?
हर API कुंजी से प्रति मिनट 60 कॉल किए जा सकते हैं। बिना कुंजी के कॉल किए जाने वाले पब्लिक एंडपॉइंट पर हर IP से प्रति मिनट 60 कॉल की अनुमति है। इससे ज़्यादा होने पर HTTP 429 मिलता है। लगभग एक मिनट रुकें, फिर कोशिश करें।
कुछ गलत होने पर क्या वापस आता है?
आपको एक HTTP स्टेटस कोड और एक JSON बॉडी मिलती है, जिसमें छोटा एरर कोड और उसका कारण होता है।
{
"error": {
"code": "insufficient_balance",
"message": "Your balance is too low for this order. Top up in the dashboard."
}
}| HTTP | code | मतलब |
|---|---|---|
| bad_requestHTTP 400कोई ज़रूरी मान नहीं भेजा गया, या ऐसा मान भेजा गया जो यह प्रोडक्ट स्वीकार नहीं करता। | कोई ज़रूरी मान नहीं भेजा गया, या ऐसा मान भेजा गया जो यह प्रोडक्ट स्वीकार नहीं करता। | |
| unauthorizedHTTP 401API कुंजी नहीं है या वह मान्य कुंजी नहीं है। | API कुंजी नहीं है या वह मान्य कुंजी नहीं है। | |
| insufficient_balanceHTTP 402आपका बैलेंस ऑर्डर की कुल रकम से कम है। आपके बैलेंस से कोई पैसा नहीं कटा। | आपका बैलेंस ऑर्डर की कुल रकम से कम है। आपके बैलेंस से कोई पैसा नहीं कटा। | |
| not_foundHTTP 404आपके अकाउंट में इस नंबर का कोई ऑर्डर नहीं है। | आपके अकाउंट में इस नंबर का कोई ऑर्डर नहीं है। | |
| rate_limitedHTTP 429आपने प्रति मिनट अनुमत कॉल की संख्या पार कर ली है। | आपने प्रति मिनट अनुमत कॉल की संख्या पार कर ली है। | |
| server_errorHTTP 500सर्वर अनुरोध पूरा नहीं कर सका। आपके बैलेंस से कोई पैसा नहीं कटा। | सर्वर अनुरोध पूरा नहीं कर सका। आपके बैलेंस से कोई पैसा नहीं कटा। |
एंडपॉइंट
अपना अकाउंट देखें
GET/api/v1/accountAPI कुंजी ज़रूरी
बताता है कि आप कैसे साइन इन करते हैं (login: email या token), आपका ईमेल, बैलेंस, प्रॉक्सी होस्ट और पोर्ट, प्रॉक्सी यूज़रनेम और पासवर्ड, और अनुमत IP। टोकन से बने अकाउंट के लिए email null होता है।
curl https://proxyworld.shop/api/v1/account \ -H "Authorization: Bearer pwk_your_api_key"
{
"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"
]
}प्रोडक्ट और कीमतें देखें
GET/api/v1/productsबिना कुंजी के काम करता है
हर प्रोडक्ट के लिए ऑर्डर की सीमा, हर मात्रा स्तर की यूनिट कीमत और अवधि छूट बताता है। यह वही कीमत टेबल इस्तेमाल करता है जो कीमतों वाले पेज पर है।
curl https://proxyworld.shop/api/v1/products
{
"currency": "USD",
"prices_as_of": "2026-10-31",
"products": [
{
"id": "unlimited",
"unit": "day",
"quantity": {
"meaning": "days",
"min": 1,
"max": 365
},
"...": "..."
},
{
"id": "residential",
"unit": "gb",
"...": "..."
}
]
}देश और शहर
GET/api/v1/countriesबिना कुंजी के काम करता है
हर प्रोडक्ट के लिए चुने जा सकने वाले देश बताता है, साथ में -city- यूज़रनेम विकल्प में इस्तेमाल होने वाले शहर के मान भी।
| नाम | प्रकार | मतलब |
|---|---|---|
productवैकल्पिक | string | unlimited, residential, isp, datacenter में से एक। न देने पर residential लिया जाता है। |
curl "https://proxyworld.shop/api/v1/countries?product=datacenter"
{
"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"
}
]
}
]
}कीमत का अनुमान पाएं
POST/api/v1/quoteबिना कुंजी के काम करता है
आपके बैलेंस को छुए बिना ऑर्डर की कुल रकम निकालता है। वही बॉडी भेजें जो आप ऑर्डर करते समय भेजते।
| नाम | प्रकार | मतलब |
|---|---|---|
productज़रूरी | string | unlimited, residential, isp, datacenter में से एक। |
quantityज़रूरी | integer | कितना ऑर्डर करना है: unlimited के लिए दिन (1~365), residential के लिए GB (5~5,000), isp (1~1,000) या datacenter (5~5,000) के लिए IP की संख्या। |
concurrencyवैकल्पिक | integer | सिर्फ़ unlimited के लिए। 200, 500, 1000, 2000 में से एक चुनें। |
bandwidthवैकल्पिक | integer | सिर्फ़ unlimited के लिए, Mbps में। 100, 200, 500, 1000 में से एक। |
monthsवैकल्पिक | integer | सिर्फ़ isp और datacenter के लिए। 1, 3, 6, 12 में से एक। |
countryवैकल्पिक | string | सिर्फ़ isp और datacenter के लिए। दो अक्षर का देश कोड, जैसे jp। स्वीकार किए जाने वाले मान /countries में दिए गए हैं। |
curl -X POST https://proxyworld.shop/api/v1/quote \
-H "Content-Type: application/json" \
-d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'{
"product": "unlimited",
"quantity": 30,
"unit_price_usd": 8.05,
"unit": "day",
"total_usd": 241.5
}ऑर्डर करें
POST/api/v1/ordersAPI कुंजी ज़रूरी
आपके बैलेंस से कुल रकम काटता है और ऑर्डर बनाता है। यह pending (सक्रिय हो रहा है) से शुरू होता है और तैयार होने पर active हो जाता है। जो ऑर्डर सक्रिय नहीं हो पाता, वह refunded हो जाता है, और आपकी चुकाई पूरी रकम बैलेंस में वापस आ जाती है। बैलेंस कम होने पर 402 मिलता है।
| नाम | प्रकार | मतलब |
|---|---|---|
productज़रूरी | string | unlimited, residential, isp, datacenter में से एक। |
quantityज़रूरी | integer | कितना ऑर्डर करना है: unlimited के लिए दिन (1~365), residential के लिए GB (5~5,000), isp (1~1,000) या datacenter (5~5,000) के लिए IP की संख्या। |
concurrencyवैकल्पिक | integer | सिर्फ़ unlimited के लिए। 200, 500, 1000, 2000 में से एक चुनें। |
bandwidthवैकल्पिक | integer | सिर्फ़ unlimited के लिए, Mbps में। 100, 200, 500, 1000 में से एक। |
monthsवैकल्पिक | integer | सिर्फ़ isp और datacenter के लिए। 1, 3, 6, 12 में से एक। |
countryवैकल्पिक | string | सिर्फ़ isp और datacenter के लिए। दो अक्षर का देश कोड, जैसे jp। स्वीकार किए जाने वाले मान /countries में दिए गए हैं। |
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}'{
"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
}अपने ऑर्डर देखें
GET/api/v1/ordersAPI कुंजी ज़रूरी
सबसे नए से शुरू करके 100 ऑर्डर तक दिखाता है।
| नाम | प्रकार | मतलब |
|---|---|---|
statusवैकल्पिक | string | pending, active, refunded में से एक। किसी भी स्थिति के ऑर्डर पाने के लिए इसे छोड़ दें। |
curl "https://proxyworld.shop/api/v1/orders?status=pending" \ -H "Authorization: Bearer pwk_your_api_key"
{
"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"
}
]
}एक ऑर्डर देखें
GET/api/v1/orders/{id}API कुंजी ज़रूरी
ऑर्डर नंबर से मेल खाने वाला ऑर्डर बताता है। सक्रियण पूरा हुआ या नहीं, यह जांचने में काम आता है।
| नाम | प्रकार | मतलब |
|---|---|---|
idज़रूरी | string | ऑर्डर नंबर, जैसे PW-7KQ2M-X4HTD। |
curl https://proxyworld.shop/api/v1/orders/PW-7KQ2M-X4HTD \ -H "Authorization: Bearer pwk_your_api_key"
{
"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"
}
}प्रॉक्सी यूज़रनेम बनाएं
GET/api/v1/proxy-userAPI कुंजी ज़रूरी
आपके विकल्पों के साथ प्रॉक्सी यूज़रनेम देता है, साथ में HTTP और SOCKS5 URL जिन्हें आप सीधे पेस्ट कर सकते हैं। अगर आप session नहीं भेजते, तो हर अनुरोध पर IP बदलता है।
| नाम | प्रकार | मतलब |
|---|---|---|
productवैकल्पिक | string | unlimited, residential, isp, datacenter में से एक। न देने पर unlimited लिया जाता है। |
countryवैकल्पिक | string | दो अक्षर का देश कोड, जैसे jp। |
cityवैकल्पिक | string | /countries में दिया गया शहर का मान, जैसे tokyo। इसके साथ country भी भेजें। |
sessionवैकल्पिक | string | 1~32 अक्षर और अंक। एक ही session वाले अनुरोध एक ही IP इस्तेमाल करते हैं। |
ttlवैकल्पिक | integer | सेशन कितनी देर तक अपना IP रखे, 1~60 मिनट। न देने पर 30 मिनट। |
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"
{
"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"
}शुरू से अंत तक उदाहरण
एक ही स्क्रिप्ट जो अनुमान लेती है, बैलेंस से ऑर्डर करती है और फिर जापान के IP से कनेक्ट होती है।
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())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);API से किए गए ऑर्डर डैशबोर्ड के ऑर्डर की तरह ही संभाले जाते हैं और बाकी ऑर्डर के साथ "इतिहास" टैब पर दिखते हैं। उदाहरणों में pwk_your_api_key की जगह अपनी API कुंजी डालें।