NAV Navbar
JSON

简介

API 简介

欢迎使用 GIEX API！

通过本文档，可以帮助您更好的使用 GIEX API 进行获取市场行情，管理账户信息，市场交易等操作。

联系我们

使用过程中如有问题或建议，请通过以下方式联系我们：

· 发送邮件至 [email protected]

更新日志

生效时间（新加坡时间 UTC+8） 接口 更新类型 说明
2020-08-20 * 新增 状态码增加认证错误
2020-03-31 * 修改 token 现在剩余时间小于30分钟时可以提前刷新
2020-03-30 * 修改 完善文档 修复一些response不符合实际请求的 增加日本aws节点
2020-03-06 GET /v1/private/account/balance 修改 请求方法错误修改
2020-03-04 * 修改 授权接入头部信息修改
2020-03-04 GET /v1/private/orders/query 新增 增加订单查询接口
2020-02-14 * 新增 API V1发布

接入

接入准备

您可以点击 这里 创建 API Key。

授权

GIEX OPEN API 使用 API token 校验用户。

你需要使用 Access Key 与 Secret Key 来获取 token。

token 有效时间为一个小时, 你需要每个小时来获取一次新 token。

获取token

鉴权时 需要在 Header 中携带 token 信息：

Authorization: Bearer <your token>

接入URLs

REST API

https://open.giex.com (国内加速)
https://open2.giex.com (日本AWS)

Websocket

wss://subscribe.giex.com/ws/ (国内加速)
wss://sub.giex.com/ws/ (日本AWS)

说明

接口概览

分类 链接 说明
基础类 /v1/common/* 基础类接口，包括币种、交易对、时间戳等接口 (不需要认证)
鉴权 /v1/common/token 获取token
交易类 /v1/common/private/* 交易类接口，包括个人信息、下单、提现等接口（需要携带token认证）

请求格式

所有的 API 请求都是 restful，目前只有两种方法：GET 和 POST。

GET 请求：所有的参数都在路径参数里。
POST 请求：所有参数以 JSON 格式发送在请求主体（body）里。

返回格式

例如:

{
    "code": 0,
    "errmsg": "",
    "data": 1581583353
}

返回的数据类型为 JSON。 顶层数据包括 ：code(状态码)， errmsg(详细错误信息 如果有)， data(数据内容)。

数据签名

目前仅获取 token 需要 API 签名

签名参数

  1. app_id
  2. timestamp

签名步骤:

  1. 对参数进行URI编码，并且按照ASCII码顺序进行排序。
  2. 按照以上顺序，将各参数使用字符 “&” 连接组成最终的要进行签名计算的字符串。
  3. 用上一步里生成的 “请求字符串” 和你的密钥 (Secret Key) 生成一个数字签名，签名方式为 HmacSHA256，秘钥为您的 app key。
  4. 将此哈希值用 base-64 编码，得到的值作为最终签名。
  5. 将其添加到 body signature 中。
  6. 请保证发送的时候所有参数都经过URI编码 signature base64编码后会出现+/等符号 未编码可能会导致签名验证失败

公共接口

服务器时间戳

此接口返回当前的服务器时间戳

HTTP 请求

GET /v1/common/timestamp

URL Parameters

此接口不接受任何参数。

响应

{
    "code": 0,
    "errmsg": "",
    "data": 1581585299
}

获取token

此接口获取token

HTTP 请求

POST /v1/common/token

POST/v1/common/token/new (此接口返回token到期时间)

URL Parameters

参数 数据类型 描述
app_id string Access Key
timestamp integer 时间戳
signature string 签名，签名方式参考

响应

{
    "code": 0,
    "errmsg": "",
    "data": "dotgFHb2YL1l5VzGUGea7f5tUNKDslAHWbLLIrfi8rVFKuGkR2pktGy8Lg9E"
}

token/new 接口
{
    "code": 0,
    "errmsg": "",
    "data": {
        "token": "ruacxLdLq231pt946xwtvcQ6Q24Je5rBrU9lueKGNmnkGQQWUMOpPYxTX88n",
        "expire_at": 1585622553
    }
}

获取所有交易对

此接口返回当前所有交易对

HTTP 请求

GET /v1/common/market/list

URL Parameters

此接口不接受任何参数。

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        {
            "name": "BTC/USDT",
            "min_amount": "5",
            "money_prec": 2,
            "stock": "BTC",
            "fee_prec": 4,
            "money": "USDT",
            "stock_prec": 6,
            "type": 1
        }
    ]
}
字段名称 数据类型 描述
name string 交易对
min_amount string 交易对的最小下单金额
stock string 交易对中的基础币种
money string 交易对中的报价币种
money_prec integer 交易对报价精度（小数点后位数）
stock_prec integer 下单量精度（小数点后位数）
fee_prec integer 手续费精度（小数点后位数）
type integer 保留参数

所有交易对的最新 Tickers

此接口返回所有交易对的 Tickers

HTTP 请求

GET /v1/common/market/tickers

URL Parameters

此接口不接受任何参数。

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "BTC/USDT": {
            "time": 1581646433,
            "open": "9729.51",
            "close": "9729.59",
            "high": "9729.63",
            "low": "9729.27",
            "vol": "1280.589113",
            "amount": "12459491.93001755"
        }
    }
}
字段名称 数据类型 描述
time integer 时间戳
open string 开盘价
close string 收盘价
high string 最高价格
low string 最低价格
vol string 以基础币种计量的交易量
amount string 以报价币种计量的交易量

获取所有币种

此接口返回当前币种列表

HTTP 请求

GET /v1/common/assets

URL Parameters

此接口不接受任何参数。

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        {
            "name": "EOS",
            "prec": 8,
            "full_name": "eos.io"
        }
    ]
}
字段名称 数据类型 描述
name string 币种简称
prec integer 精度
full_name string 币种全称

K线数据

此接口返回历史K线数据

HTTP 请求

GET /v1/common/kline

URL Parameters

参数 数据类型 描述 取值范围
market string 交易对 BTC/USDT,ETH/USDT...(取值参考GET /v1/common/market/list)
from integer k线开始时间 unix时间戳
to integer k线结束时间 unix时间戳
type string 类型 1m, 5m, 10m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d, 7d（m:分钟, h:小时, d:日）

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        [
            1580449620,
            "8030.72",
            "8002.82",
            "8058.05",
            "8002.82",
            "0.754631",
            "6051.25733957"
        ]
    ]
}
顺序 数据类型 描述
1 integer 时间戳
2 string 开盘价
3 string 收盘价
4 string 最高价格
5 string 最低价格
6 string 以基础币种计量的交易量
7 string 以报价币种计量的交易量

获取所有币种

此接口返回当前所有币种信息

HTTP 请求

GET /v1/common/coins

URL Parameters

此接口不接受任何参数。

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        {
            "id": 1,
            "symbol": "EOS",
            "token_name": "eos.io",
            "coin_type": "EOS",
            "contract_address": "eosio.token",
            "token_decimal": 4,
            "min_withdraw": "0.00100000",
            "withdraw_fee": "0.00010000",
            "enabled": 1,
            "enable_deposit": 1,
            "enable_withdraw": 1
        }
    ]
}
字段名称 数据类型 描述
id integer id
symbol string 币种简称
token_name string 币种全称
coin_type string 币种类型
contract_address string 合约地址
token_decimal integer 币种精度
min_withdraw string 最小提币数量
withdraw_fee string 提币手续费
enable integer 币种是否可用，0 不可用，1 可用
enable_deposit integer 是否支持充币，0 支持，1 不支持
enable_withdraw integer 是否支持提币，0 支持，1 不支持

市场深度数据

此接口返回指定交易对深度数据

HTTP 请求

GET /v1/common/depth

URL Parameters

参数 数据类型 描述 取值范围
market string 交易对 BTC/USDT,ETH/USDT...(取值参考GET /v1/common/market/list)
type string 价格聚合度 1x 10x 100x

聚合度说明

取值 说明
1x 无聚合
10x 聚合度为交易对报价精度*10
100x 聚合度为交易对报价精度*100

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "bids": [
            [
                "9729.44", // price
                "0.009343" // vol
            ]
        ],
        "asks": [
            [
                "9729.65",
                "0.006294"
            ]
        ],
        "time": 1581668083.223374
    }
}
参数 类型 说明
bids string Bids 买方挂单
asks string Asks 卖方挂单

交易接口

下述接口需要授权

账户余额

API Key 权限：读取

此接口返回账户余额信息

HTTP 请求

GET /v1/private/account/balance

URL Parameters

此接口不接受任何参数。

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        {
            "asset": "EOS",
            "full_name": "eos.io",
            "lock": "0",
            "available": "0",
            "freeze": "0",
            "total": "0",
            "ethvalue": "0e-8",
            "btcvalue": "0e-8"
        }
    ]
}
字段名称 数据类型 描述
asset string 币种简称
full_name string 币种全称
lock string 锁定余额
available string 可用余额
freeze string 冻结余额
total string 总余额
ethvalue string 资产 ETH 价值(估计值)
btcvalue string 资产 BTC 价值(估计值)

交易对手续费

API Key 权限：读取

此接口返回交易对手续费信息

HTTP 请求

GET /v1/private/account/fees

URL Parameters

此接口不接受任何参数。

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        {
            "market": "BTC/USDT",
            "maker-fee": "0.0015", //0.15%
            "taker-fee": "0.002" //0.2%
        }
    ]
}
字段名称 数据类型 描述
market string 市场
maker-fee string 用户真实交易费率 - 被动方
taker-fee string 用户真实交易费率 - 主动方

下单

API Key 权限：交易

此接口用于下单

HTTP 请求

POST /v1/private/orders/place

URL Parameters

参数 数据类型 描述 取值范围
market string 交易对 BTC/USDT,ETH/USDT...(取值参考GET /v1/common/market/list)
side integer 方向 1 卖，2 买
amount string 交易数量
price string 交易价格 类型为 market时不需要
type string 交易类型 limit 或者 market

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "mtime": 1581649613.667516,
        "id": 5613056,
        "market": "BHD/USDT",
        "type": 1,
        "amount": "5",
        "price": "5.66",
        "side": 2,
        "ctime": 1581649613.667516,
        "status": 1,
        "left": "5",
        "deal_stock": "0",
        "deal_money": "0"
    }
}
字段名称 数据类型 描述
id integer 订单ID
market string 交易对
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间，unix 时间戳
mtime float 更新时间，unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

撤单

API Key 权限：交易

此接口用于撤单

HTTP 请求

POST /v1/private/orders/cancel

URL Parameters

参数 数据类型 描述
market string 交易对
order_id integer 订单号

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": [
        {
            "mtime": 1581649613.667516,
            "id": 5613056,
            "market": "BHD/USDT",
            "type": 1,
            "amount": "5",
            "price": "5.66",
            "side": 2,
            "ctime": 1581649613.667516,
            "status": 3,
            "left": "5",
            "deal_stock": "0",
            "deal_money": "0"
        }
    ]
}
字段名称 数据类型 描述
id integer 订单ID
market string 交易对
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间，unix 时间戳
mtime float 更新时间，unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

当前挂单

API Key 权限：读取

此接口返回账户当前挂单信息

HTTP 请求

GET /v1/private/orders/open

URL Parameters

参数 数据类型 描述
offset integer 偏移量（起始序号）
limit integer 返回订单的数量

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "limit": 10,
        "offset": 0,
        "total": 6,
        "records": [
            {
                "id": 7304556,
                "price": "5.66",
                "ctime": 1583895968.390136,
                "market": "BHD/USDT",
                "status": 1,
                "side": 2,
                "type": 1,
                "mtime": 1583895968.390136,
                "amount": "5",
                "left": "5",
                "deal_stock": "0",
                "deal_money": "0"
            }
        ]
    }
}
字段名称 数据类型 描述
id integer 订单ID
market string 交易对
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间，unix 时间戳
mtime float 更新时间，unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

查询订单号

API Key 权限：读取

此接口获取订单详情

HTTP 请求

GET /v1/private/orders/query

URL Parameters

参数 数据类型 描述
order_id integer 订单号

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "id": 7215927,
        "price": "5.66000000",
        "ctime": 1583289520.126821,
        "market": "BHD/USDT",
        "status": 2,
        "side": 2,
        "type": 1,
        "mtime": 1583289624.092412,
        "amount": "1.00000000",
        "left": 0,
        "deal_stock": "1.00000000",
        "deal_money": "5.6600000000000000"
    }
}
字段名称 数据类型 描述
id integer 订单ID
market string 交易对
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间，unix 时间戳
mtime float 更新时间，unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

获取历史订单

API Key 权限：读取

此接口返回账户当前历史订单

HTTP 请求

POST /v1/private/orders/history

URL Parameters

参数 数据类型 描述
offset integer 偏移量（起始序号）
limit integer 返回订单的数量

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "offset": 0,
        "limit": 10,
        "total": 26,
        "records": [
            {
                "mtime": 1581649613.667516,
                "id": 5613056,
                "market": "BHD/USDT",
                "type": 1,
                "amount": "5",
                "price": "5.66",
                "side": 2,
                "ctime": 1581649613.667516,
                "status": 3,
                "left": "5",
                "deal_stock": "0",
                "deal_money": "0"
            }
        ]
    }
}
字段名称 数据类型 描述
id integer 订单ID
market string 交易对
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间，unix 时间戳
mtime float 更新时间，unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

我的成交

API Key 权限：读取

此接口返回账户成交订单

HTTP 请求

POST /v1/private/orders/deals

URL Parameters

参数 数据类型 描述
offset integer 偏移量（起始序号）
limit integer 返回订单的数量

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": {
        "offset": 0,
        "limit": 10,
        "total": 26,
        "records": [
            {
                "deal_id": 1107625,
                "order_id": 5253010,
                "price": "5",
                "time": 1581508123.982849,
                "amount": "1",
                "deal": "5",
                "fee_asset": "USDT",
                "market": "BHD/USDT",
                "side": 2,
                "fee": "0.0075"
            }
        ]
    }
}
字段名称 数据类型 描述
id integer 订单ID
market string 交易对
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间，unix 时间戳
mtime float 更新时间，unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

提币

API Key 权限：提现

此接口用于提币

提币时请确保已经通过了KYC，同时密码在 24 小时内未修改。

HTTP 请求

POST /v1/private/account/withdraw

URL Parameters

参数 数据类型 描述
coin string 币种简称 参考
coin_type string 币种类型
address string 提币地址
amount string 提币数量
memo: string memo

HTTP 响应

响应

{
    "code": 0,
    "errmsg": "",
    "data": "true"
}

此接口正确响应时 暂时只返回 true 其余错误信息会在errmsg中

Websocket公共接口

websocket说明

请求数据

请求数据及返回数据皆为json格式

请求参数

参数 类型 说明
method string 命令 方法
params array 参数
id integer Request id

响应数据

响应数据格式

字段名称 类型 说明
error string json 格式，成功为null ，失败为错误ID
id integer 请求时 Request id

通知数据

通知数据格式

参数 类型 说明
method string 订阅时命令 方法
params array 订阅结果
id integer Request id

心跳续活

为保证连接不被运营商等中断, 请定时发送ping请求 建议每隔5s请求一次 具体 参考

ping

请求

{"method":"server.ping","params":[],"id":0}

响应

{"error":null,"id":0,"result":"pong"}

市场深度

请求

{"method":"depth.subscribe","params":["BTC/USDT", "1x", 10],"id":0}
顺序 类型 说明
1 string 交易对
2 string 价格聚合度 1x 10x 100x
3 integer 深度数量

响应

{"id": 0, "error": null}

取消订阅

请求

{"method":"depth.unsubscribe","params":[],"id":0}

通知数据

响应

{"id":null,"method":"depth.update","params":["BTC/USDT",[{"time":1582618789.933751,"asks":[["9550.29","0.000538"],["9552.29","0.007226"],["9554.28","0.001494"],["9555.28","0.001821"],["9556.26","0.00055"],["9556.27","0.000645"],["9557.25","0.001691"],["9557.26","0.002017"],["9558.12","0.01"],["9558.16","0.01"]],"bids":[["9548.27","0.003125"],["9547.26","0.00425"],["9546.31","0.001287"],["9545.31","0.003665"],["9545.23","0.01"],["9545.22","0.01"],["9545.05","0.01"],["9544.87","0.01"],["9544.46","0.002742"],["9544.34","0.002734"]]}]]}
参数 类型 说明
bids string Bids 买方挂单
asks string Asks 卖方挂单
顺序 类型 说明
1 string 价格
2 string 深度

K 线数据

请求

{"method":"kline.subscribe","params":["BTC/USDT", "1m"],"id":0}
顺序 类型 说明
1 string 交易对
2 string 类型 1m, 5m, 10m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d, 7d（m:分钟, h:小时, d:日）

响应

{"id": 0, "error": null}

取消订阅

请求

{"method":"kline.unsubscribe","params":[],"id":0}

通知数据

响应

{"id":null,"method":"kline.update","params":["BTC/USDT",[[1582618800,"9549.18","9557.26","9557.26","9549.18","0.037245","355.77113477"]]]}
顺序 数据类型 描述
1 integer 时间
2 string 开盘价
3 string 收盘价
4 string 最高价格
5 string 最低价格
6 string 以基础币种计量的交易量
7 string 以报价币种计量的交易量

实时成交

请求

{"method":"deals.subscribe","params":["BTC/USDT"],"id":0}
顺序 类型 说明
1 string 交易对

响应

{"id": 0, "error": null}

取消订阅

请求

{"method":"deals.unsubscribe","params":["BTC/USDT"],"id":0}

通知数据

响应

{"id":null,"method":"deals.update","params":["BTC/USDT",[[1582618885.797565,"9559.99","0.006512",2]]]}
顺序 数据类型 描述
1 integer 时间
2 string 价格
3 string 以基础币种计量的交易量
4 string 方向，1 卖，2 买

tickers

请求

{"method":"status.subscribe","params":["BTC/USDT", "ETH/USDT"],"id":0}
顺序 类型 说明
1 string 交易对 允许多个

响应

{"id": 0, "error": null}

取消订阅

请求

{"method":"status.unsubscribe","params":["BTC/USDT", "ETH/USDT"],"id":0}

通知数据

响应

{"id":null,"method":"daystatus.update","params":["BTC/USDT",[[1582618981,"9753.39","9561.59","9833.44","9493.49","44.019505","424811.49713998"]]]}
顺序 数据类型 描述
1 integer 时间
2 string 开盘价
3 string 收盘价
4 string 最高价格
5 string 最低价格
6 string 以基础币种计量的交易量
7 string 以报价币种计量的交易量

Websocket个人信息接口

接入说明

数据格式参考

订单

请求

{"method":"orders.subscribe","params":["token"],"id":0}
顺序 类型 说明
1 token 获取token 中获取的token

响应

{"id": 0, "error": null}

取消订阅

请求

{"method":"orders.unsubscribe","params":[],"id":0}

通知数据

响应

{"id":null,"method":"orders.update","params":[{"amount":"0.00075","ctime":1582618521.445885,"deal_money":"0","deal_stock":"0","id":41989557,"left":"0.00075","market":"BTC/USDT","mtime":1582618521.445885,"price":"9549.98","side":2,"status":1,"type":1}]}
参数 数据类型 描述
id integer 订单ID
market string 市场
type integer 订单类型，1 限价单，2 市价单
side integer 买卖方向，1 卖，2 买
ctime float 下单时间 unix 时间戳
mtime float 更新时间 unix 时间戳
price string 下单价格
amount string 下单量
left string 剩余量
deal_stock string 成交量
deal_money string 成交额
status integer 订单状态，1 进行中，2 完成，3 撤单

余额

请求

{"method":"balance.subscribe","params":["token"],"id":0}
顺序 类型 说明
1 token 获取token 中获取的token

响应

{"id": 0, "error": null}

取消订阅

请求

{"method":"balance.unsubscribe","params":[],"id":0}

通知数据

响应

{"id":null,"method":"balance.update","params":[{"asset":"USDT","available":"7.16669887","freeze":"0","lock":"0"}]}
参数 数据类型 描述
available string 可用余额
asset string 资产类型
freeze string 冻结金额

错误码

错误码 说明
401 token 无效或过期
10000 常规错误
10001 IP不在白名单列表
10002 没有交易权限
10003 没有提现权限
10010 提现错误
10005 认证错误
JSON