API 怎么用

API 端点支持的请求方法请求参数头部参数路径参数查询字符串参数响应格式 HTTP响应码 HTTP错误码错误信息限额

所有你的 API 请求应发送至以下 API 端点：

https://api.cryptohopper.com/v1/

GET 使用 GET 获取资源或一组资源（例如，所有交易机器人的列表、当前订单或最近交易记录）。此方法安全且幂等。

POST 使用POST创建资源。例如：下单买入/卖出，创建新的交易机器人。

PATCH 使用 PATCH 更新资源。例如：启动或停止你的交易机器人，或更新个人资料。用这种方法，你只需在请求体中提供你想修改的字段即可。

DELETE 使用删除来删除资源。

我们API中使用四种参数类型：路径、查询字符串、头部和请求体参数。请求体参数是用于POST和PATCH请求的JSON请求体中的数据。头部参数显然需要发布在头部。关于头部、路径和查询字符串参数的更多信息请见下方。

所有对我们 API 的请求都需要通过头信息发送以下值进行身份验证：

这些参数在终结点的 URI 中提供。例如，GET Hopper 终结点：

https://api.cryptohopper.com/v1/hopper/{hopper_id}

为了获取特定交易机器人，你需要将其ID值替换到{hopper_id}占位符中。例如，要获取ID为37的交易机器人，请访问以下URL：

https://api.cryptohopper.com/v1/hopper/37

某些终结点需要多个参数。例如，如果想获取之前 Hopper 的特定订单，需要调用以下 URL：

https://api.cryptohopper.com/v1//hopper/{hopperId}/order/{orderId}

并且通过替换参数为 Hopper 和订单号，你会得到：

https://api.cryptohopper.com/v1//hopper/37/order/231

详细的每个 API 端点所需参数列表，请参考我们的API 参考指南。

我们用这些参数在 GET 请求中进行数据过滤和/或分页。这些参数未指定在路径中，而是作为一组用“&”符号分隔的值包含在 URL 字符串中。

例如，要获取交易机器人的比特币买入订单，可以像这样调用 Hopper 订单端点：

https://api.cryptohopper.com/v1/hopper/37/order/?order_type=buy&coin=btc

通过查看我们 API 参考，je 可以看到，在此情况下，order_type 参数可以取“买入”或“卖出”值，而 coin 参数可以是任何小写加密货币代币代码。

所有回复均以 JSON 对象的形式返回。因此，你可以在所有回复中找到 application/json 的 MIME 类型。请参考我们的API 参考文档，了解每个请求和回复正文中特定 JSON 响应格式。

我们使用RFC 2616和RFC 6585定义的响应状态码。.

200 - OK 请求成功。客户端可在响应体和头部获取请求结果。

201 – Created 请求已受理，并创建了新的资源。

202 – Accepted 请求已受理，但处理未完成。

204 – No Content 服务器已成功处理请求，但未返回内容。

304 – Not Modified 资源自请求头 If-Modified-Since 或 If-None-Match 指定的版本后未被修改。客户端无需重新传输资源，因客户端仍保留之前下载的副本。

400 – Bad Request 服务器无法或拒绝处理请求，原因是明显的客户端错误。消息正文将返回错误信息。

400 – Bad Request 服务器无法或拒绝处理该请求，疑似客户端错误。消息正文将返回错误信息。

401 – Unauthorized 请求需要用户验证，且因 API 凭证无效或缺失而被拒绝。

403 – Forbidden 服务器理解了请求，但拒绝执行，因为 je 没有访问权限或 je 的凭证已被撤销。

404 – Not found 请求的资源不存在。此错误可能由暂时性或永久性情况导致。

405 – Method Not Allowed 请求方法不被目标 API 端点支持。

429 – Too Many Request 用户已超出 API 请求速率限制。请查看返回的Retry-After 头部信息，了解需要等待多少秒才能进行新请求。请查阅我们的速率限制部分，了解当前的请求限制。

500 – Internal Server Error 服务器出错了，导致无法处理你的请求。程序员们将面临一个星期的“断咖啡”作为第一次警告...

503 – Service Unavailable 我们的服务器可能出现问题，无法处理你的请求。

若 API 返回错误代码，则会将包含错误描述的 JSON 对象附加到其主体。错误信息类似于：

{
            "status": 400,
            "error": 1,
            "message": "Missing required request parameters: [access_token]"
        }

咱們的 API 有請求速率限制，確保所有用户都能公平地使用带宽资源。目前，每用户每秒请求次数限制为2 次，但下买单时有所不同，最多每 8 秒下单一次。

如果超过每秒可用的请求数量，你会收到一个429 错误响应码。请查看响应附带的Retry-After 头部，它包含你需要等待执行下一次请求的秒数。