How to create API keys?

Tristan Roozendaal

Modified on: Tue, 28 Sep, 2021 at 5:49 PM

Using UI

1. Find the API keys section in your

2. Create your API key with the create button and securely save Access Key and Security Key.

How to use the API key?

To authenticate using the API key, you need to pass 3 headers:

X-Auth-Apikey - Access Key for the API key. (see How to create API keys?)
X-Auth-Nonce - Unix timestamp in milliseconds.
X-Auth-Signature - HMAC-SHA256, calculated using a concatenation of X-Auth-Nonce and Access Key.

Steps:

Generate X-Auth-Nonce - Unix timestamp in milliseconds.

$ date +%s%3N # Linux user
$ date +%s000 # Mac user
1589942871000

Calculate X-Auth-Signature header - HMAC-SHA256, calculated using a concatenation of X-Auth-Nonce and Access Key.

Ruby:

nonce = (Time.now.to_f * 1_000).to_i.to_s # Unix timestamp in milliseconds
access_key = 'your_access_key' # Access Key 
secret_key = 'your_secret_key' # Secret Key 
signature = OpenSSL::HMAC.hexdigest('SHA256', secret_key, nonce + access_key) 

# signature = "6cc108cb3427b655ccf0870fc7fa807ef3756506d4db3f3c93f8d4cd8ef0e611"

Javascript:

const crypto = require('crypto')
const nonce = Date.now().toString() // Unix timestamp in milliseconds
const access_key = 'your_access_key' // Access Key
const secret_key = 'your_secret_key' // Secret Key
const signature = crypto.createHmac('sha256', secret_key).update(nonce + access_key).digest('hex')

// signature = "6cc108cb3427b655ccf0870fc7fa807ef3756506d4db3f3c93f8d4cd8ef0e611"

Validate API by passing additional HTTP headers in curl.

$ curl --request GET \
       --url https://exchange.centralex.com/api/v2/peatio/account/balances \
       --header 'X-Auth-Apikey: your_access_key' \
       --header 'X-Auth-Nonce: 1589942871000' \
       --header 'X-Auth-Signature: 6cc108cb3427b655ccf0870fc7fa807ef3756506d4db3f3c93f8d4cd8ef0e611'

API Endpoints

Public Endpoints

Status

Get Server Status

GET https://exchange.centralex.com/api/v2/peatio/public/health/ready

Description

Get application readiness status

Responses

Code	Description
200	Get application readiness status.

Timestamp

Get Server Timestamp

GET https://exchange.centralex.com/api/v2/peatio/public/timestamp

Description

Get server current time, in seconds since Unix epoch.

Responses

Code	Description
200	Get server current time, in seconds since Unix epoch.

Member Levels

Get-Member Levels List

GET https://exchange.centralex.com/api/v2/peatio/public/member-levels

Description

Returns list of minimum levels and the privileges they provide.

Responses

Code	Description
200	Returns list of minimum levels and the privileges they provide.

Trading Fee

Get Trading Fee List

GET https://exchange.centralex.com/api/v2/peatio/public/trading_fees

Description

Returns trading_fees table as a paginated collection.

Parameters

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
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 a 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 a paginated collection.	[ TradingFee ]

Market Tickers

Get All Market Tickers

GET https://exchange.centralex.com/api/v2/peatio/public/markets/tickers

Description

Get ticker of all markets.

Responses

Code	Description	Schema
200	Get ticker of all markets.	Ticker

Get Specific Market Tickers

GET https://exchange.centralex.com/api/v2/peatio/public/markets/{market}/tickers

Description

Get ticker of a specific market.

Parameters

Name	Located in	Description	Required	Schema
market	path	Market name.	Yes	string

Responses

Code	Description	Schema
200	Get ticker of a specific market.	Ticker

Market OHLC (K-Line)

Get OHLC (K-Line) of Specific Market

GET https://exchange.centralex.com/api/v2/peatio/public/markets/{market}/k-line

Description

Get OHLC(kline) of a specific market.

Parameters

Name	Located in	Description	Required	Schema
market	path	Market name.	Yes	string
period	query	The time period of Kline defaults 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 the 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 the 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(kline) of a specific market.

Market Depth

Get Market Depth

GET https://exchange.centralex.com/api/v2/peatio/public/markets/{market}/depth

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	Market name.	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 the highest price to the lowest.

Market Trades

Get Market Trades

GET https://exchange.centralex.com/api/v2/peatio/public/markets/{market}/trades

Description

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

Parameters

Name	Located in	Description	Required	Schema
market	path	Market name.	Yes	string
limit	query	Limit the number of returned trades. Default to 100.	No	integer
timestamp	query	An integer represents the seconds elapsed since the 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 a specific order, default to 'desc'.	No	string

Responses

Code	Description	Schema
200	Get recent trades on the market, and each trade is included only once. Trades are sorted in reverse creation order.	[ Trade ]

Order Book

Get Order Book of Specific Market

GET https://exchange.centralex.com/api/v2/peatio/public/markets/{market}/order-book

Description

Get the order book of the specified market.

Parameters

Name	Located in	Description	Required	Schema
market	path	Market name.	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 the specified market.	[ OrderBook ]

Markets

Get All Markets

GET https://exchange.centralex.com/api/v2/peatio/public/markets

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 a 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	Search with JSON query. e.g. {"base_code": "CODE"}	No	JSON
search[base_code]	query	Search by contains base currency code.	No	string
search[quote_code]	query	Search by contains quote currency code.	No	string
search[base_name]	query	Search by contains base currency name.	No	string
search[quote_name]	query	Search by contains quote currency name.	No	string

Responses

Code	Description	Schema
200	Get all available markets.	[ Market ]

Currencies

Get All Currencies

GET https://exchange.centralex.com/api/v2/peatio/public/currencies

Description

Get the 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
search	query	Search with JSON query. e.g. {"code": "CODE"}	No	JSON
search[code]	query	Search by contains currency code.	No	string
search[name]	query	Search by contains currency name.	No	string

Responses

Code	Description	Schema
200	Get the list of currencies.	[ Currency ]

Get Specific Currency by ID

GET https://exchange.centralex.com/api/v2/peatio/public/currencies/{id}

Description

Get a specific currency.

Parameters

Name	Located in	Description	Required	Schema
id	path	Currency code.	Yes	string

Responses

Code	Description	Schema
200	Get a currency	Currency

Withdraw Limits

Get withdraw limits

GET https://exchange.centralex.com/api/v2/peatio/public/withdraw_limits

Description

Get all withdrawal limits

Parameters

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 a 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 withdraw limits table as a paginated collection	[ WithdrawLimit ]

Authenticated Endpoints

Transactions

Get Transactions History

GET https://exchange.centralex.com/api/v2/peatio/account/transactions

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 the Unix epoch.	No	integer
time_to	query	An integer represents the seconds elapsed since the 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.

Withdraws

Create new Withdraw

POST https://exchange.centralex.com/api/v2/peatio/account/withdraws

Description

Creates new withdrawal to the active beneficiary.

Parameters

Name	Located in	Description	Required	Schema
OTP	formData	OTP to perform an action.	Yes	integer
beneficiary_id	formData	The ID of the Active Beneficiary belonging to the user.	Yes	integer
currency	formData	The currency code.	Yes	string
amount	formData	The amount to withdraw.	Yes	double
note	formData	Optional metadata to be applied to the transaction. Used to tag transactions with memorable comments.	No	string

Responses

Code	Description
201	Creates new withdrawal to an active beneficiary.

Get Withdraws List

GET https://exchange.centralex.com/api/v2/peatio/account/withdraws

Description

List your withdraws as a paginated collection.

Parameters

Name	Located in	Description	Required	Schema
currency	query	Currency code.	No	string
limit	query	A 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
page	query	Page number (defaults to 1).	No	integer

Responses

Code	Description	Schema
200	List your withdraws as a paginated collection.	[ Withdraw ]

Beneficiaries

Delete Beneficiary

DELETE https://exchange.centralex.com/api/v2/peatio/account/beneficiaries/{id}

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 Beneficiary by ID

GET https://exchange.centralex.com/api/v2/peatio/account/beneficiaries/{id}

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

Activate Beneficiary by ID

PATCH https://exchange.centralex.com/api/v2/peatio/account/beneficiaries/{id}/activate

Description

Activates beneficiary with a 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	Schema
200	Activates beneficiary with a pin.	Beneficiary

Resend Beneficiary Pin

PATCH https://exchange.centralex.com/api/v2/peatio/account/beneficiaries/{id}/resend_pin

Description

Resend beneficiary pin by ID.

Parameters

Name	Located in	Description	Required	Schema
id	path	Beneficiary Identifier in Database.	Yes	integer

Responses

Code	Description
200	Resend beneficiary pin.

Create new Beneficiary

POST https://exchange.centralex.com/api/v2/peatio/account/beneficiaries

Description

Create a new beneficiary.

Parameters

Name	Located in	Description	Required	Schema
currency	formData	Beneficiary currency code.	Yes	string
name	formData	The human rememberable name refers to the beneficiary.	Yes	string
description	formData	Human rememberable description of the beneficiary.	No	string
data	formData	Beneficiary data in JSON format.	Yes	CreateBeneficiary

Responses

Code	Description	Schema
201	Create a new beneficiary.	Beneficiary

Get Beneficiary List

GET https://exchange.centralex.com/api/v2/peatio/account/beneficiaries

Description

Get the list of user beneficiaries.

Parameters

Name	Located in	Description	Required	Schema
currency	query	Beneficiary currency code.	No	string
state	query	Defines either beneficiary active - user can use it to withdraw money or pending - requires beneficiary activation with a pin.	No	string

Responses

Code	Description	Schema
200	Get the list of user beneficiaries.	[ Beneficiary ]

Deposit

Get Deposit Address by Currency

GET https://exchange.centralex.com/api/v2/peatio/account/deposit_address/{currency}

Description

Returns deposit address for the account you want to deposit to buy currency. The address may be blank because the 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 the account you want to deposit to buy currency. The address may be blank because the address generation process is still in progress. If this case, you should try again later.	Deposit

Get Specific Deposit by Transaction ID

GET https://exchange.centralex.com/api/v2/peatio/account/deposits/{txid}

Description

Get details of the specific deposits.

Parameters

Name	Located in	Description	Required	Schema
txid	path	Deposit transaction id.	Yes	string

Responses

Code	Description	Schema
200	Get details of the specific deposit.	Deposit

Get Deposits History

GET https://exchange.centralex.com/api/v2/peatio/account/deposits

Description

Get the history of your deposits.

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
limit	query	A 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 deposits history.	[ Deposit ]

Balances

Get Balance by Currency

GET https://exchange.centralex.com/api/v2/peatio/account/balances/{currency}

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

Get All Balances

GET https://exchange.centralex.com/api/v2/peatio/account/balances

Description

Get the 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
search	query	Search with JSON query. e.g. {"currency_code": "CODE"}	No	JSON
search[currency_code]	query	Search by contains currency code.	No	string
search[currency_name]	query	Search by contains currency name.	No	string

Responses

Code	Description	Schema
200	Get the list of user accounts	[ Account ]

Trades

Get Executed Trades

GET https://exchange.centralex.com/api/v2/peatio/market/trades

Description

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

Parameters

Name	Located in	Description	Required	Schema
market	query	Market name.	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
time_from	query	An integer represents the seconds elapsed since the 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 the 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 a specific order, default to 'desc'.	No	string

Responses

Code	Description	Schema
200	Get your executed trades. Trades are sorted in reverse creation order.	[ Trade ]

Orders

Create New Order

POST https://exchange.centralex.com/api/v2/finex/market/orders

Description

Submit a new order. Notice that while the response from the server is ok, the order can still be rejected by the matching engine. You should wait for confirmation from the WebSocket to be sure that your order has been added to the orderbook.

Parameters

Name	Located in	Description	Required	Schema
market	body	Market name.	Yes	string
side	body	Order side (buy or sell).	Yes	string
amount	body	Amount.	Yes	decimal
type	body	Order type (limit, market or post_only).	Yes	string
price	body	Price.	Yes	decimal

Responses

Code	Description	Schema
201	Your order was submitted and awaits processing.	SubmitOrder
400	Bad request, make sure the JSON syntax of your request is correct.
422	Invalid request, make sure every mandatory field are present.
500	Internal Server Error.

Cancel Order by ID or UUID

POST https://exchange.centralex.com/api/v2/finex/market/orders/cancel/{id|uuid}

Description

Submit cancel request, cancels order from the orderbook.

Parameters

Name	Located in	Description	Required	Schema
id\|uuid	path	Order ID or UUID.	Yes	integer\|string

Responses

Code	Description	Schema
201	Your cancel request was submitted and awaits processing.
422	Invalid request, make sure every mandatory field are present.
500	Internal Server Error.

Cancel All Orders

POST https://exchange.centralex.com/api/v2/finex/market/orders/cancel

Description

Submit a cancel request, cancels all your orders from orderbook.

Parameters

Name	Located in	Description	Required	Schema
market	body	Market name.	Yes	string
side	body	Order side (buy or sell)	Yes	string

Responses

Code	Description	Schema
200	Your cancel request was submitted and awaits processing.
422	Invalid request, make sure every mandatory field are present.
500	Internal Server Error.

Create Bulk Orders

POST https://exchange.centralex.com/api/v2/finex/market/bulk/orders

Description

Bulk API to create a list of orders in one request. The default limit is set to 100 orders for one request, and this might be configured by the administrator with the parameter API.bulk_limit

Parameters

Name	Located in	Description	Required	Schema
-	body	The array of order params (refer to create order params)	Yes	[NewOrder]

Responses

Code	Description	Schema
201	Your order was submitted and awaits processing.	SubmitOrder
413	Request entity too large. Your request contains too many orders.
422	Invalid request, make sure every mandatory field are present.
500	Internal Server Error.

Cancel Bulk Orders by UUID

DELETE https://exchange.centralex.com/api/v2/finex/market/bulk/orders

Description

Bulk API to cancel orders by UUID.

Parameters

Name	Located in	Description	Required	Schema
[]	body	An array of order UUID.	Yes	string[]

Responses

Code	Description	Schema
200	Your cancel request was submitted and awaits processing.
413	Request entity too large. Your request contains too many orders.
422	Invalid request, make sure every mandatory field are present.
500	Internal Server Error.

Cancel Bulk Orders by ID

DELETE https://exchange.centralex.com/api/v2/finex/market/bulk/orders_by_id

Description

Bulk API to cancel orders by ID.

Parameters

Name	Located in	Description	Required	Schema
[]	body	An array of order ID.	Yes	integer[]

Responses

Code	Description	Schema
200	Your cancel request was submitted and awaits processing.
413	Request entity too large. Your request contains too many orders.
422	Invalid request, make sure every mandatory field are present.
500	Internal Server Error.

Get All Orders

GET https://exchange.centralex.com/api/v2/peatio/market/orders

Description

Get your orders, and the result is paginated.

Parameters

Name	Located in	Description	Required	Schema
market	query	Market name.	No	string
base_unit	query	Base currency unit.	No	string
quote_unit	query	Quote currency unit.	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 a 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 the 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 the Unix epoch. If set, only orders created before the time will be returned.	No	integer

Responses

Code	Description	Schema
200	Get your orders, the result is paginated.	[ Order ]

Get Specific Order by ID

GET https://exchange.centralex.com/api/v2/peatio/market/orders/{id}

Description

Get information on the specified order.

Parameters

Name	Located in	Description	Required	Schema
id	path	Order ID.	Yes	string

Responses

Code	Description	Schema
200	Get information on the specified order.	Order

Schema

TradingFee

Name	Type	Description
id	integer	Unique trading fee table identifier in the database.
group	string	Member group for define maker/taker fee.
market_id	string	Market id for define maker/taker fee.
maker	double	Market maker fee.
taker	double	Market taker fee.
created_at	string	Trading fee table created time in iso8601 format.
updated_at	string	Trading fee table updated time in iso8601 format.

Ticker

Name	Type	Description
at	integer	Timestamp of ticker
ticker	TickerEntry	Ticker entry for a specified time

TickerEntry

Name	Type	Description
low	double	The lowest trade price during the last 24 hours (0.0 if no trades executed during last 24 hours)
high	double	The highest trade price during the last 24 hours (0.0 if no trades executed during last 24 hours)
open	double	Price of the first trade executed 24 hours ago or less
last	double	The last executed trade price
volume	double	The total volume of trades executed during last 24 hours
amount	double	The total amount of trades executed during last 24 hours
vol	double	Alias to volume
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
price_change_percent	string	Price change in the next format +3.19%.Price change is calculated using next formula (last - open) / open * 100%
at	integer	Timestamp of ticker

Trade

Name	Type	Description
id	string	Trade ID.
price	double	Trade price.
amount	double	Trade amount.
total	double	Trade total (Amount * Price).
fee_currency	double	Currency user's fees were charged in.
fee	double	Percentage of fee user was charged for performed trade.
fee_amount	double	Amount of fee user was charged for performed trade.
market	string	Trade market name.
created_at	string	Trade creates time in iso8601 format.
taker_type	string	Trade taker order type (sell or buy).
side	string	Trade side.
order_id	integer	Order id.

OrderBook

Name	Type	Description
asks	[ Order ]	Asks in orderbook
bids	[ Order ]	Bids in orderbook

Order

Name	Type	Description
id	integer	Unique order ID.
uuid	string	Unique order UUID.
side	string	Either 'sell' or 'buy'.
ord_type	string	Type of order, either 'limit' or 'market'.
price	double	Price for each unit. e.g.If you want to sell/buy 1 BTC at 3000 USD, the price is '3000.0'
avg_price	double	Average execution price, an average price in trades.
state	string	One of 'wait', 'done', or 'cancel'.An order in 'wait' is an active order, waiting for fulfilment; a 'done' order is an order fulfilled; 'cancel' means the order has been cancelled.
market	string	The market in which the order is placed, e.g. 'btcusd'.All available markets can be found at /api/v2/markets.
created_at	string	Order create time in iso8601 format.
updated_at	string	Order updated time in iso8601 format.
origin_volume	double	The amount user wants 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'.
remaining_volume	double	For the remaining volume, see 'volume'.
executed_volume	double	The executed volume, see 'volume'.
maker_fee	double	Fee for the maker.
taker_fee	double	Fee for a taker.
trades_count	integer	Count of trades.
trades	[ Trade ]	Trades with this order.

Market

Name	Type	Description
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 can be found at /api/v2/markets.
name	string	Market name.
base_unit	string	Market Base unit.
quote_unit	string	Market Quote unit.
min_price	double	Minimum order price.
max_price	double	Maximum order price.
min_amount	double	Minimum order amount.
amount_precision	double	Precision for the order amount.
price_precision	double	Precision for order price.
state	string	The market state defines if the user can see/trade on the current market.

Currency

Name	Type	Description
id	string	Currency code. Example: `"btc"`
name	string	Currency name Example: `"Bitcoin"`
description	string	Currency description Example: `"btc"`
homepage	string	Currency homepage Example: `"btc"`
price	string	Currency current price
explorer_transaction	string	Currency transaction explorer URL template Example: `"https://testnet.blockchain.info/tx/"`
explorer_address	string	Currency address explorer URL template Example: `"https://testnet.blockchain.info/address/"`
type	string	Currency type Example: `"coin"`
deposit_enabled	string	Currency deposit possibility status (true/false).
withdrawal_enabled	string	Currency withdrawal possibility status (true/false).
deposit_fee	string	Currency deposit fee Example: `"0.0"`
min_deposit_amount	string	Minimal deposit amount Example: `"0.0000356"`
withdraw_fee	string	Currency withdraw fee Example: `"0.0"`
min_withdraw_amount	string	Minimal withdraw amount Example: `"0.0"`
withdraw_limit_24h	string	Currency 24h withdraw limit Example: `"0.1"`
withdraw_limit_72h	string	Currency 72h withdraw limit Example: `"0.2"`
base_factor	string	Currency base factor Example: `100000000`
precision	string	Currency precision Example: `8`
position	string	A position used for defining currencies order Example: `8`
icon_url	string	Currency icon Example: `"https://upload.wikimedia.org/wikipedia/commons/0/05/Ethereum_logo_2014.svg"`
min_confirmations	string	Number of confirmations required for confirming deposit or withdrawal

WithdrawLimit

Name	Type	Description	Required
id	integer	Unique withdraw limit table identifier in the database.	No
group	string	Member group for define withdraw limits.	No
kyc_level	string	KYC level for define withdraw limits.	No
limit_24_hour	double	24 hours withdrawal limit.	No
limit_1_month	double	1 month withdrawal limit.	No
created_at	string	Withdraw limit table created time in iso8601 format.	No
updated_at	string	Withdraw limit table updated time in iso8601 format.	No

Withdraw

Name	Type	Description
id	integer	The withdrawal id.
currency	string	The currency code.
type	string	The withdrawal-type
amount	string	The withdrawal amount
fee	double	The exchange fee.
blockchain_txid	string	The withdrawal transaction id.
rid	string	The beneficiary ID or wallet address on the Blockchain.
state	string	The withdrawal state.
confirmations	integer	A number of confirmations.
note	string	Withdraw note.
created_at	string	The datetimes for the withdrawal.
updated_at	string	The datetimes for the withdrawal.
done_at	string	The DateTime when withdraw was completed

CreateBeneficiary

Name	Type	Description
address	string	Blockchain address.

Beneficiary

Name	Type	Description
id	integer	Beneficiary Identifier in Database
currency	string	Beneficiary currency code.
uid	string	Beneficiary owner
name	string	Human rememberable name which refers beneficiary.
description	string	Human rememberable description of the beneficiary.
data	JSON	Bank Account details for fiat Beneficiaries in JSON format. For crypto, it's a blockchain address.
state	string	Defines either beneficiary active - user can use it to withdraw money or pending - requires beneficiary activation with a pin.
sent_at	string	The time when the last pin was sent

Deposit

Name	Type	Description
id	integer	Unique deposit id.
currency	string	Deposit currency id.
amount	double	Deposit amount.
fee	double	Deposit fee.
txid	string	Deposit transaction id.
confirmations	integer	A number of deposit confirmations.
state	string	Deposit state.
transfer_type	string	Deposit transfer type
created_at	string	The DateTime when the deposit was created.
completed_at	string	The DateTime when the deposit was completed.
tid	string	The shared transaction ID

Account

Name	Type	Description
currency	string	Currency code.
balance	double	Account available balance.
locked	double	Account locked funds.

Transactions

Name	Type	Description
address	string	Recipient address of the transaction.
currency	string	Transaction currency id.
amount	double	Transaction amount.
fee	double	Transaction fee.
txid	string	Transaction id.
state	string	Transaction state.
note	string	Withdraw note.
confirmations	integer	A number of confirmations.
created_at	string	Transaction created time in iso8601 format.
updated_at	string	Transaction updated time in iso8601 format.
type	string	Type of transaction

NewOrder

Name	Type	Description
market	string	Market name.
side	string	Order side (buy or sell)
amount	decimal	Amount.
type	string	Order type (limit, market or post_only).
price	decimal	Price.

SubmitOrder

Name	Type	Description
uuid	string	Order UUID.
side	string	Order side (buy or sell)
type	string	Order type (limit, market or post_only)
market	string	Market name.
origin_volume	double	Origin volume
remaining_volume	double	Remaining volume.
executed_volume	double	Executed volume.
price	string	Order price.
state	string	Order state.
trades_count	integer	Trades count.
created_at	integer	Unix timestamp.