API Documentation

API for Aurix Exchange.

Basic Details

Base URLhttps://www.aurix.exchange/api/v2/peatio/

/public/health/ready

GET

Description:

Get application readiness status

Responses
CodeDescription
200Get application readiness status

/public/health/alive

GET

Description:

Get application liveness status

Responses
CodeDescription
200Get application liveness status

/public/markets/{market}/tickers

GET

Description:

Get ticker of specific market.

Parameters
NameLocated inDescriptionRequiredSchema
marketpathYesstring
Responses
CodeDescriptionSchema
200Get ticker of specific market.Ticker

/public/markets/tickers

GET

Description:

Get ticker of all markets (For response doc see /:market/tickers/ response).

Responses
CodeDescriptionSchema
200Get ticker of all markets (For response doc see /:market/tickers/ response).Ticker

/public/markets/{market}/k-line

GET

Description:

Get OHLC(k line) of specific market.

Parameters
NameLocated inDescriptionRequiredSchema
marketpathYesstring
periodqueryTime period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080Nointeger
time_fromqueryAn integer represents the seconds elapsed since Unix epoch. If set, only k-line data after that time will be returned.Nointeger
time_toqueryAn integer represents the seconds elapsed since Unix epoch. If set, only k-line data till that time will be returned.Nointeger
limitqueryLimit the number of returned data points default to 30. Ignored if time_from and time_to are given.Nointeger
Responses
CodeDescription
200Get OHLC(k line) of specific market.

/public/markets/{market}/depth

GET

Description:

Get depth or specified market. Both asks and bids are sorted from highest price to lowest.

Parameters
NameLocated inDescriptionRequiredSchema
marketpathYesstring
limitqueryLimit the number of returned price levels. Default to 300.Nointeger
Responses
CodeDescription
200Get depth or specified market. Both asks and bids are sorted from highest price to lowest.

/public/markets/{market}/trades

GET

Description:

Get recent trades on market, each trade is included only once. Trades are sorted in reverse creation order.

Parameters
NameLocated inDescriptionRequiredSchema
marketpathYesstring
limitqueryLimit the number of returned trades. Default to 100.Nointeger
timestampqueryAn integer represents the seconds elapsed since Unix epoch.If set, only trades executed before the time will be returned.Nointeger
order_byqueryIf set, returned trades will be sorted in specific order, default to 'desc'.Nostring
Responses
CodeDescriptionSchema
200Get recent trades on market, each trade is included only once. Trades are sorted in reverse creation order.[Trade]

/public/markets/{market}/order-book

GET

Description:

Get the order book of specified market.

Parameters
NameLocated inDescriptionRequiredSchema
marketpathYesstring
asks_limitqueryLimit the number of returned sell orders. Default to 20.Nointeger
bids_limitqueryLimit the number of returned buy orders. Default to 20.Nointeger
Responses
CodeDescriptionSchema
200Get the order book of specified market.[OrderBook]

/public/markets

GET

Description:

Get all available markets.

Parameters
NameLocated inDescriptionRequiredSchema
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
orderingqueryIf set, returned values will be sorted in specific order, defaults to 'asc'.Nostring
order_byqueryName of the field, which result will be ordered by.Nostring
base_unitqueryStrict filter for base unitNostring
quote_unitqueryStrict filter for quote unitNostring
searchqueryNojson
search[base_code]querySearch base currency code using LIKENostring
search[quote_code]querySearch qoute currency code using LIKENostring
search[base_name]querySearch base currency name using LIKENostring
search[quote_name]querySearch quote currency name using LIKENostring
Responses
CodeDescriptionSchema
200Get all available markets.[Market]

/public/currencies

GET

Description:

Get list of currencies

Parameters
NameLocated inDescriptionRequiredSchema
limitqueryLimit the number of returned paginations. Defaults to 100.Nointeger
pagequerySpecify the page of paginated results.Nointeger
typequeryCurrency typeNostring
Responses
CodeDescriptionSchema
200Get list of currencies[Currency]

/public/currencies/{id}

GET

Description:

Get a currency

Parameters
NameLocated inDescriptionRequiredSchema
idpathCurrency code.Yesstring
Responses
CodeDescriptionSchema
200Get a currencyCurrency

Models

TradingFee

Returns trading_fees table as paginated collection

NameTypeDescriptionRequired
idintegerUnique trading fee table identifier in database.No
groupstringMember group for define maker/taker fee.No
market_idstringMarket id for define maker/taker fee.No
makerdoubleMarket maker fee.No
takerdoubleMarket taker fee.No
created_atstringTrading fee table created time in iso8601 format.No
updated_atstringTrading fee table updated time in iso8601 format.No

Ticker

Get ticker of all markets (For response doc see /:market/tickers/ response).

NameTypeDescriptionRequired
atintegerTimestamp of tickerNo
tickerTickerEntryTicker entry for specified timeNo

TickerEntry

NameTypeDescriptionRequired
lowdoubleThe lowest trade price during last 24 hours (0.0 if no trades executed during last 24 hours)No
highdoubleThe highest trade price during last 24 hours (0.0 if no trades executed during last 24 hours)No
opendoublePrice of the first trade executed 24 hours ago or lessNo
lastdoubleThe last executed trade priceNo
volumedoubleTotal volume of trades executed during last 24 hoursNo
amountdoubleTotal amount of trades executed during last 24 hoursNo
voldoubleAlias to volumeNo
avg_pricedoubleAverage price more precisely VWAP is calculated by adding up the total traded for every transaction(price multiplied by the number of shares traded) and then dividing by the total shares tradedNo
price_change_percentstringPrice change in the next format +3.19%.Price change is calculated using next formula (last - open) / open * 100%No
atintegerTimestamp of tickerNo

Trade

Get your executed trades. Trades are sorted in reverse creation order.

NameTypeDescriptionRequired
idstringTrade ID.No
pricedoubleTrade price.No
amountdoubleTrade amount.No
totaldoubleTrade total (Amount * Price).No
fee_currencydoubleCurrency user's fees were charged in.No
feedoublePercentage of fee user was charged for performed trade.No
fee_amountdoubleAmount of fee user was charged for performed trade.No
marketstringTrade market id.No
created_atstringTrade create time in iso8601 format.No
taker_typestringTrade taker order type (sell or buy).No
sidestringTrade side.No
order_idintegerOrder id.No

OrderBook

Get the order book of specified market.

NameTypeDescriptionRequired
asks[Order]Asks in orderbookNo
bids[Order]Bids in orderbookNo

Order

Get your orders, result is paginated.

NameTypeDescriptionRequired
idintegerUnique order id.No
uuidstringUnique order UUID.No
sidestringEither 'sell' or 'buy'.No
ord_typestringType of order, either 'limit' or 'market'.No
pricedoublePrice for each unit. e.g.If you want to sell/buy 1 btc at 3000 usd, the price is '3000.0'No
avg_pricedoubleAverage execution price, average of price in trades.No
statestringOne of 'wait', 'done', or 'cancel'.An order in 'wait' is an active order, waiting fulfillment;a 'done' order is an order fulfilled;'cancel' means the order has been canceled.No
marketstringThe market in which the order is placed, e.g. 'btcusd'.All available markets can be found at /api/v2/markets.No
created_atstringOrder create time in iso8601 format.No
updated_atstringOrder updated time in iso8601 format.No
origin_volumedoubleThe amount user want to sell/buy.An order could be partially executed,e.g. an order sell 5 btc can be matched with a buy 3 btc order,left 2 btc to be sold; in this case the order's volume would be '5.0',its remaining_volume would be '2.0', its executed volume is '3.0'.No
remaining_volumedoubleThe remaining volume, see 'volume'.No
executed_volumedoubleThe executed volume, see 'volume'.No
trades_countintegerCount of trades.No
trades[Trade]Trades wiht this order.No

Market

Get all available markets.

NameTypeDescriptionRequired
idstringUnique market id. It's always in the form of xxxyyy,where xxx is the base currency code, yyy is the quotecurrency code, e.g. 'btcusd'. All available markets canbe found at /api/v2/markets.No
namestringMarket name.No
base_unitstringMarket Base unit.No
quote_unitstringMarket Quote unit.No
min_pricedoubleMinimum order price.No
max_pricedoubleMaximum order price.No
min_amountdoubleMinimum order amount.No
amount_precisiondoublePrecision for order amount.No
price_precisiondoublePrecision for order price.No
statestringMarket state defines if user can see/trade on current market.No

Currency

Get a currency

NameTypeDescriptionRequired
idstringCurrency code.No
namestringCurrency nameNo
symbolstringCurrency symbolNo
explorer_transactionstringCurrency transaction exprorer url templateNo
explorer_addressstringCurrency address exprorer url templateNo
typestringCurrency typeNo
deposit_enabledstringCurrency deposit possibility status (true/false).No
withdrawal_enabledstringCurrency withdrawal possibility status (true/false).No
deposit_feestringCurrency deposit feeNo
min_deposit_amountstringMinimal deposit amountNo
withdraw_feestringCurrency withdraw feeNo
min_withdraw_amountstringMinimal withdraw amountNo
withdraw_limit_24hstringCurrency 24h withdraw limitNo
withdraw_limit_72hstringCurrency 72h withdraw limitNo
base_factorstringCurrency base factorNo
precisionstringCurrency precisionNo
positionstringPosition used for defining currencies orderNo
icon_urlstringCurrency iconNo
min_confirmationsstringNumber of confirmations required for confirming deposit or withdrawalNo