benjamin638900 / APIDoc

MXC API

---

API简介

欢迎使用MXC API，API分为公共接口和私有接口，你可以使用公共接口查询行情数据，并使用私有接口进行交易。

对于私有接口，为了防止请求在网络传输过程中被篡改，您需要使用您的API Key做签名认证，以保证我们收到的请求为您本人发出。一个合法的MXC签名是将所有参数名按字母顺序排列，用&连接各参数，再加上您的api_secret，做MD5生成签名。需将签名放入参数sign中。

以获取账户资产信息接口为例，需要传的参数包括api_key，req_time和sign共三个，除去sign之外的参数都需要参与签名。

如果您的api_key为mmmyyyaaapppiiikkkeeeyyy，您的api_secret为ssseeecccrrreeettt，当前的十位的时间戳为1234567890。

首先将需要签名的参数按照参数名进行排序(首先比较所有参数名的第一个字母，按英文字母顺序排列，若遇到相同首字母，则看第二个字母，以此类推)。所以第一个参数为api_key，第二个参数为req_time。

将参数和参数值用=进行连接：得到api_key=mmmyyyaaapppiiikkkeeeyyy和req_time=1234567890。

将得到的值用&进行连接，得到api_key=mmmyyyaaapppiiikkkeeeyyy&req_time=1234567890

在最后连接&api_secret=ssseeecccrrreeettt，得到api_key=mmmyyyaaapppiiikkkeeeyyy&req_time=1234567890&api_secret=ssseeecccrrreeettt。

将得到的字符串用MD5摘要算法进行签名，得到c90172772df116dd658141e853185517，加入到sign参数中

将api_key，req_time和sign三个参数放入请求中并发送请求

注意：

• 公共接口请加入请求头，否则会返回403

• POST请求请将参数放入params，放入body会返回401

---

API HOST: https://www.mxc.com

公共接口：

• GET /open/api/v1/data/markets 获取市场列表信息
• GET /open/api/v1/data/markets_info 获取交易对信息
• GET /open/api/v1/data/depth 获取深度信息
• GET /open/api/v1/data/history 获取单个币种成交记录信息
• GET /open/api/v1/data/ticker 获取市场行情信息
• GET /open/api/v1/data/kline 获取市场k线信息

私有接口：

• GET /open/api/v1/private/account/info 获取账户资产信息
• GET /open/api/v1/private/current/orders 获取当前委托信息
• GET /open/api/v1/private/order 获取委托单信息
• POST /open/api/v1/private/order 下单
• DELETE /open/api/v1/private/order 取消订单
• GET /open/api/v1/private/orders 查询账号历史成交
• GET /open/api/v1/private/order 查询订单状态

---

接口说明

代码库中的python目录为Python的示例代码，java目录为java的示例代码。

获取市场列表信息

• GET /open/api/v1/data/markets

请求参数

参数	类型	是否必须	说明

返回值

{
    "code": 200,
    "data": [
        "btc_usdt",
        "eth_usdt"
    ],
    "msg": "OK"
}

返回值说明

返回值	说明
data	包含所有交易对的数组

示例

python

---

获取交易对信息

• GET /open/api/v1/data/markets_info

请求参数

参数	类型	是否必须	说明

返回值

{
    "code": 200,
    "data": {
        "ETC_BTC": {
            "priceScale": 6,
            "quantityScale": 2,
            "minAmount": 0.0001,
            "buyFeeRate": 0.002,
            "sellFeeRate": 0.002
        },
        "BTC_USDT": {
            "priceScale": 2,
            "quantityScale": 6,
            "minAmount": 0.1,
            "buyFeeRate": 0.002,
            "sellFeeRate": 0.002
        }
    },
    "msg": "OK"
}

返回值说明

返回值	说明
priceScale	价格精度
quantityScale	数量精度
minAmount	最小量
buyFeeRate	买单费率
sellFeeRate	卖单费率

示例

python

---

获取深度信息

• GET /open/api/v1/data/depth

请求参数

参数	类型	是否必须	说明
depth	integer	√	返回的深度个数
market	string	√	交易对名称

返回值

{
    "code": 200,
    "data": {
        "asks": [
            {
                "price": "7061.82",
                "quantity": "2.759119"
            },
            {
                "price": "7062.4",
                "quantity": "0.01764"
            }
        ],
        "bids": [
            {
                "price": "7061.8",
                "quantity": "0.160269"
            },
            {
                "price": "7059.68",
                "quantity": "0.26862"
            }
        ]
    },
    "msg": "OK"
}

返回值说明

返回值	说明
price	价格
quantity	数量

示例

python

---

获取单个币种成交记录信息

• GET /open/api/v1/data/history

请求参数

参数	类型	是否必须	说明
market	string	√	交易对名称

返回值

{
    "code": 200,
    "data": [
        {
            "tradeTime": "2019-05-13 14:12:58.787",
            "tradePrice": "7051.04",
            "tradeQuantity": "0.0189",
            "tradeType": "1"
        },
        {
            "tradeTime": "2019-05-13 14:12:58.494",
            "tradePrice": "7051.04",
            "tradeQuantity": "0.023551",
            "tradeType": "1"
        }
    ],
    "msg": "OK"
}

返回值说明

返回值	说明
tradeTime	成交时间
tradePrice	成交价格
tradeQuantity	成交量
tradeType	成交类型1/2 (买/卖)

示例

python

---

获取市场行情信息

• GET /open/api/v1/data/ticker

请求参数

参数	类型	是否必须	说明
market	string	×	交易对

返回值

{
    "code": 200,
    "data": {
        "volume": "29821.449121",
        "high": "7512.22",
        "low": "6791.23",
        "buy": "7054.5",
        "sell": "7054.95",
        "open": "7304.1",
        "last": "7054.46"
    },
    "msg": "OK"
}

返回值说明

返回值	说明
volume	24小时成交量
high	24小时最高价
low	24小时最低价
buy	买一价
sell	卖一价
open	开盘价
last	最后成交价

示例

python

---

获取市场k线信息

• GET /open/api/v1/data/kline

请求参数

参数	类型	是否必须	说明
market	string	√	交易对
interval	string	√	时间间隔(分钟制:1m，5m，15m，30m，60m。小时制:1h，天制:1d，月制:1M)
startTime	long	√	起始时间(单位秒,毫秒数/1000 )
limit	long	×	返回条数

返回值说明

{
    "code": 200,
    "data": [
        [
            1557728040,
            "7054.7",
            "7056.26",
            "7056.29",
            "7054.16",
            "9.817734",
            "69264.52975125"
        ],
        [
            1557728100,
            "7056.26",
            "7042.17",
            "7056.98",
            "7042.16",
            "23.694823",
            "167007.92840231"
        ],
        [
            1557728160,
            "7042.95",
            "7037.11",
            "7043.27",
            "7036.53",
            "22.510102",
            "158461.98283462"
        ]
    ],
    "msg": "OK"
}

返回值	说明
time	开始时间 (单位秒,毫秒数/1000 )
open	开盘价
close	收盘价
high	最高价
low	最低价
vol	成交量
amount	计价货币成交量

示例

python

---

获取账户资产信息

• GET /open/api/v1/private/account/info

请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
req_time	string	√	请求时间戳
sign	string	√	请求签名

返回值

{
    "BTC": {
        "frozen": "0",
        "available": "130440.28790112"
    },
    "ETH": {
        "frozen": "27.6511928",
        "available": "12399653.86856669"
    }
}

返回值说明

返回值	说明
frozen	冻结量
available	可用量

示例

python

---

获取当前委托信息

• GET /open/api/v1/private/current/orders

请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
market	string	√	交易对
page_num	integer	√	页数
page_size	integer	√	每页大小
req_time	string	√	请求时间戳
trade_type	integer	√	交易类型，0/1/2 (所有/买/卖)
sign	string	√	请求签名

返回值

{
    "code": 200,
    "data": [
        {
            "id": "4921e6be-cfb9-4058-89d3-afbeb6be7d78",
            "market": "MX_ETH",
            "price": "0.439961",
            "status": "1",
            "totalQuantity": "2",
            "tradedQuantity": "0",
            "tradedAmount": "0",
            "createTime": "2019-05-13 14:31:11",
            "type": 1
        },
        {
            "id": "6170091f-c977-49bf-baa8-b643c70452c7",
            "market": "MX_ETH",
            "price": "0.4399605",
            "status": "1",
            "totalQuantity": "1",
            "tradedQuantity": "0",
            "tradedAmount": "0",
            "createTime": "2019-05-13 14:30:51",
            "type": 1
        }
    ],
    "msg": "OK"
}

返回值说明

返回值	说明
id	订单id
market	交易对
price	挂单价
status	订单状态，1:未成交 2:已成交 3:部分成交 4:已撤单 5:部分撤单
totalQuantity	挂单总量
tradedQuantity	挂单成交量
tradedAmount	挂单成交量(计价币)
createTime	订单创建时间
type	订单类型1/2 (买/卖)

示例

python

---

获取委托单信息

• GET /open/api/v1/private/order

** 请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
market	string	√	交易对
req_time	string	√	请求时间戳
trade_no	String	√	请求单号,多个订单号用,号分割
sign	string	√	请求签名

返回值 单个查询 {"code":200,"data":{"id":"18840447-xxxx-xxxx-xxxx-503738c4cbec","market":"EOS_ETH","price":"1","status":"2","totalQuantity":"10","tradedQuantity":"10","tradedAmount":"10","createTime":"2019-04-01 10:42:17","type":1},"msg":"OK"}

多个查询 {"code":200,"data":[{"id":"0ae05eb8-f02b-413a-a3e3-2b2e6877d52d","market":"EOS_ETH","price":"1","status":"2","totalQuantity":"105","tradedQuantity":"105","tradedAmount":"105","createTime":"2019-04-01 10:45:02","type":1},{"id":"18840447-9439-4af6-af64-503738c4cbec","market":"EOS_ETH","price":"1","status":"2","totalQuantity":"10","tradedQuantity":"10","tradedAmount":"10","createTime":"2019-04-01 10:42:17","type":1},{"id":"a8969fc8-64b7-4f33-8916-97654648a39c","market":"EOS_ETH","price":"1","status":"2","totalQuantity":"10","tradedQuantity":"10","tradedAmount":"10","createTime":"2019-04-01 10:42:26","type":1}],"msg":"OK"}

返回值说明

返回值	说明
id	订单id
market	交易对
price	挂单价
status	订单状态，1:未成交 2:已成交 3:部分成交 4:已撤单 5:部分撤单
totalQuantity	挂单总量
tradedQuantity	挂单成交量
tradedAmount	挂单成交量(计价币)
createTime	订单创建时间
type	订单类型1/2 (买/卖)

---

下单

• POST /open/api/v1/private/order

请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
market	string	√	交易对
price	string	√	交易价格
quantity	string	√	交易数量
req_time	string	√	请求时间戳
trade_type	integer	√	交易类型：1/2 (买/卖)
sign	string	√	请求签名

返回值

{
    "code": 200,
    "data": "de5a6819-5456-45da-9e51-ee258dd34422",
    "msg": "OK"
}

返回值说明

返回值	说明
data	订单id

示例

python

---

取消订单

• DELETE /open/api/v1/private/order

请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
market	string	√	交易对
req_time	string	√	请求时间戳
trade_no	string	√	委托单号
sign	string	√	请求签名

返回值

{
    "code": 200,
    "data": null,
    "msg": "OK"
}

返回值说明

返回值	说明

示例

python

---

查询账号历史成交

• GET /open/api/v1/private/orders

请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
req_time	string	√	请求时间戳
market	string	√	交易对
trade_type	string	√	交易类型，1/2 (买/卖)
page_num	integer	√	页数
page_size	integer	√	每页大小
sign	string	√	请求签名

返回值

{
    "code": 200,
    "data": [
        {
            "id": "f5718b8a-8f93-4880-8e95-281fe28efb91",
            "market": "OMG_ETH",
            "price": "0.011546000000000000",
            "status": "2",
            "totalQuantity": "46.520000000000000000",
            "tradedQuantity": "46.520000000000000000",
            "tradedAmount": "0.537119920000000000",
            "createTime": "2019-04-26 16:37:47.0",
            "type": 1
        },
        {
            "id": "845fdde0-6837-4d56-af8c-e43d72495cc1",
            "market": "OMG_ETH",
            "price": "0.011543000000000000",
            "status": "2",
            "totalQuantity": "7.920000000000000000",
            "tradedQuantity": "7.920000000000000000",
            "tradedAmount": "0.091420560000000000",
            "createTime": "2019-04-26 11:05:42.0",
            "type": 1
        }
    ],
    "msg": "OK"
}

返回值说明

返回值	说明
id	订单id
market	交易对
price	成交价格
status	订单状态，1:未成交 2:已成交 3:部分成交 4:已撤单 5:部分撤单
totalQuantity	订单总量
createTime	订单时间
type	交易类型：1/2 (买/卖)

示例

python

---

查询订单状态

• GET /open/api/v1/private/order

请求参数

参数	类型	是否必须	说明
api_key	string	√	您的api key
req_time	string	√	请求时间戳
market	string	√	交易对
trade_no	string	√	订单id，如果有多个，用英文逗号分隔，一次最多查询20个
sign	string	√	请求签名

返回值

{
    "code": 200,
    "data": {
        "id": "f5718b8a-8f93-4880-8e95-281fe28efb91",
        "market": "OMG_ETH",
        "price": "0.011546",
        "status": "2",
        "totalQuantity": "46.52",
        "tradedQuantity": "46.52",
        "tradedAmount": "0.53711992",
        "createTime": "2019-04-26 16:37:47",
        "type": 1
    },
    "msg": "OK"
}

返回值说明

返回值	说明
id	订单id
market	交易对
price	下单价格
status	订单状态，1:未成交 2:已成交 3:部分成交 4:已撤单 5:部分撤单
totalQuantity	订单总量
tradedQuantity	成交总量
tradedAmount	成交量（计价货币）
createTime	下单时间
type	交易类型：1/2 (买/卖)

示例

python

---

接口示例

• 公共

import requests

ROOT_URL = 'https://www.mxc.com'

headers = {
    'Content-Type': 'application/json',
    'User-Agent': 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.71 Safari/537.36',
    "Accept": "application/json",
}

获取市场列表信息 python demo

url = ROOT_URL + '/open/api/v1/data/markets'
response = requests.request('GET', url, headers=headers)
print(response.json())

获取交易对信息 python demo

url = ROOT_URL + '/open/api/v1/data/markets_info'
response = requests.request('GET', url, headers=headers)
print(response.json())

获取深度信息 python demo

symbol = 'BTC_USDT'
depth = 30
params = {'market': symbol,
          'depth': depth}
url = ROOT_URL + '/open/api/v1/data/depth'
response = requests.request('GET', url, params=params, headers=headers)
print(response.json())

获取单个币种成交记录信息 python demo

symbol = 'BTC_USDT'
params = {'market': symbol}
url = ROOT_URL + '/open/api/v1/data/history'
response = requests.request('GET', url, params=params, headers=headers)
print(response.json())

获取市场行情信息 python demo

symbol = 'BTC_USDT'
params = {'market': symbol}
url = ROOT_URL + '/open/api/v1/data/ticker'
response = requests.request('GET', url, params=params, headers=headers)
print(response.json())

获取市场K线信息 python demo

import time
symbol = 'BTC_USDT'
params = {'market': symbol,
          'interval': '1m',
          'startTime': int(time.time() / 60) * 60 - 60 * 5,
          'limit': 5}
url = ROOT_URL + '/open/api/v1/data/kline'
response = requests.request('GET', url, params=params, headers=headers)
print(response.json())

• 私有

import time
import hashlib

API_KEY = 'your api key'
SECRET_KEY = 'your secret key'

def sign(params):
    sign = ''
    for key in sorted(params.keys()):
        sign += key + '=' + str(params[key]) + '&'
    response_data = sign + 'api_secret=' + SECRET_KEY
    return hashlib.md5(response_data.encode("utf8")).hexdigest()

获取账户资产信息 python demo

url = ROOT_URL + '/open/api/v1/private/account/info'
params = {'api_key': API_KEY,
          'req_time': time.time()}
params.update({'sign': sign(params)})
response = requests.request('GET', url, params=params, headers=headers)
print(response.json())

获取当前委托信息 python demo

symbol = 'BTC_USDT'
trade_type = 0
params = {'api_key': API_KEY,
          'req_time': time.time(),
          'market': symbol,
          'trade_type': trade_type,  # 交易类型，0/1/2 (所有/买/卖)
          'page_num': 1,
          'page_size': 50}
params.update({'sign': sign(params)})
url = ROOT_URL + '/open/api/v1/private/current/orders'
response = requests.request('GET', url, params=params, headers=headers)
print(response.json())

下单 python demo

symbol = 'BTC_USDT'
price = 9999
quantity = 66
trade_type = 1  # 1/2 (买/卖)
params = {'api_key': API_KEY,
          'req_time': time.time(),
          'market': symbol,
          'price': price,
          'quantity': quantity,
          'trade_type': trade_type}
params.update({'sign': sign(params)})
url = ROOT_URL + '/open/api/v1/private/order'
response = requests.request('POST', url, params=params, headers=headers)
print(response.json())

取消订单 python demo

symbol = 'BTC_USDT'
order_id = '3cd4bd41-****-****-****-d593f8eea202'
params = {'api_key': API_KEY,
          'req_time': time.time(),
          'market': symbol,
          'trade_no': order_id}
params.update({'sign': sign(params)})
url = ROOT_URL + '/open/api/v1/private/order'
response = requests.request('DELETE', url, params=params, headers=headers)
print(response.json())

查询账号历史成交 python demo

symbol = 'EOS_ETH'
deal_type = 1
params = {'api_key': API_KEY,
          'req_time': time.time(),
          'market': symbol,
          'trade_type': deal_type,
          'page_num': 1,
          'page_size': 70}
params.update({'sign': sign(params)})
url = ROOT_URL + '/open/api/v1/private/orders'
response = requests.request('GET', url, params=params)
print(response.json())

查询订单状态 python demo

symbol = 'EOS_ETH'
trade_no = 'f5718b8a-8f93-4880-8e95-281fe28efb91'
params = {'api_key': API_KEY,
          'req_time': time.time(),
          'market': symbol,
          'trade_no': trade_no}
params.update({'sign': sign(params)})
url = ROOT_URL + '/open/api/v1/private/order'
response = requests.request('GET', url, params=params)
print(response.json())