Version 2 General API Information

All endpoints return either a JSON object or array.
All time and timestamp related fields are in milliseconds.
For GET endpoints, parameters must be sent as url parameters.
For POST endpoints, parameters must be sent in the request body, with the header Content-Type: application/x-www-form-urlencoded.
Parameters may be sent in any order.
There are two types of APIs:
a. Oapi APIs: can be used directly without signature authentication.
b. Open APIs: require apiKey and secretKey, which can be applied for at https://ace.io/.
CCXT is our authorized SDK provider and you may access the ACE API through CCXT. For more information, please visit: https://ccxt.trade

Signing API Requests

Important Note: Do not reveal your apiKey and secretKey to anyone. They are as important as your password.

To prevent the request(s) from being tampered with during the process of network transmission, secretKey signature authentication via SHA256 is required to guarantee that you are the source of the request(s).

Follow this rule to create the signature string: ACE_SIGN + secret key + parameters values.

If your secret key is xxx, combine ACE_SIGN + xxx, to get ACE_SIGNxxx.
If your parameters are apiKey=ABC#2022&timeStamp=1671089108000&quoteCurrencyId=1&baseCurrencyId=2, take the values in apikey、baseCurrencyId、quoteCurrencyId、timeStamp natural alphabetic order, to get ABC#2022211671089108000.
Combine ACE_SIGNxxx + ABC#2022211671089108000, to get ACE_SIGNxxxABC#2022211671089108000
Sign the string with SHA256 to get 56c45e08e0e168e1bac13854f494f6009e17228c7da0024fea196bfcf3ba5ac0.
Place this result into the signKey parameter.

Global Response

Every Open Api has response header X-RESPONSE-TIME : {{now timestamp}}

Python Example

import requests
import time
import hashlib

# Replace with your api key
api_key = 'your api key'
# Replace with your security key
security_key = 'your security key'

request_params = {
  'apiKey': api_key,
  'timeStamp': int(time.time_ns() / 1000000),
  'duration': 1,
  'quoteCurrencyId': 1,
  'baseCurrencyId': 2,
  'startTime': None,
  'endTime': None,
  'limit': 10,
}

sign_key_string = 'ACE_SIGN'+ security_key

# Generate signKey:
# Step1: concat sorted request_params value string
sorted_keys = sorted(request_params.keys())
for key in sorted_keys:
  value = request_params.get(key)
  if value is not None:
    sign_key_string = sign_key_string+str(value)

# Step2: encoding sign_key_string by sha256
sign_key = hashlib.sha256(sign_key_string.encode('utf-8')).hexdigest()
# Step3: add sign_key to request_params
request_params['signKey'] = sign_key

get_price = requests.post("https://ace.io/polarisex/open/v2/kline/getKline",request_params)
print(get_price.json())

Order types:

BUY = 1
SELL = 2

Currency IDs

Up to date list is in Market Pair api.

TWD 1
BTC 2
ETH 4
LTC 7
XRP 10
TRX 13
USDT 14
BNB 17
BTTC 19
USDC 57
MOCT 66
DET 70
QQQ 72
HT 74
UNIC 75
QTC 76
FTT 81
BAAS 83
OKB 84
DAI 85
ACEX 88
LINK 89
DEC 90
HWGC 93
KNC 94
COMP 95
DS 96
CRO 97
CREAM 101
YFI 102
WNXM 103
MITH 104
SGB 106
ENJ 107
ANKR 108
MANA 109
SXP 110
CHZ 111
DOT 112
CAKE 114
SHIB 115
DOGE 116
MATIC 117
WOO 119
SLP 120
AXS 121
ADA 122
QUICK 123
FTM 124
YGG 126
GALA 127
ILV 128
DYDX 129
SOL 130
SAND 131
AVAX 132
LOOKS 133
APE 135
GMT 136
GST 139
TON 141
SSV 144
BUSD 145

Oapi API - Trade Data

GET https://ace.io/polarisex/oapi/v2/list/tradePrice

Response:

Key: <baseCurrencyName>/<quoteCurrencyName>

Value:

Name	Type	Description
base_volume	String	24hr volume
last_price	String	the newest price
quote_volume	String	24hr turnover, the unit is base on the base currency

{
    "BTC/USDT":{
        "base_volume": "229196.34035399999",
        "last_price": "11881.06",
        "quote_volume": "19.2909"
    }
}

Oapi API - Market Pair

GET https://ace.io/polarisex/oapi/v2/list/marketPair

Response:

Name	Type	Description
symbol	String
base	String	gmt/usdt, base is gmt
baseCurrencyId	String
quote	String	gmt/usdt, quote is usdt
quoteCurrencyId	String
basePrecision	String	the precision of base
quotePrecision	String	the precision of quote
minLimitBaseAmount	String	the minimal amount of base
maxLimitBaseAmount	String	the max amount of base

{
   "symbol":"BTC/USDT",
   "base":"gmt",
   "quote":"usdt",
   "basePrecision":"8",
   "quotePrecision":"5",
   "minLimitBaseAmount":"0.1",
   "maxLimitBaseAmount":"480286"
}

Open API - Order Books

GET https://ace.io/polarisex/open/v2/public/getOrderBook

Parameters:

Name	Type	Mandatory	Description
quoteCurrencyId	INT	YES
baseCurrencyId	INT	YES
depth	INT	NO	size of bids & asks, default: all

Response:

bids are buy orders, asks are sell orders. first value is volume and second value is price

{
    "attachment": {
        "baseCurrencyId": "2",
        "quoteCurrencyId": "14",
        "baseCurrencyName": "BTC",
        "quoteCurrencyName": "USDT",
        "bids": [
            [
                "0.0009",
                "19993.53"
            ],
            [
                "0.001",
                "19675.33"
            ],
            [
                "0.001",
                "19357.13"
            ]
        ],
        "asks": [
            [
                "0.001",
                "20629.92"
            ],
            [
                "0.001",
                "20948.12"
            ]
        ]
    },
    "message": null,
    "parameters": null,
    "status": 200
}

Open API - Account Balance

POST https://ace.io/polarisex/open/v2/coin/customerAccount

Parameters:

Name	Type	Mandatory
timeStamp	Long	YES
signKey	String	YES
apiKey	String	YES

Response:

Name	Type	Description
uid	INT	uid of ACE Exchange
currencyId	INT
currencyName	String
amount	String
cashAmount	String	available amount

{
  "attachment":[
    {
        "uid": 660,
        "currencyId": 2,
        "currencyName": "BTC",
        "amount": "9999999982.01768559",
        "cashAmount": "9999999982.01768559"
    }
  ],
  "status": 200,
  "message":null,
  "parameters":null
}

Open API - Kline/Candlestick data

POST https://ace.io/polarisex/open/v2/kline/getKline

Duration ENUM definitions:

1: 1 min
5: 5 mins
10: 10 mins
30: 30 mins
60: 1 hour
120: 2 hours
240: 4 hours
480: 8 hours
720: 12 hours
24: 1 day
70: 1 week
31: 1 month

Parameters:

Name	Type	Mandatory	Description
timeStamp	Long	YES
signKey	String	YES
apiKey	String	YES
duration	INT	NO	please checkout duration enum
quoteCurrencyId	INT	YES
baseCurrencyId	INT	YES
startTime	Timestamp	NO
endTime	Timestamp	NO
limit	INT	NO	1~2000, default is 2000

Response:

Name	Type	Description
current	String	current price
volume	String	trade volume of this line
changeRate	String	change rate of this line
highPrice	String	high price of this line
lowPrice	String	low price of this line
openPrice	String	open price of this line
closePrice	String	close price of this line
currentTime	Int	current timestamp, the scale is second
createTime	Int	create time, date string format

{
    "attachment": [
        {
            "current": "533501.38",
            "volume": "0",
            "changeRate": "0",
            "highPrice": "533501.38",
            "lowPrice": "533501.38",
            "openPrice": "533501.38",
            "closePrice": "533501.38",
            "currentTime": 1670359560000,
            "createTime": "2022-12-07 04:46:00"
        }
    ],
    "message": null,
    "parameters": null,
    "status": 200
}

Open API - New Order

POST https://ace.io/polarisex/open/v2/order/order

Parameters:

Name	Type	Mandatory	Description
baseCurrencyId	String	YES
quoteCurrencyId	String	YES
buyOrSell	INT	YES	1. Buy 2. Sell
price	String	No	Only order type 1 need
num	String	No	order type 1 & 2
customOrderId	String	NO	Any string of length up to 32 characters.
amount	String	No	Only order type 3 and buy
type	INT	YES	1. limit price order 2. num market order 3. amount market order
apiKey	String	YES
timeStamp	Long	YES
signKey	String	YES

Response:

Name	Type	Description
orderNo	String	order number of created order
customOrderId	String	custom order id.

{
    "attachment": {
        "orderNo": "16708172598046170050801100274092",
        "customOrderId": "axyz1234"
    },
    "message": null,
    "parameters": null,
    "status": 200
}

Open API - Cancel Order

POST https://ace.io/polarisex/open/v2/order/cancel

Parameters:

Name	Type	Mandatory
orderNo	STRING	YES
apiKey	STRING	YES
timeStamp	Long	YES
signKey	String	YES

Response:

if attachment is 200, it's success of  cancelling order.

{
    "attachment": 200,
    "message": null,
    "parameters": null,
    "status": 200
}

OR

{
    "attachment": null,
    "message": "委託單已成交或已撤銷",
    "parameters": null,
    "status": 2061
}

Open API - Order List

POST https://ace.io/polarisex/open/v2/order/getOrderList

Parameters:

Name	Type	Mandatory	Description
timeStamp	Long	YES
signKey	String	YES
apiKey	String	YES
baseCurrencyId	INT	NO
quoteCurrencyId	INT	NO
start	INT	NO	Default 1
size	INT	NO	1-500 Default 10

Response:

Name	Type	Description
status	INT	0. unsettled, 1. partial settled, 2. settled, 4. canceled, 5. partial canceled
buyOrSell	INT	1. Buy, 2. Sell

{
    "attachment": [
        {
            "uid": 660,
            "orderNo": "16697164905200431470851100284369",
            "orderTime": "2022-11-29 18:08:06",
            "orderTimeStamp": 1669716486980,
            "quoteCurrencyId": 1,
            "quoteCurrencyName": "TWD",
            "baseCurrencyId": 2,
            "baseCurrencyName": "BTC",
            "buyOrSell": "1",
            "num": "1.0000000000000000",
            "price": "490849.7500000000000000",
            "remainNum": "1.0000000000000000",
            "tradeNum": "0.0000000000000000",
            "tradePrice": "0.0000000000000000",
            "tradeAmount": "0.000000000000000000000000000000",
            "tradeRate": "0.00000000000000000000",
            "status": 0,
            "type": 1,
            "customOrderId": "axyz1234"
        }
    ],
    "message": null,
    "parameters": null,
    "status": 200
}

Open API - Order Status

POST https://ace.io/polarisex/open/v2/order/showOrderStatus

Parameters:

Name	Type	Mandatory
orderNo	STRING	YES
apiKey	STRING	YES
timeStamp	Long	YES
signKey	String	YES

Response:

Name	Type	Description
status	INT	0. unsettled, 1. partial settled, 2. settled, 4. canceled, 5. partial canceled
buyOrSell	INT	1. Buy, 2. Sell

{
    "attachment": {
        "buyOrSell": 1,
        "averagePrice": "490849.75000000",
        "num": "0.00000000",
        "orderTime": "2022-11-29 18:03:06.318",
        "price": "490849.75000000",
        "status": 4,
        "tradeNum": "0.02697000",
        "remainNum": "0.97303000",
        "baseCurrencyId": 2,
        "baseCurrencyName": "BTC",
        "quoteCurrencyId": 1,
        "quoteCurrencyName": "TWD",
        "orderNo": "16697161898600391472461100244406",
        "customOrderId": "axyz1234"
    },
    "message": null,
    "parameters": null,
    "status": 200
}

Open API - Order History

POST https://ace.io/polarisex/open/v2/order/showOrderHistory

Parameters:

Name	Type	Mandatory
orderNo	STRING	YES
apiKey	STRING	YES
timeStamp	Long	YES
signKey	String	YES

Response:

Name	Type	Description
status	INT	0. unsettled, 1. partial settled, 2. settled, 4. canceled, 5. partial canceled
buyOrSell	INT	1. Buy, 2. Sell

{
    "attachment": {
        "order": {
            "buyOrSell": 1,
            "averagePrice": "491343.74000000",
            "num": "1.00000000",
            "orderTime": "2022-11-29 18:32:22.232",
            "price": "491343.74000000",
            "status": 1,
            "tradeNum": "0.01622200",
            "remainNum": "0.98377800",
            "baseCurrencyId": 2,
            "baseCurrencyName": "BTC",
            "quoteCurrencyId": 1,
            "quoteCurrencyName": "TWD",
            "orderNo": "16697179457740441472471100214402",        
            "customOrderId": "axyz1234"
        },
        "trades": [
            {
                "price": "491343.74000000",
                "num": "0.01622200",
                "time": "2022-11-29 18:32:25.789",
                "tradeNo": "16697179457897791471461000223437",
                "amount": "7970.57815028"
            }
        ]
    },
    "message": null,
    "parameters": null,
    "status": 200
}

Open API - Trade List

POST https://ace.io/polarisex/open/v2/order/getTradeList

Parameters:

Name	Type	Mandatory	Description
timeStamp	Long	YES
signKey	String	YES
apiKey	String	YES
baseCurrencyId	INT	NO
quoteCurrencyId	INT	NO
buyOrSell	INT	NO	1. Buy, 2. Sell
start	INT	NO	Default 1
size	INT	NO	1-500 Default 10
startTime	TIMESTAMP	NO
startTradeNo	STRING	NO	TradeNo is linear, as like startTime, can search from startTradeNo

Response:

Name	Type	Description
status	INT	0. unsettled, 1. partial settled, 2. settled, 4. canceled, 5. partial canceled
buyOrSell	INT	1. Buy, 2. Sell

{
    "attachment": [
        {
            "buyOrSell": 1,
            "orderNo": "16708156853695560053601100247906",
            "num": "1",
            "price": "16895",
            "orderAmount": "16895",
            "tradeNum": "0.1",
            "tradePrice": "16895",
            "tradeAmount": "1689.5",
            "fee": "0",
            "feeSave": "0",
            "status": 1,
            "isSelf": false,
            "tradeNo": "16708186395087940051961000274150",
            "tradeTime": "2022-12-12 12:17:19",
            "tradeTimestamp": 1670818639508,
            "quoteCurrencyId": 14,
            "quoteCurrencyName": "USDT",
            "baseCurrencyId": 2,
            "baseCurrencyName": "BTC",        
            "customOrderId": "axyz1234",
            "isMaker": True,   //maker or taker
            
        }
    ],
    "message": null,
    "parameters": null,
    "status": 200
}

Files

api_v2.md

Latest commit

History

api_v2.md

File metadata and controls

Version 2 General API Information

Signing API Requests

Global Response

Python Example

Order types:

Currency IDs

Up to date list is in Market Pair api.

Oapi API - Trade Data

Response:

Oapi API - Market Pair

Response:

Open API - Order Books

Parameters:

Response:

Open API - Account Balance

Parameters:

Response:

Open API - Kline/Candlestick data

Duration ENUM definitions:

Parameters:

Response:

Open API - New Order

Parameters:

Response:

Open API - Cancel Order

Parameters:

Response:

Open API - Order List

Parameters:

Response:

Open API - Order Status

Parameters:

Response:

Open API - Order History

Parameters:

Response:

Open API - Trade List

Parameters:

Response: