endpoint در API
endpoint آدرس یک عملکرد مشخص API است: برنامه آن را صدا میزند تا یک نوع داده بگیرد، مثل اسپردهای Spot – Spot یا نرخهای فاندینگ. مستندات endpoint را همراه متد 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 |
| پارامتر query | min_spread=0.5: اسپرد 0.5% یا بیشتر |
درخواست فرصتهایی با اسپرد 0.5% یا بیشتر برمیگرداند: کوین (coin)، صرافیهای خرید و فروش (exchange_buy، exchange_sell)، قیمتها، spread_pct و پرچمهای واریز و برداشت. پارامترهای دیگر این endpoint، یعنی coin، exchange و min_volume، در بخش Spot — Spot فهرست شدهاند.
پارامترهای مسیر و پارامترهای query
پارامتر مسیر بخشی از خود آدرس است و مستندات آن را داخل آکولاد نشان میدهد. در /orderbooks/coin/{coin} بهجای {coin} نماد کوین میگذارید: /orderbooks/coin/BTC دفترهای سفارش BTC را در هر صرافی و هر بازار برمیگرداند (دفترهای سفارش کوین).
پارامترهای query بعد از ? به شکل جفتهای name=value میآیند و با & جدا میشوند. یک آدرس میتواند هر دو نوع را داشته باشد: در /orderbooks/spreads/spot-futures?coin=BTC&volume=5000 مجموعهٔ spot-futures در مسیر است، ولی کوین و حجم 5,000 دلار پارامترهای query هستند (Δ دفتر سفارش).
خطاها هنگام فراخوانی
| پاسخ | علت |
|---|---|
404 not_found | چنین endpoint یا منبعی نیست |
400 bad_request | پارامترهای نامعتبر، جزئیات در message |
403 plan_restricted | endpoint در پلن شما نیست |
410 gone | endpoint بازنشسته شده و جایگزینش در message است |
فهرست کامل بیش از 35 endpoint در مستندات و در مشخصات ماشینخوان OpenAPI آمده است.
همچنین ببینید: REST API، JSON، endpointهای آربیتراژ، endpointهای دفتر سفارش.
پرسش و پاسخ
endpoint با API چه فرقی دارد؟
API مجموعهٔ کامل عملکردهای یک سرویس است؛ endpoint یک عملکرد با آدرس خودش. Genesis API بیش از 35 تا دارد: آربیتراژ، دفتر سفارش، فاندینگ، بازار، آنچین، بازارهای پیشبینی، سیگنالهای AI و جستجوی کوین.