Эндпоинт
Эндпоинт (endpoint) — адрес конкретной функции API: по нему программа получает один вид данных, например спреды Спот – Спот или ставки фандинга. В документации эндпоинт записывают вместе с методом 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 — набор «Спот — Спот» |
| Параметр запроса | min_spread=0.5 — спред от 0,5 % |
Запрос вернёт связки со спредом от 0,5 %: монету (coin), биржи покупки и продажи (exchange_buy, exchange_sell), цены, spread_pct и флаги депозита и вывода. Другие параметры этого эндпоинта — coin, exchange и min_volume — описаны в разделе «Спот — Спот».
Параметры пути и параметры запроса
Параметр пути — часть самого адреса, в документации его пишут в фигурных скобках. В /orderbooks/coin/{coin} вместо {coin} подставляют тикер: /orderbooks/coin/BTC вернёт стаканы BTC на всех биржах и рынках («Стаканы монеты»).
Параметры запроса идут после ? парами имя=значение, между парами ставят &. Оба вида бывают в одном адресе: в /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-сигналы и поиск монет.