نقطة نهاية API (endpoint)
نقطة النهاية (endpoint) هي رابط وظيفة محددة في API: يستدعيها البرنامج ليحصل على نوع واحد من البيانات، مثل سبريدات Spot – Spot أو معدلات التمويل. يسرد التوثيق نقطة النهاية مع طريقة HTTP: GET /arbitrage/spot-spot.
تفصيل الرابط
الرابط https://api.genesisarbitrage.com/v1/arbitrage/spot-spot?min_spread=0.5 في طلب curl:
BASE="https://api.genesisarbitrage.com/v1"
curl "$BASE/arbitrage/spot-spot?min_spread=0.5" \
-H "X-API-Key: $GENESIS_API_KEY"
| الجزء | القيمة |
|---|---|
| الرابط الأساسي | https://api.genesisarbitrage.com/v1: الخادم وإصدار API |
| المسار | /arbitrage/spot-spot: مجموعة بيانات Spot — Spot |
| معامل الاستعلام | min_spread=0.5: سبريد 0.5% أو أكثر |
يعيد الطلب الفرص التي سبريدها 0.5% أو أكثر: العملة (coin) وبورصتا الشراء والبيع (exchange_buy وexchange_sell) والأسعار وspread_pct وعلامات الإيداع والسحب. باقي معاملات نقطة النهاية، coin وexchange وmin_volume، مسرودة في قسم Spot — Spot.
معاملات المسار ومعاملات الاستعلام
معامل المسار جزء من الرابط نفسه، ويعرضه التوثيق بين أقواس معقوفة. في /orderbooks/coin/{coin} تستبدل {coin} برمز العملة: /orderbooks/coin/BTC يعيد دفاتر أوامر BTC في كل بورصة وسوق (دفاتر أوامر العملة).
معاملات الاستعلام تلي ? على شكل أزواج name=value تفصل بينها &. يمكن أن يحمل رابط واحد النوعين: في /orderbooks/spreads/spot-futures?coin=BTC&volume=5000 تقع مجموعة spot-futures في المسار، بينما العملة وحجم 5,000 دولار معاملا استعلام (Δ دفتر الأوامر).
الأخطاء عند الاستدعاء
| الاستجابة | السبب |
|---|---|
404 not_found | لا توجد نقطة نهاية أو مورد بهذا الاسم |
400 bad_request | معاملات غير صالحة، والتفاصيل في message |
403 plan_restricted | نقطة النهاية ليست ضمن خطتك |
410 gone | نقطة النهاية مُلغاة، وبديلها في message |
القائمة الكاملة لأكثر من 35 نقطة نهاية في التوثيق وفي مواصفة OpenAPI المقروءة آليًا.
انظر أيضًا: REST API، JSON، نقاط نهاية المراجحة، نقاط نهاية دفتر الأوامر.
أسئلة وأجوبة
ما الفرق بين نقطة النهاية وAPI؟
API هو المجموعة الكاملة لوظائف الخدمة، ونقطة النهاية وظيفة واحدة لها رابطها. في Genesis API أكثر من 35 منها: المراجحة ودفاتر الأوامر والتمويل والسوق وأونتشين وأسواق التنبؤات وإشارات AI والبحث عن العملات.