API 接口(endpoint)
接口(endpoint)是某个具体 API 功能的 URL:程序调用它来获取某一类数据,例如 Spot – Spot 价差或资金费率。文档会把接口和它的 HTTP 方法一起列出:GET /arbitrage/spot-spot。
URL 拆解
URL 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"
| 部分 | 值 |
|---|---|
| 基础 URL | 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 一节。
路径参数与查询参数
路径参数是 URL 本身的一部分;文档中用花括号表示。在 /orderbooks/coin/{coin} 中,把 {coin} 替换成交易代码:/orderbooks/coin/BTC 返回 BTC 在每个交易所和市场的订单簿(币种订单簿)。
查询参数跟在 ? 后面,写成 名称=值 的形式,用 & 分隔。一个 URL 可以同时带有两种参数:在 /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 规范。
常见问题
接口和 API 有什么区别?
API 是一个服务全部功能的集合;接口则是带有独立 URL 的单个功能。Genesis API 有 35 个以上的接口:套利、订单簿、资金费率、市场、链上、预测市场、AI 信号和币种搜索。