Show/hide List Operations Expand Operations

Account

/api/account

GET /api/account alpha

Get account data

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
account	object (Account)	*	Account data
account[id]	string	*	User ID
account[name]	string	*	Name
account[email]	string	*	E-mail address
account[verified]	boolean	*	Verification status
account[residenceVerified]	boolean	*	Residence verification status
account[vip]	boolean	*	VIP status
account[credit]	float	*	Credit balance in fiat currency
account[volumeUsed]	float	*	What is already used up of the trading limit
account[volumeLeft]	float	*	What you have left of your trading volume
account[tier]	object (Tier)	*
account[tier][number]	integer	*	Tier
account[tier][feeRate]	float	*	Fee rate for buy and sell orders
account[tier][tradingLimit]	float	*	Trading limit in fiat currency per month
account[tier][buyOrderLimit]	float	*	Buy order limit in fiat currency per order
account[balances][]	array of objects (Balance)	*
account[balances][][currency]	string	*	Currency symbol
account[balances][][balance]	float	*	Balance

Show/hide List Operations Expand Operations

Constants

/api/constants/bankaccounts

GET /api/constants/bankaccounts

Get our bank account data for making payments

Parameter	Type	Versions
200 - Returned when successful
[]	array of objects (BankAccount)	*
[][bank_name]	string	*
[][bank_branch]	string	*
[][account_number]	string	*
[][holder_of_account]	string	*

/api/constants/constraints

GET /api/constants/constraints

Get system constraints

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
minVolumes[]	array of objects (MinimumVolume)	*	List of minimum trading volumes per crypto currency
minVolumes[][symbol]	string	*	Currency symbol
minVolumes[][buy]	float	*	Minimum buy amount in fiat currency
minVolumes[][sell]	float	*	Minimum sell amount in crypto currency
supportedBanks[]	array of strings	*	List of the names of the banks we provide payouts for

Show/hide List Operations Expand Operations

Exchange

/api/history

GET /api/history alpha

Get historical data

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
dataPoints[]	array of objects (DataPoint)	*
dataPoints[][time]	DateTime	*
dataPoints[][volumes][]	array of floats	*
dataPoints[][prices][]	array of objects (Prices)	*
dataPoints[][prices][][buy]	float	*
dataPoints[][prices][][sell]	float	*
dataPoints[][prices][][avg]	float	*

/api/prices

GET /api/prices beta

Get price quotes

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
currencies[]	array of objects (Currency)	*
currencies[][name]	string	*
currencies[][symbol]	string	*
currencies[][buy]	float	*
currencies[][sell]	float	*
currencies[][fixedFeeBuy]	float	*
currencies[][fixedFeeSell]	float	*
currencies[][networkFee]	float	*

/api/volume/{currency}/{timeframe}

GET /api/volume/{currency}/{timeframe} alpha

Get volume

Name	Requirement	Type	Description
currency		string	Any supported crypto currency or the base fiat currency
timeframe	(24h)	string	The timeframe for volume calculation, e.g. '24h'

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
volume	float	*

Show/hide List Operations Expand Operations

Orders

/api/order

POST /api/order alpha

Create new order

Documentation
Sandbox

Documentation

FAQ

I want to sell Bitcoin and receive a specific amount in fiat. What do I do?

When you provide 'desiredFiatAmount' instead of the 'cryptoAmount', we will calculate the amount in Bitcoin you have to pay based on current exchange rates for you.

How are callbacks handled?

There are several different events you can provide one callback URL for. We will call the provided URL upon the event being fired once. The GET parameter "order_id" will be added automatically to the request.

I see you need the name of the bank for payouts involving a bank transfer. Do you have a list of accepted bank names?

Vietcombank
Techcombank
VietinBank
AgriBank
BIDV
ACB
SacomBank
EximBank
DongA Bank
VPBank
SeaBank
TienPhong Bank
VIB
MB
SHB
OceanBank
PG Bank
VietA Bank
SaigonBank
AnBinh Bank
HD Bank
Maritime Bank
OCB
GPBank
NamA Bank
BacA Bank
SCB
Shinhan Bank
PVcomBank
Kienlongbank
HSBC
Standard Chartered
Citibank
Woori Bank

Parameters

Parameter	Type	Required?	Format	Description
order	object (Order)	true
order[type]	string	true	{not blank}, [buy\|sell]	The type of the order (buy or sell)
order[cryptoCurrency]	string	false	[BTC\|BCH\|ETH\|LTC\|DASH\|DOGE\|USDTERC20\|USDTSLP\|DAI\|USDC]	Symbol of crypto currency, defaults to 'BTC'
order[cryptoAmount]	float	true	{not blank}	Amount in crypto currency, only required for sell orders
order[fiatAmount]	float	true	{not blank}	Amount in fiat currency, only required for buy orders
order[desiredFiatAmount]	float	false		Amount desired for payout
order[desiredCryptoAmount]	float	false		Amount desired for payout
order[paymentMethod]	string	true	{not blank}, [bank\|credit], [crypto\|credit]	Payment method
order[payout]	object (Payout)	false		Payout data
order[payout][atmCard]	object (AtmCard)	false
order[payout][atmCard][contactEmail]	string	false		E-mail address to contact in case of any unforeseen event
order[payout][atmCard][contactPhone]	string	false		Phone number to call in case of any unforeseen event
order[payout][atmCard][bankName]	string	false		Name of the bank (e.g. "Eximbank", "Vietcombank", "VPBank")
order[payout][atmCard][accountHolder]	string	false		Account holder name
order[payout][atmCard][cardNumber]	string	false		ATM card number
order[payout][bank]	object (Bank)	false
order[payout][bank][contactEmail]	string	false		E-mail address to contact in case of any unforeseen event
order[payout][bank][contactPhone]	string	false		Phone number to call in case of any unforeseen event
order[payout][bank][bankName]	string	false		Name of the bank (e.g. "Eximbank", "Vietcombank", "VPBank")
order[payout][bank][bankBranch]	string	false		Branch of the bank
order[payout][bank][accountNumber]	string	false		Account number
order[payout][bank][accountHolder]	string	false		Holder of the bank account
order[payout][bank][swift]	string	false		Swift code, if available
order[payout][crypto]	object (Crypto)	false
order[payout][crypto][address]	string	false		Crypto destination address
order[payout][crypto][delayed]	boolean	false
order[payout][bitcoin]	object (Crypto)	false		Deprecated, will be removed in the future. Use "crypto" payout field instead.
order[payout][cashToId]	object (CashToId)	false
order[payout][cashToId][contactEmail]	string	false		E-mail address to contact in case of any unforeseen event
order[payout][cashToId][contactPhone]	string	false		Phone number to call in case of any unforeseen event
order[payout][cashToId][recipientName]	string	false		Full name of the recipient
order[payout][cashToId][recipientId]	string	false		ID number of the recipient
order[payout][cashToId][recipientIdDateOfIssue]	DateTime	false		Date of ID issue
order[payout][cashToId][recipientIdPlaceOfIssue]	string	false		Location of ID issue
order[payout][cashToId][bankName]	string	false		Name of the bank (e.g. "Eximbank", "Vietcombank", "VPBank")
order[payout][cashToId][bankBranch]	string	false		Branch of the bank
order[payout][cashToId][bankLocation]	string	false		Location of the bank
order[serviceProvider]	string	false		Service provider (for internal use only)
order[callbackUrl]	string	false	{url}	Callback URL

Headers

Name	Required?	Description
APIKEY	true	Your API key

Return

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
order	object (Order)	*
order[id]	string	*	Order ID
order[type]	string	*	Type of order
order[cryptoCurrency]	string	*	Symbol of crypto currency
order[fees]	object (Fees)	*	Order fees
order[fees][rate]	float	*	Fee rate
order[fees][fixedAmount]	float	*	Fixed fee amount
order[fees][voluntaryAmount]	float	*	Voluntary fee amount
order[rate]	float	*	Exchange rate
order[cryptoAmount]	float	*	Amount in crypto currency
order[fiatAmount]	float	*	Amount in fiat currency
order[desiredFiatAmount]	float	*	Desired amount in fiat currency
order[payout]	object (Payout)	*
order[payout][atmCard]	object (AtmCard)	*
order[payout][atmCard][amount]	float	*
order[payout][atmCard][currency]	string	*
order[payout][atmCard][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
order[payout][atmCard][contactPhone]	string	*	Phone number to call in case of any unforeseen event
order[payout][atmCard][bankName]	string	*	Name of the bank
order[payout][atmCard][accountHolder]	string	*	Account holder name
order[payout][atmCard][cardNumber]	string	*	ATM card number
order[payout][bank]	object (Bank)	*
order[payout][bank][amount]	float	*
order[payout][bank][currency]	string	*
order[payout][bank][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
order[payout][bank][contactPhone]	string	*	Phone number to call in case of any unforeseen event
order[payout][bank][bankName]	string	*	Name of the bank
order[payout][bank][bankBranch]	string	*	Branch of the bank
order[payout][bank][accountNumber]	string	*	Account number
order[payout][bank][accountHolder]	string	*	Holder of the bank account
order[payout][bank][swift]	string	*	Swift code, if available
order[payout][bitcoin]	object (Crypto)	*
order[payout][bitcoin][amount]	float	*
order[payout][bitcoin][currency]	string	*
order[payout][bitcoin][address]	string	*	Bitcoin address
order[payout][crypto]	object (Crypto)	*
order[payout][cashToId]	object (CashToId)	*
order[payout][cashToId][amount]	float	*
order[payout][cashToId][currency]	string	*
order[payout][cashToId][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
order[payout][cashToId][contactPhone]	string	*	Phone number to call in case of any unforeseen event
order[payout][cashToId][recipientName]	string	*	Full name of the recipient
order[payout][cashToId][recipientId]	string	*	ID number of the recipient
order[payout][cashToId][recipientIdDateOfIssue]	DateTime	*	Date of ID issue
order[payout][cashToId][recipientIdPlaceOfIssue]	string	*	Location of ID issue
order[payout][cashToId][bankName]	string	*	Name of the bank
order[payout][cashToId][bankBranch]	string	*	Branch of the bank
order[payout][cashToId][bankLocation]	string	*	Branch of the bank
order[paymentMethod]	string	*
order[payment]	object (Payment)	*
order[payment][bank]	object (Bank)	*
order[payment][bank][amount]	float	*	Amount
order[payment][bank][currency]	string	*	Currency
order[payment][bank][bankName]	string	*	Name of the bank
order[payment][bank][bankBranch]	string	*	Branch of the bank
order[payment][bank][accountNumber]	string	*	Account number
order[payment][bank][accountHolder]	string	*	Holder of the bank account
order[payment][bank][swift]	string	*	Swift code, if available
order[payment][crypto]	object (Crypto)	*
order[payment][crypto][amount]	float	*	Amount
order[payment][crypto][currency]	string	*	Currency
order[payment][crypto][address]	string	*	Bitcoin address
order[createdAt]	DateTime	*	Time of order creation
order[txPending]	boolean	*	Will be true when an unconfirmed transaction has been seen on the blockchain (sell orders)
order[paid]	boolean	*	True when paid
order[paidAt]	DateTime	*	Time of order payment
order[open]	boolean	*	True when open
order[cancelled]	boolean	*	True when cancelled

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when validation fails
401	Returned when not authorized
500	Server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/order/{id}

GET /api/order/{id} beta

Get order by ID

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id		string	The ID of your order

Headers

Name	Required?	Description
APIKEY	true	Your API key

Return

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
order	object (Order)	*
order[id]	string	*	Order ID
order[type]	string	*	Type of order
order[cryptoCurrency]	string	*	Symbol of crypto currency
order[fees]	object (Fees)	*	Order fees
order[fees][rate]	float	*	Fee rate
order[fees][fixedAmount]	float	*	Fixed fee amount
order[fees][voluntaryAmount]	float	*	Voluntary fee amount
order[rate]	float	*	Exchange rate
order[cryptoAmount]	float	*	Amount in crypto currency
order[fiatAmount]	float	*	Amount in fiat currency
order[desiredFiatAmount]	float	*	Desired amount in fiat currency
order[payout]	object (Payout)	*
order[payout][atmCard]	object (AtmCard)	*
order[payout][atmCard][amount]	float	*
order[payout][atmCard][currency]	string	*
order[payout][atmCard][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
order[payout][atmCard][contactPhone]	string	*	Phone number to call in case of any unforeseen event
order[payout][atmCard][bankName]	string	*	Name of the bank
order[payout][atmCard][accountHolder]	string	*	Account holder name
order[payout][atmCard][cardNumber]	string	*	ATM card number
order[payout][bank]	object (Bank)	*
order[payout][bank][amount]	float	*
order[payout][bank][currency]	string	*
order[payout][bank][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
order[payout][bank][contactPhone]	string	*	Phone number to call in case of any unforeseen event
order[payout][bank][bankName]	string	*	Name of the bank
order[payout][bank][bankBranch]	string	*	Branch of the bank
order[payout][bank][accountNumber]	string	*	Account number
order[payout][bank][accountHolder]	string	*	Holder of the bank account
order[payout][bank][swift]	string	*	Swift code, if available
order[payout][bitcoin]	object (Crypto)	*
order[payout][bitcoin][amount]	float	*
order[payout][bitcoin][currency]	string	*
order[payout][bitcoin][address]	string	*	Bitcoin address
order[payout][crypto]	object (Crypto)	*
order[payout][cashToId]	object (CashToId)	*
order[payout][cashToId][amount]	float	*
order[payout][cashToId][currency]	string	*
order[payout][cashToId][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
order[payout][cashToId][contactPhone]	string	*	Phone number to call in case of any unforeseen event
order[payout][cashToId][recipientName]	string	*	Full name of the recipient
order[payout][cashToId][recipientId]	string	*	ID number of the recipient
order[payout][cashToId][recipientIdDateOfIssue]	DateTime	*	Date of ID issue
order[payout][cashToId][recipientIdPlaceOfIssue]	string	*	Location of ID issue
order[payout][cashToId][bankName]	string	*	Name of the bank
order[payout][cashToId][bankBranch]	string	*	Branch of the bank
order[payout][cashToId][bankLocation]	string	*	Branch of the bank
order[paymentMethod]	string	*
order[payment]	object (Payment)	*
order[payment][bank]	object (Bank)	*
order[payment][bank][amount]	float	*	Amount
order[payment][bank][currency]	string	*	Currency
order[payment][bank][bankName]	string	*	Name of the bank
order[payment][bank][bankBranch]	string	*	Branch of the bank
order[payment][bank][accountNumber]	string	*	Account number
order[payment][bank][accountHolder]	string	*	Holder of the bank account
order[payment][bank][swift]	string	*	Swift code, if available
order[payment][crypto]	object (Crypto)	*
order[payment][crypto][amount]	float	*	Amount
order[payment][crypto][currency]	string	*	Currency
order[payment][crypto][address]	string	*	Bitcoin address
order[createdAt]	DateTime	*	Time of order creation
order[txPending]	boolean	*	Will be true when an unconfirmed transaction has been seen on the blockchain (sell orders)
order[paid]	boolean	*	True when paid
order[paidAt]	DateTime	*	Time of order payment
order[open]	boolean	*	True when open
order[cancelled]	boolean	*	True when cancelled

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when not authorized
404	Returned when no order found
500	Server error

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/orders

GET /api/orders beta

Get orders by certain filter values

Documentation
Sandbox

Filters

Name

Information

type

Datatype	string
Required	false
Description	Type of order (buy or sell)

open

Datatype	boolean
Required	false
Description	If true, only open orders will be returned

cancelled

Datatype	boolean
Required	false
Description	If false, cancelled orders will be left out of the response

Parameters

Parameter	Type	Required?	Description
limit	integer	true	Limits amount of results per request, default 20, max. 500
offset	integer	true	Use this for pagination, default 0
sortDirection	string	true	'ASC' for ascending, 'DESC' for descending, default 'DESC'

Headers

Name	Required?	Description
APIKEY	true	Your API key

Return

Parameter	Type	Versions	Description
200 - Returned when successful
status	integer	*	HTTP status
error	object (Error)	*
error[code]	integer	*	Error code
error[message]	string	*	Error message
error[field]	string	*	The field in which a problematic value has been submitted, if available
count	integer	*
orders[]	array of objects (Order)	*
orders[][id]	string	*	Order ID
orders[][type]	string	*	Type of order
orders[][cryptoCurrency]	string	*	Symbol of crypto currency
orders[][fees]	object (Fees)	*	Order fees
orders[][fees][rate]	float	*	Fee rate
orders[][fees][fixedAmount]	float	*	Fixed fee amount
orders[][fees][voluntaryAmount]	float	*	Voluntary fee amount
orders[][rate]	float	*	Exchange rate
orders[][cryptoAmount]	float	*	Amount in crypto currency
orders[][fiatAmount]	float	*	Amount in fiat currency
orders[][desiredFiatAmount]	float	*	Desired amount in fiat currency
orders[][payout]	object (Payout)	*
orders[][payout][atmCard]	object (AtmCard)	*
orders[][payout][atmCard][amount]	float	*
orders[][payout][atmCard][currency]	string	*
orders[][payout][atmCard][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
orders[][payout][atmCard][contactPhone]	string	*	Phone number to call in case of any unforeseen event
orders[][payout][atmCard][bankName]	string	*	Name of the bank
orders[][payout][atmCard][accountHolder]	string	*	Account holder name
orders[][payout][atmCard][cardNumber]	string	*	ATM card number
orders[][payout][bank]	object (Bank)	*
orders[][payout][bank][amount]	float	*
orders[][payout][bank][currency]	string	*
orders[][payout][bank][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
orders[][payout][bank][contactPhone]	string	*	Phone number to call in case of any unforeseen event
orders[][payout][bank][bankName]	string	*	Name of the bank
orders[][payout][bank][bankBranch]	string	*	Branch of the bank
orders[][payout][bank][accountNumber]	string	*	Account number
orders[][payout][bank][accountHolder]	string	*	Holder of the bank account
orders[][payout][bank][swift]	string	*	Swift code, if available
orders[][payout][bitcoin]	object (Crypto)	*
orders[][payout][bitcoin][amount]	float	*
orders[][payout][bitcoin][currency]	string	*
orders[][payout][bitcoin][address]	string	*	Bitcoin address
orders[][payout][crypto]	object (Crypto)	*
orders[][payout][cashToId]	object (CashToId)	*
orders[][payout][cashToId][amount]	float	*
orders[][payout][cashToId][currency]	string	*
orders[][payout][cashToId][contactEmail]	string	*	E-mail address to contact in case of any unforeseen event
orders[][payout][cashToId][contactPhone]	string	*	Phone number to call in case of any unforeseen event
orders[][payout][cashToId][recipientName]	string	*	Full name of the recipient
orders[][payout][cashToId][recipientId]	string	*	ID number of the recipient
orders[][payout][cashToId][recipientIdDateOfIssue]	DateTime	*	Date of ID issue
orders[][payout][cashToId][recipientIdPlaceOfIssue]	string	*	Location of ID issue
orders[][payout][cashToId][bankName]	string	*	Name of the bank
orders[][payout][cashToId][bankBranch]	string	*	Branch of the bank
orders[][payout][cashToId][bankLocation]	string	*	Branch of the bank
orders[][paymentMethod]	string	*
orders[][payment]	object (Payment)	*
orders[][payment][bank]	object (Bank)	*
orders[][payment][bank][amount]	float	*	Amount
orders[][payment][bank][currency]	string	*	Currency
orders[][payment][bank][bankName]	string	*	Name of the bank
orders[][payment][bank][bankBranch]	string	*	Branch of the bank
orders[][payment][bank][accountNumber]	string	*	Account number
orders[][payment][bank][accountHolder]	string	*	Holder of the bank account
orders[][payment][bank][swift]	string	*	Swift code, if available
orders[][payment][crypto]	object (Crypto)	*
orders[][payment][crypto][amount]	float	*	Amount
orders[][payment][crypto][currency]	string	*	Currency
orders[][payment][crypto][address]	string	*	Bitcoin address
orders[][createdAt]	DateTime	*	Time of order creation
orders[][txPending]	boolean	*	Will be true when an unconfirmed transaction has been seen on the blockchain (sell orders)
orders[][paid]	boolean	*	True when paid
orders[][paidAt]	DateTime	*	Time of order payment
orders[][open]	boolean	*	True when open
orders[][cancelled]	boolean	*	True when cancelled

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when not authorized
500	Server error

BitcoinVN.io API documentation

Account

/api/account

GET /api/account alpha

Headers

Return

200 - Returned when successful

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Constants

/api/constants/bankaccounts

GET /api/constants/bankaccounts

Return

200 - Returned when successful

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/constants/constraints

GET /api/constants/constraints

Return

200 - Returned when successful

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Exchange

/api/history

GET /api/history alpha

Return

200 - Returned when successful

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/prices

GET /api/prices beta

Return

200 - Returned when successful

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/volume/{currency}/{timeframe}

GET /api/volume/{currency}/{timeframe} alpha

Requirements

Return

200 - Returned when successful

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Orders

/api/order

POST /api/order alpha

Documentation

FAQ

I want to sell Bitcoin and receive a specific amount in fiat. What do I do?

How are callbacks handled?

I see you need the name of the bank for payouts involving a bank transfer. Do you have a list of accepted bank names?

Parameters

Headers

Return

200 - Returned when successful

Status Codes