REST API

本文主要描述路印交易所REST API的共性部分。

接入URL

https://api.loopring.io

限流

每个API都有流量限制,超额的调用请求会被拒绝(返回429)。如果您长期超额调用,您的账号就会被列入黑名单,从而无法继续使用路印API。

HTTP头

X-API-KEY

查询用户ApiKey外的所有API都需要指定X-API-KEYHTTP头,提供用户的ApiKey。

X-API-SIG

以下API需要指定X-API-SIGHTTP头,提供用户的的EdDSA数字签名:

设置HTTP头

使用Python设置HTTP头的代码如下:

def init_request_session(apiKey, sig):
    session = requests.session()
    session.headers.update({
        'Accept': 'application/json',
        'X-API-KEY': apiKey,
        'X-API-SIG': sig,
    })
    return session

API返回值

除了网络错误,所有API都会返回200状态码和代表API结果的JSON数据。JSON返回信息中都包含一个resultInfo字段,用以反馈API调用的通用状态,特别是出错时候的状态码。如果请求正常返回,则还会返回一个data字段,该字段的值也是一个JSON结构,针对不同API代表不同的业务数据,请参考每个API说明。

返回值结构

字段 类型 必须 说明 举例
resultInfo ResultInfo 调用结果 -

ResultInfo结构

字段 类型 必须 说明 举例
code integer 状态码 0
message string 返回说明。用来帮助调试,不应在前端显示或用于逻辑判断。 "SUCCESS"

状态码

状态码 描述
0 成功
100000 内部未知错误
100001 参数非法
100002 请求超时
100202 更新失败
100203 内部存储错误
100204 重复提交

results matching ""

    No results matching ""