API endpoint
endpoint API के एक ख़ास फ़ंक्शन का URL है: प्रोग्राम उसे एक तरह का डेटा लेने के लिए बुलाता है, जैसे Spot – Spot स्प्रेड या funding rate। डॉक्यूमेंटेशन endpoint को HTTP मेथड के साथ लिखता है: GET /arbitrage/spot-spot।
URL का विश्लेषण
curl request में URL https://api.genesisarbitrage.com/v1/arbitrage/spot-spot?min_spread=0.5:
BASE="https://api.genesisarbitrage.com/v1"
curl "$BASE/arbitrage/spot-spot?min_spread=0.5" \
-H "X-API-Key: $GENESIS_API_KEY"
| हिस्सा | मान |
|---|---|
| बेस URL | https://api.genesisarbitrage.com/v1: सर्वर और API का संस्करण |
| पाथ | /arbitrage/spot-spot: Spot — Spot डेटासेट |
| Query पैरामीटर | min_spread=0.5: 0.5% या उससे ज़्यादा स्प्रेड |
request 0.5% या उससे ज़्यादा स्प्रेड वाले सेटअप लौटाती है: कॉइन (coin), ख़रीद और बिक्री के एक्सचेंज (exchange_buy, exchange_sell), कीमतें, spread_pct और deposit व withdrawal फ़्लैग। endpoint के बाक़ी पैरामीटर, coin, exchange और min_volume, Spot — Spot सेक्शन में सूचीबद्ध हैं।
Path पैरामीटर और query पैरामीटर
Path पैरामीटर URL का ही हिस्सा है; डॉक्यूमेंटेशन उसे curly braces में दिखाता है। /orderbooks/coin/{coin} में {coin} की जगह टिकर लिखते हैं: /orderbooks/coin/BTC हर एक्सचेंज और बाज़ार पर BTC के order book लौटाता है (Coin order books)।
Query पैरामीटर ? के बाद name=value जोड़ों में आते हैं, जिन्हें & अलग करता है। एक URL में दोनों तरह के पैरामीटर हो सकते हैं: /orderbooks/spreads/spot-futures?coin=BTC&volume=5000 में spot-futures डेटासेट पाथ में है, जबकि कॉइन और $5,000 की मात्रा query पैरामीटर हैं (Order-book Δ)।
कॉल करते समय त्रुटियाँ
| जवाब | कारण |
|---|---|
404 not_found | ऐसा endpoint या resource नहीं है |
400 bad_request | ग़लत पैरामीटर, विवरण message में |
403 plan_restricted | endpoint आपके प्लान में नहीं है |
410 gone | endpoint हटा दिया गया है, उसका विकल्प message में है |
35+ endpoint की पूरी सूची डॉक्यूमेंटेशन में और मशीन-पठनीय OpenAPI स्पेसिफ़िकेशन में है।
यह भी देखें: REST API, JSON, आर्बिट्राज endpoint, order book endpoint।
सवाल और जवाब
endpoint और API में क्या फ़र्क़ है?
API किसी सर्विस के सारे फ़ंक्शन का पूरा सेट है; endpoint एक फ़ंक्शन है जिसका अपना URL है। Genesis API में ऐसे 35 से ज़्यादा हैं: आर्बिट्राज, order book, funding, बाज़ार, ऑन-चेन, प्रेडिक्शन मार्केट, AI सिग्नल और कॉइन सर्च।