API Documentation
API for Aurix Exchange.
Basic Details
| Authentication/Identity URL | https://www.aurix.exchange/api/v2/auth |
|---|---|
| Trading URL | https://www.aurix.exchange/api/v2/trading |
| WebSocket URL | wss://www.aurix.exchange/api/v2/ws |
/public/withdraw_limits
GET
Description:
Returns withdraw limits table as paginated collection
Parameter
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| group | query | Member group for define withdraw limits. | No | string |
| kyc_level | query | KYC level for define withdraw limits. | No | string |
| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
| ordering | query | If set, returned values will be sorted in specific order, defaults to 'asc'. | No | string |
| order_by | query | Name of the field, which result will be ordered by. | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get application readiness status | [WithdrawalLimit] |
/public/webhooks/{adapter}/{event}
POST
Description:
Webhook controller
Parameter
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| adapter | path | Name of adapter for process webhook | Yes | string |
| event | path | Name of event can be deposit or withdraw | Yes | string |
Responses
| Code | Description |
|---|---|
| 201 | Webhook controller |
/public/trading_fees
GET
Description:
Returns trading_fees table as paginated collection
Parameter
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| group | query | Member group for define maker/taker fee. | No | string |
| market_id | query | Market id for define maker/taker fee. | No | string |
| market_type | query | No | string | |
| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
| ordering | query | If set, returned values will be sorted in specific order, defaults to 'asc'. | No | string |
| order_by | query | Name of the field, which result will be ordered by. | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Returns trading_fees table as paginated collection | [TradingFees] |
/public/health/ready
GET
Description:
Get application readiness status
Responses
| Code | Description |
|---|---|
| 200 | Get application readiness status |
/public/health/alive
GET
Description:
Get application liveness status
Responses
| Code | Description |
|---|---|
| 200 | Get application liveness status |
/public/version
GET
Description:
Get running Peatio version and build details.
Responses
| Code | Description |
|---|---|
| 200 | Get running Peatio version and build details. |
/public/timestamp
GET
Description:
Get server current time, in seconds since Unix epoch.
Responses
| Code | Description |
|---|---|
| 200 | Get server current time, in seconds since Unix epoch. |
/public/member-levels
GET
Description:
Returns hash of minimum levels and the privileges they provide.
Responses
| Code | Description |
|---|---|
| 200 | Returns hash of minimum levels and the privileges they provide. |
/public/markets/{market}/tickers
GET
Description:
Get ticker of specific market.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | path | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get ticker of specific market. | Ticker |
/public/markets/tickers
GET
Description:
Get ticker of all markets (For response doc see /:market/tickers/ response).
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get 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
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | path | Yes | string | |
| period | query | Time period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080 | No | integer |
| time_from | query | An integer represents the seconds elapsed since Unix epoch. If set, only k-line data after that time will be returned. | No | integer |
| time_to | query | An integer represents the seconds elapsed since Unix epoch. If set, only k-line data till that time will be returned. | No | integer |
| limit | query | Limit the number of returned data points default to 30. Ignored if time_from and time_to are given. | No | integer |
Responses
| Code | Description |
|---|---|
| 200 | Get 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
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | path | Yes | string | |
| limit | query | Limit the number of returned price levels. Default to 300. | No | integer |
Responses
| Code | Description |
|---|---|
| 200 | Get 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
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | path | Yes | string | |
| limit | query | Limit the number of returned trades. Default to 100. | No | integer |
| timestamp | query | An integer represents the seconds elapsed since Unix epoch.If set, only trades executed before the time will be returned. | No | integer |
| order_by | query | If set, returned trades will be sorted in specific order, default to 'desc'. | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get 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
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | path | Yes | string | |
| asks_limit | query | Limit the number of returned sell orders. Default to 20. | No | integer |
| bids_limit | query | Limit the number of returned buy orders. Default to 20. | No | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get the order book of specified market. | [OrderBook] |
/public/markets
GET
Description:
Get all available markets.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
| ordering | query | If set, returned values will be sorted in specific order, defaults to 'asc'. | No | string |
| order_by | query | Name of the field, which result will be ordered by. | No | string |
| base_unit | query | Strict filter for base unit | No | string |
| quote_unit | query | Strict filter for quote unit | No | string |
| search | query | No | json | |
| search[base_code] | query | Search base currency code using LIKE | No | string |
| search[quote_code] | query | Search qoute currency code using LIKE | No | string |
| search[base_name] | query | Search base currency name using LIKE | No | string |
| search[quote_name] | query | Search quote currency name using LIKE | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get all available markets. | [Market] |
/public/currencies
GET
Description:
Get list of currencies
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
| type | query | Currency type | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get list of currencies | [Currency] |
/public/currencies/{id}
GET
Description:
Get a currency
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Currency code. | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get a currency | Currency |
/account/internal_transfers
POST
Description:
Creates internal transfer.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | formData | The currency code.. | Yes | string |
| amount | formData | The amount to transfer. | Yes | double |
| otp | formData | OTP to perform action | Yes | integer |
| username_or_uid | formData | Receiver uid or username. | Yes | string |
Responses
| Code | Description |
|---|---|
| 201 | Creates internal transfer. |
GET
Description:
List your internal transfers as paginated collection.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | query | Currency code. | No | string |
| state | query | The state to filter by. | No | string |
| sender | query | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | List your internal transfers as paginated collection. | [InternalTransfer] |
/account/stats/pnl
GET
Description:
Get assets pnl calculated into one currency
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| pnl_currency | query | Currency code in which the PnL is calculated | No | string |
Responses
| Code | Description |
|---|---|
| 200 | Get assets pnl calculated into one currency |
/account/transactions
GET
Description:
Get your transactions history.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | query | Currency code | No | string |
| order_by | query | Sorting order | No | string |
| time_from | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
| time_to | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
| deposit_state | query | Filter deposits by states. | No | string |
| withdraw_state | query | Filter withdraws by states. | No | string |
| txid | query | Transaction id. | No | string |
| limit | query | Limit the number of returned transactions. Default to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
Responses
| Code | Description |
|---|---|
| 200 | Get your transactions history. |
/account/withdraws
POST
Description:
Creates new withdrawal to active beneficiary.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| otp | formData | OTP to perform action | No | integer |
| beneficiary_id | formData | ID of Active Beneficiary belonging to user. | No | integer |
| currency | formData | The currency code. | No | string |
| amount | formData | The amount to withdraw. | No | double |
| note | formData | Optional user metadata to be applied to the transaction. Used to tag transactions with memorable comments. | No | string |
Responses
| Code | Description |
|---|---|
| 201 | Creates new withdrawal to active beneficiary. |
GET
Description:
List your withdraws as paginated collection.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | query | Currency code. | No | string |
| limit | query | Number of withdraws per page (defaults to 100, maximum is 100). | No | integer |
| state | query | Filter withdrawals by states. | No | string |
| rid | query | Wallet address on the Blockchain. | No | string |
| time_from | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
| time_to | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
| page | query | Page number (defaults to 1). | No | integer |
Responses
| Code | Description | |
|---|---|---|
| 200 | List your withdraws as paginated collection. | Withdraw |
/account/withdraws/sums
DELETE
Description:
Returns withdrawal sums for last 4 hours and 1 month
Responses
| Code | Description |
|---|---|
| 200 | Returns withdrawal sums for last 4 hours and 1 month |
/account/beneficiaries/{id}
DELETE
Description:
Delete beneficiary
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Beneficiary Identifier in Database | Yes | integer |
Responses
| Code | Description |
|---|---|
| 204 | Delete beneficiary |
GET
Description:
Get beneficiary by ID
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Beneficiary Identifier in Database | Yes | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get beneficiary by ID | Beneficiary |
/account/beneficiaries/{id}/activate
PATCH
Description:
Activates beneficiary with pin
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Beneficiary Identifier in Database | Yes | integer |
| pin | formData | Pin code for beneficiary activation | Yes | integer |
Responses
| Code | Description | |
|---|---|---|
| 200 | Activates beneficiary with pin | Beneficiary |
/account/beneficiaries/{id}/resend_pin
PATCH
Description:
Resend beneficiary pin
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Beneficiary Identifier in Database | Yes | integer |
Responses
| Code | Description |
|---|---|
| 200 | Resend beneficiary pin |
/account/beneficiaries
POST
Description:
Create new beneficiary.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | formData | Beneficiary currency code. | Yes | string |
| name | formData | Human rememberable name which refer beneficiary. | Yes | string |
| description | formData | Human rememberable name which refer beneficiary. | No | string |
| data | formData | Beneficiary data in JSON format. | Yes | json |
Responses
| Code | Description | Schema |
|---|---|---|
| 201 | Create new beneficiary | Beneficiary |
GET
Description:
Get list of user beneficiaries
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
| currency | query | Beneficiary currency code. | No | string |
| state | query | Defines either beneficiary active - user can use it to withdraw moneyor pending - requires beneficiary activation with pin. | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get list of user beneficiaries | Beneficiary |
/account/deposits_address/{currency}
GET
Description:
Returns deposit address for account you want to deposit to by currency. The address may be blank because address generation process is still in progress. If this case you should try again later.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | path | The account you want to deposit to | Yes | string |
| address_format | query | Address format legacy/cash | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Returns deposit address for account you want to deposit to by currency. The address may be blank because address generation process is still in progress. If this case you should try again later. | Deposit |
/account/deposits/{txid}
GET
Description:
Get details of specific deposit.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| txid | path | Deposit transaction id | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get details of specific deposit. | Deposit |
/account/deposits
GET
Description:
Get your deposits history.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | query | Currency code | No | string |
| state | query | Filter deposits by states. | No | string |
| txid | query | Deposit transaction id. | No | string |
| time_from | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
| time_to | query | An integer represents the seconds elapsed since Unix epoch. | No | integer |
| limit | query | Number of deposits per page (defaults to 100, maximum is 100). | No | integer |
| page | query | Page number (defaults to 1). | No | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get your deposits history. | Deposit |
/account/balances/{currency}
GET
Description:
Get user account by currency
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| currency | path | The currency code. | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get user account by currency | Account |
/account/balances
GET
Description:
Get list of user accounts.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| limit | query | Limit the number of returned paginations. Defaults to 100. | No | integer |
| page | query | Specify the page of paginated results.. | No | integer |
| nonzero | query | Filter non zero balances. | No | Boolean |
| state | query | Filter deposits by states. | No | string |
| search | query | No | json | |
| search[currency_code] | query | No | string | |
| search[currency_name] | query | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get list of user accounts | Account |
/market/trades
GET
Description:
Get your executed trades. Trades are sorted in reverse creation order.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | query | No | string | |
| market_type | query | No | string | |
| limit | query | Limit the number of returned trades. Default to 100. | No | integer |
| page | query | Specify the page of paginated results.. | No | integer |
| type | query | To indicate nature of trade - buy/sell. | No | string |
| time_from | query | An integer represents the seconds elapsed since Unix epoch.If set, only trades executed after the time will be returned. | No | integer |
| time_to | query | An integer represents the seconds elapsed since Unix epoch.If set, only trades executed before the time will be returned. | No | integer |
| order_by | query | If set, returned trades will be sorted in specific order, default to 'desc' | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get your executed trades. Trades are sorted in reverse creation order. | Trade |
/market/orders/cancel
GET
Description:
Cancel all my orders.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | formData | No | string | |
| market_type | formData | No | string | |
| side | formData | If present, only sell orders (asks) or buy orders (bids) will be cancelled. | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 201 | Cancel all my orders. | Order |
/market/orders/{id}/cancel
POST
Description:
Cancel an order.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 201 | Cancel an order. |
/market/orders
POST
Description:
Create a Sell/Buy order.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | formData | Yes | string | |
| side | formData | Yes | string | |
| volume | formData | Yes | double | |
| ord_type | formData | No | string | |
| price | formData | Yes | double |
Responses
| Code | Description | Schema |
|---|---|---|
| 201 | Create a Sell/Buy order. | Order |
GET
Description:
Get your orders, result is paginated
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market | query | No | string | |
| market_type | query | No | string | |
| base_unit | query | No | string | |
| quote_unit | query | No | string | |
| state | query | Filter order by state. | No | string |
| limit | query | Limit the number of returned orders, default to 100. | No | integer |
| page | query | Specify the page of paginated results. | No | integer |
| order_by | query | If set, returned orders will be sorted in specific order, default to "desc". | No | string |
| ord_type | query | Filter order by ord_type. | No | string |
| type | query | Filter order by type. | No | string |
| time_from | query | An integer represents the seconds elapsed since Unix epoch.If set, only orders created after the time will be returned. | No | integer |
| time_to | query | An integer represents the seconds elapsed since Unix epoch.If set, only orders created before the time will be returned. | No | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get your orders, result is paginated | Order |
/market/orders/{id}
GET
Description:
Get information of specified order.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get information of specified order. | Order |
/coinmarketcap/orderbook/{market_pair}
GET
Description:
Get depth or specified market
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ticker_id | query | A pair such as "LTC_BTC" | Yes | string |
| depth | query | Orders depth quantity: [0, 100, 200, 500...] | No | integer |
Responses
| Code | Description |
|---|---|
| 200 | Get depth or specified market |
/coinmarketcap/trades/{market_pair}
GET
Description:
Get recent trades on market
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| market_pair | path | A pair such as "LTC_BTC" | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get recent trades on market | Trade |
/coinmarketcap/ticker
GET
Description:
Get 24-hour pricing and volume summary for each market pair
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get 24-hour pricing and volume summary for each market pair | Ticker |
/coinmarketcap/assets
GET
Description:
Details on crypto currencies available on the exchange
Responses
| Code | Description |
|---|---|
| 200 | Details on crypto currencies available on the exchange |
/coinmarketcap/summary
GET
Description:
Overview of market data for all tickers and all market pairs on the exchange
Responses
| Code | Description |
|---|---|
| 200 | Overview of market data for all tickers and all market pairs on the exchange |
/coingecko/historical_trades
GET
Description:
Get recent trades on market
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ticker_id | query | A pair such as "LTC_BTC" | Yes | string |
| type | query | To indicate nature of trade - buy/sell | No | string |
| limit | query | Number of historical trades to retrieve from time of query. [0, 200, 500...]. 0 returns full history | Yes | integer |
| start_time | query | No | integer | |
| end_time | query | Yes | integer |
Responses
| Code | Description |
|---|---|
| 200 | Get recent trades on market |
/coingecko/orderbook
GET
Description:
Get depth or specified market
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ticker_id | query | A pair such as "LTC_BTC" | Yes | string |
| depth | query | Orders depth quantity: [0, 100, 200, 500...] | No | integer |
Responses
| Code | Description |
|---|---|
| 200 | Get depth or specified market |
/coingecko/tickers
GET
Description:
Get list of all available trading pairs
Responses
| Code | Description |
|---|---|
| 200 | Get list of all available trading pairs |
/coingecko/pairs
GET
Description:
Get list of all available trading pairs
Responses
| Code | Description |
|---|---|
| 200 | Get list of all available trading pairs |
Models
TradingFee
Returns trading_fees table as paginated collection
| Name | Type | Description | Required |
|---|---|---|---|
| id | integer | Unique trading fee table identifier in database. | No |
| group | string | Member group for define maker/taker fee. | No |
| market_id | string | Market id for define maker/taker fee. | No |
| maker | double | Market maker fee. | No |
| taker | double | Market taker fee. | No |
| created_at | string | Trading fee table created time in iso8601 format. | No |
| updated_at | string | Trading fee table updated time in iso8601 format. | No |
Ticker
Get ticker of all markets (For response doc see /:market/tickers/ response).
| Name | Type | Description | Required |
|---|---|---|---|
| at | integer | Timestamp of ticker | No |
| ticker | TickerEntry | Ticker entry for specified time | No |
TickerEntry
| Name | Type | Description | Required |
|---|---|---|---|
| low | double | The lowest trade price during last 24 hours (0.0 if no trades executed during last 24 hours) | No |
| high | double | The highest trade price during last 24 hours (0.0 if no trades executed during last 24 hours) | No |
| open | double | Price of the first trade executed 24 hours ago or less | No |
| last | double | The last executed trade price | No |
| volume | double | Total volume of trades executed during last 24 hours | No |
| amount | double | Total amount of trades executed during last 24 hours | No |
| vol | double | Alias to volume | No |
| avg_price | double | Average 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 traded | No |
| price_change_percent | string | Price change in the next format +3.19%.Price change is calculated using next formula (last - open) / open * 100% | No |
| at | integer | Timestamp of ticker | No |
Trade
Get your executed trades. Trades are sorted in reverse creation order.
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | Trade ID. | No |
| price | double | Trade price. | No |
| amount | double | Trade amount. | No |
| total | double | Trade total (Amount * Price). | No |
| fee_currency | double | Currency user's fees were charged in. | No |
| fee | double | Percentage of fee user was charged for performed trade. | No |
| fee_amount | double | Amount of fee user was charged for performed trade. | No |
| market | string | Trade market id. | No |
| created_at | string | Trade create time in iso8601 format. | No |
| taker_type | string | Trade taker order type (sell or buy). | No |
| side | string | Trade side. | No |
| order_id | integer | Order id. | No |
OrderBook
Get the order book of specified market.
| Name | Type | Description | Required |
|---|---|---|---|
| asks | [Order] | Asks in orderbook | No |
| bids | [Order] | Bids in orderbook | No |
Order
Get your orders, result is paginated.
| Name | Type | Description | Required |
|---|---|---|---|
| id | integer | Unique order id. | No |
| uuid | string | Unique order UUID. | No |
| side | string | Either 'sell' or 'buy'. | No |
| ord_type | string | Type of order, either 'limit' or 'market'. | No |
| price | double | Price for each unit. e.g.If you want to sell/buy 1 btc at 3000 usd, the price is '3000.0' | No |
| avg_price | double | Average execution price, average of price in trades. | No |
| state | string | One 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 |
| market | string | The market in which the order is placed, e.g. 'btcusd'.All available markets can be found at /api/v2/markets. | No |
| created_at | string | Order create time in iso8601 format. | No |
| updated_at | string | Order updated time in iso8601 format. | No |
| origin_volume | double | The 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_volume | double | The remaining volume, see 'volume'. | No |
| executed_volume | double | The executed volume, see 'volume'. | No |
| trades_count | integer | Count of trades. | No |
| trades | [Trade] | Trades wiht this order. | No |
Market
Get all available markets.
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | Unique 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 |
| name | string | Market name. | No |
| base_unit | string | Market Base unit. | No |
| quote_unit | string | Market Quote unit. | No |
| min_price | double | Minimum order price. | No |
| max_price | double | Maximum order price. | No |
| min_amount | double | Minimum order amount. | No |
| amount_precision | double | Precision for order amount. | No |
| price_precision | double | Precision for order price. | No |
| state | string | Market state defines if user can see/trade on current market. | No |
Currency
Get a currency
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | Currency code. | No |
| name | string | Currency name | No |
| symbol | string | Currency symbol | No |
| explorer_transaction | string | Currency transaction exprorer url template | No |
| explorer_address | string | Currency address exprorer url template | No |
| type | string | Currency type | No |
| deposit_enabled | string | Currency deposit possibility status (true/false). | No |
| withdrawal_enabled | string | Currency withdrawal possibility status (true/false). | No |
| deposit_fee | string | Currency deposit fee | No |
| min_deposit_amount | string | Minimal deposit amount | No |
| withdraw_fee | string | Currency withdraw fee | No |
| min_withdraw_amount | string | Minimal withdraw amount | No |
| withdraw_limit_24h | string | Currency 24h withdraw limit | No |
| withdraw_limit_72h | string | Currency 72h withdraw limit | No |
| base_factor | string | Currency base factor | No |
| precision | string | Currency precision | No |
| position | string | Position used for defining currencies order | No |
| icon_url | string | Currency icon | No |
| min_confirmations | string | Number of confirmations required for confirming deposit or withdrawal | No |
InternalTransfer
List your internal transfers as paginated collection.
| Name | Type | Description | Required |
|---|---|---|---|
| currency | string | The currency code. | No |
| sender_username | string | The internal transfer sender. | No |
| receiver_username | string | The internal transfer receiver. | No |
| sender_uid | string | The internal transfer sender. | No |
| receiver_uid | string | The internal transfer receiver. | No |
| direction | double | The internal transfer direction (incoming or outcoming internal transfer). | No |
| amount | double | Internal transfer Amount. | No |
| status | string | The internal transfer state. | No |
| created_at | string | The datetimes for the internal transfer. | No |
| updated_at | string | The datetimes for the internal transfer. | No |
Withdraw
List your internal transfers as paginated collection.
| Name | Type | Description | Required |
|---|---|---|---|
| id | integer | The withdrawal id. | No |
| currency | string | The currency code. | No |
| type | string | The withdrawal type | No |
| amount | string | The withdrawal amount | No |
| fee | double | The exchange fee. | No |
| blockchain_txid | string | The withdrawal transaction id. | No |
| rid | string | The beneficiary ID or wallet address on the Blockchain. | No |
| state | string | The withdrawal state. | No |
| confirmations | integer | Number of confirmations. | No |
| note | string | Withdraw note. | No |
| transfer_type | string | Withdraw transfer type | No |
| created_at | string | The datetimes for the withdrawal. | No |
| updated_at | string | The datetimes for the withdrawal. | No |
| done_at | string | The datetime when withdraw was completed | No |
Deposit
Get your deposits history.
| Name | Type | Description | Required |
|---|---|---|---|
| id | integer | Unique deposit id. | No |
| currency | string | Deposit currency id. | No |
| amount | string | Deposit amount. | No |
| fee | double | Deposit fee. | No |
| txid | string | Deposit transaction id. | No |
| confirmations | integer | Number of deposit confirmations. | No |
| state | string | Deposit state. | No |
| transfer_type | string | Deposit transfer type | No |
| created_at | string | The datetime when deposit was created. | No |
| complete_at | string | The datetime when deposit was completed. | No |
| tid | string | The shared transaction ID | No |
Account
Get list of user accounts.
| Name | Type | Description | Required |
|---|---|---|---|
| currency | string | Currency code. | No |
| balance | double | Account balance. | No |
| locked | double | Account locked funds. | No |
| deposit_address | PaymentAddress | User deposit address. | No |
PaymentAddress
| Name | Type | Description | Required |
|---|---|---|---|
| currency | string | Currency code. | No |
| address | string | Payment address. | No |
| state | string | Payment address state. | No |
Transactions
| Name | Type | Description | Required |
|---|---|---|---|
| address | string | Recipient address of transaction. | No |
| currency | string | Transaction currency id. | No |
| amount | string | Transaction amount. | No |
| fee | double | Transaction fee. | No |
| txid | string | Transaction id. | No |
| rid | string | The beneficiary ID or wallet address on the Blockchain. | No |
| state | string | Transaction state. | No |
| note | string | Withdraw note. | No |
| confirmations | integer | Number of confirmations. | No |
| created_at | string | Transaction created time in iso8601 format. | No |
| updated_at | string | Transaction updated time in iso8601 format. | No |
| type | string | Type of transaction | No |
Member
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | Member UID. | No |
| string | Member email. | No | |
| accounts | Account | Member accounts. | No |