सामग्री पर जाएं
royalproxy
शुरू करें

प्रॉक्सी API डॉक्यूमेंटेशन

अपने कोड से बैलेंस और कनेक्शन जानकारी पढ़ने, कीमतें देखने, बैलेंस से ऑर्डर करने और प्रॉक्सी यूज़रनेम बनाने के लिए RoyalProxy REST API इस्तेमाल करें।

API कुंजी बनाएंएंडपॉइंट देखें

शुरू कैसे करें?

  1. 1साइन अप करें और डैशबोर्ड में लॉग इन करें।
  2. 2"कनेक्ट" खोलें और API कुंजी बनाएं। पूरी कुंजी सिर्फ़ एक बार दिखती है, इसलिए उसे किसी सुरक्षित जगह कॉपी कर लें।
  3. 3जिस भी अनुरोध में कुंजी चाहिए, उसके Authorization हेडर में कुंजी भेजें।
  4. 4कुंजी काम कर रही है या नहीं, यह जांचने के लिए /account कॉल करें, फिर /orders से ऑर्डर करें।

ऑथेंटिकेशन कैसे काम करता है?

आपके अपने अकाउंट से जुड़े अनुरोधों (account, orders, proxy-user) के लिए API कुंजी चाहिए। इसे Authorization हेडर में Bearer टोकन के रूप में भेजें। कीमतें, देश और अनुमान सार्वजनिक हैं, इनके लिए कुंजी नहीं चाहिए।

हम कुंजी का सिर्फ़ हैश रखते हैं। अगर कुंजी खो जाए, तो डैशबोर्ड में नई बनाएं, पुरानी कुंजी तुरंत काम करना बंद कर देगी। कुंजी को ब्राउज़र कोड और सार्वजनिक रिपॉज़िटरी से दूर रखें।

HTTP header
Authorization: Bearer rpk_your_api_key

बेस URL और फ़ॉर्मेट

बेस URL
https://royalproxy.online/api/v1
अनुरोध और जवाब की बॉडी
application/json
रकम
USD में संख्याएं, जैसे 807.90
समय
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."
  }
}
code
bad_requestHTTP 400कोई मान नहीं दिया गया या इस प्रोडक्ट के लिए अनुमत नहीं है।
unauthorizedHTTP 401API कुंजी नहीं दी गई या मान्य नहीं है।
insufficient_balanceHTTP 402बैलेंस ऑर्डर की कुल रकम से कम है। कोई शुल्क नहीं कटा।
not_foundHTTP 404आपके अकाउंट में इस id का कोई ऑर्डर नहीं है।
rate_limitedHTTP 429एक मिनट में बहुत ज़्यादा अनुरोध।
server_errorHTTP 500अनुरोध पूरा नहीं हो सका। कोई शुल्क नहीं कटा।

एंडपॉइंट

अपना अकाउंट देखें

GET/api/v1/accountAPI कुंजी

आपका बैलेंस, प्रॉक्सी होस्ट, पोर्ट, यूज़रनेम और पासवर्ड, और अनुमत IP लौटाता है।

अनुरोध
curl https://royalproxy.online/api/v1/account \
  -H "Authorization: Bearer rpk_your_api_key"
जवाब
{
  "username": "royal_user",
  "balance_usd": 1300,
  "proxy": {
    "host": "gate.royalproxy.online",
    "http_port": 6100,
    "socks5_port": 6200,
    "username": "rpexample1",
    "password": "your_password"
  },
  "allowed_ips": [
    "203.0.113.10"
  ]
}

प्रोडक्ट और कीमतों की सूची

GET/api/v1/productsकुंजी की ज़रूरत नहीं

हर प्रोडक्ट को उसकी सीमाओं, कीमत स्तरों और छूट के साथ लौटाता है। कीमतें उसी टेबल से आती हैं जो कीमतें पेज पर है।

अनुरोध
curl https://royalproxy.online/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कुंजी की ज़रूरत नहीं

किसी प्रोडक्ट के लिए उपलब्ध देश लौटाता है, साथ में शहरों के वे मान जो आप प्रॉक्सी यूज़रनेम में डाल सकते हैं।

फ़ील्डमतलब
productवैकल्पिकunlimited, residential, isp या datacenter। डिफ़ॉल्ट residential।
अनुरोध
curl "https://royalproxy.online/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ज़रूरीunlimited, residential, isp या datacenter।
quantityज़रूरीunlimited के लिए दिन (1~365), residential के लिए GB (5~5,000), isp के लिए IP (1~1,000) या datacenter के लिए IP (5~5,000)।
concurrencyवैकल्पिकसिर्फ़ unlimited: 200, 500, 1000 या 2000।
bandwidthवैकल्पिकसिर्फ़ unlimited, Mbps में: 100, 200, 500 या 1000।
monthsवैकल्पिकसिर्फ़ isp और datacenter: 1, 3, 6 या 12।
countryवैकल्पिकसिर्फ़ isp और datacenter: दो अक्षर का देश कोड, जैसे jp। /countries देखें।
अनुरोध
curl -X POST https://royalproxy.online/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.97,
  "unit": "day",
  "total_usd": 269.1
}

ऑर्डर करें

POST/api/v1/ordersAPI कुंजी

आपके बैलेंस से कुल रकम काटकर ऑर्डर बनाता है। नए ऑर्डर pending (सक्रिय हो रहा है) से शुरू होते हैं और तैयार होने पर active हो जाते हैं। अगर ऑर्डर सक्रिय नहीं हो पाता, तो वह refunded हो जाता है और पूरी रकम आपके बैलेंस में लौट आती है। बैलेंस कम होने पर 402 लौटाता है।

फ़ील्डमतलब
productज़रूरीunlimited, residential, isp या datacenter।
quantityज़रूरीunlimited के लिए दिन (1~365), residential के लिए GB (5~5,000), isp के लिए IP (1~1,000) या datacenter के लिए IP (5~5,000)।
concurrencyवैकल्पिकसिर्फ़ unlimited: 200, 500, 1000 या 2000।
bandwidthवैकल्पिकसिर्फ़ unlimited, Mbps में: 100, 200, 500 या 1000।
monthsवैकल्पिकसिर्फ़ isp और datacenter: 1, 3, 6 या 12।
countryवैकल्पिकसिर्फ़ isp और datacenter: दो अक्षर का देश कोड, जैसे jp। /countries देखें।
अनुरोध
curl -X POST https://royalproxy.online/api/v1/orders \
  -H "Authorization: Bearer rpk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'
जवाब
{
  "order": {
    "id": "RP-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.97,
    "total_usd": 269.1,
    "status": "pending",
    "created_at": "2026-10-31T09:12:44.120Z",
    "updated_at": "2026-10-31T09:12:44.120Z"
  },
  "balance_usd": 1030.9
}

अपने ऑर्डर की सूची

GET/api/v1/ordersAPI कुंजी

आपके सबसे नए 100 ऑर्डर लौटाता है, नए वाले पहले।

फ़ील्डमतलब
statusवैकल्पिकpending, active या refunded। सभी पाने के लिए इसे खाली छोड़ दें।
अनुरोध
curl "https://royalproxy.online/api/v1/orders?status=pending" \
  -H "Authorization: Bearer rpk_your_api_key"
जवाब
{
  "orders": [
    {
      "id": "RP-7KQ2M-X4HTD",
      "product": "unlimited",
      "quantity": 30,
      "months": null,
      "concurrency": 1000,
      "bandwidth_mbps": 200,
      "country": null,
      "unit_price_usd": 8.97,
      "total_usd": 269.1,
      "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 से एक ऑर्डर लौटाता है, जैसे यह देखने के लिए कि वह सक्रिय है या नहीं।

फ़ील्डमतलब
idज़रूरीऑर्डर id, जैसे RP-7KQ2M-X4HTD।
अनुरोध
curl https://royalproxy.online/api/v1/orders/RP-7KQ2M-X4HTD \
  -H "Authorization: Bearer rpk_your_api_key"
जवाब
{
  "order": {
    "id": "RP-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.97,
    "total_usd": 269.1,
    "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वैकल्पिकunlimited, residential, isp या datacenter। डिफ़ॉल्ट unlimited।
countryवैकल्पिकदो अक्षर का देश कोड, जैसे jp।
cityवैकल्पिक/countries से शहर का मान, जैसे tokyo। country ज़रूरी है।
sessionवैकल्पिक1~32 अक्षर या अंक। एक ही session वाले अनुरोध एक ही IP रखते हैं।
ttlवैकल्पिकसेशन IP कितने मिनट रखना है, 1~60। डिफ़ॉल्ट 30।
अनुरोध
curl "https://royalproxy.online/api/v1/proxy-user?product=residential&country=jp&city=tokyo&session=job42&ttl=30" \
  -H "Authorization: Bearer rpk_your_api_key"
जवाब
{
  "username": "rpexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30",
  "password": "your_password",
  "http": "http://rpexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.royalproxy.online:6100",
  "socks5": "socks5h://rpexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.royalproxy.online:6200"
}

पूरे उदाहरण

ये उदाहरण कीमत जांचते हैं, बैलेंस से ऑर्डर करते हैं और जापान के IP से कनेक्ट करते हैं।

Python (requests)
import requests

API = "https://royalproxy.online/api/v1"
HEAD = {"Authorization": "Bearer rpk_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://royalproxy.online/api/v1";
const HEAD = { Authorization: "Bearer rpk_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 से किए गए ऑर्डर डैशबोर्ड से किए गए ऑर्डर जैसे ही हैं और "इतिहास" में दिखते हैं। rpk_your_api_key की जगह अपनी कुंजी डालें।

RoyalProxy को अपने सिस्टम से जोड़ें

अकाउंट बनाएं, फिर डैशबोर्ड में API कुंजी बनाएं।

अकाउंट बनाएंसेटअप गाइड