Models

WithdrawLimit

Returns withdraw limits table as paginated collection.

Name	Type	Description	Required
id	integer	Unique withdraw limit table identifier in 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 withdraw limit.	No
limit_1_month	double	1 month withdraw 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

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
maker_fee	double	Fee for maker.	No
taker_fee	double	Fee for taker.	No
trades_count	integer	Count of trades.	No
trades	[ Trade ]	Trades with 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. Example: "btc"	No
name	string	Currency name Example: "Bitcoin"	No
description	string	Currency description Example: "btc"	No
homepage	string	Currency homepage Example: "btc"	No
price	string	Currency current price	No
explorer_transaction	string	Currency transaction exprorer url template Example: "https://testnet.blockchain.info/tx/"	No
explorer_address	string	Currency address exprorer url template Example: "https://testnet.blockchain.info/address/"	No
type	string	Currency type Example: "coin"	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 Example: "0.0"	No
min_deposit_amount	string	Minimal deposit amount Example: "0.0000356"	No
withdraw_fee	string	Currency withdraw fee Example: "0.0"	No
min_withdraw_amount	string	Minimal withdraw amount Example: "0.0"	No
withdraw_limit_24h	string	Currency 24h withdraw limit Example: "0.1"	No
withdraw_limit_72h	string	Currency 72h withdraw limit Example: "0.2"	No
base_factor	string	Currency base factor Example: 100000000	No
precision	string	Currency precision Example: 8	No
position	string	Position used for defining currencies order Example: 8	No
icon_url	string	Currency icon Example: "https://upload.wikimedia.org/wikipedia/commons/0/05/Ethereum_logo_2014.svg"	No
min_confirmations	string	Number of confirmations required for confirming deposit or withdrawal	No

Withdraw

List your withdraws 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

Beneficiary

Get list of user beneficiaries

Name	Type	Description	Required
id	integer	Beneficiary Identifier in Database	No
currency	string	Beneficiary currency code.	No
uid	string	Beneficiary owner	No
name	string	Human rememberable name which refer beneficiary.	No
description	string	Human rememberable description of beneficiary.	No
data	json	Bank Account details for fiat Beneficiary in JSON format.For crypto it's blockchain address.	No
state	string	Defines either beneficiary active - user can use it to withdraw moneyor pending - requires beneficiary activation with pin.	No
sent_at	string	Time when last pin was sent	No

Deposit

Get your deposits history.

Name	Type	Description	Required
id	integer	Unique deposit id.	No
currency	string	Deposit currency id.	No
amount	double	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
completed_at	string	The datetime when deposit was completed..	No
tid	string	The shared transaction ID	No

Account

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

Transactions

Name	Type	Description	Required
address	string	Recipient address of transaction.	No
currency	string	Transaction currency id.	No
amount	double	Transaction amount.	No
fee	double	Transaction fee.	No
txid	string	Transaction id.	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
email	string	Member email.	No
accounts	[ Account ]	Member accounts.	No