• Sign-in
  • Sign-up

X

bithumb RESTFul API

1. Public API

Resource
Description
https://api.bithumb.com/public/ticker/{currency}More detail
exchange last transaction information
* {currency} = BTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC), ALL(All)
[Returned Example]
				{
					"status": "0000",
					"data": {
						"opening_price" : "504000",
						"closing_price" : "505000",
						"min_price"     : "504000",
						"max_price"     : "516000",
						"average_price" : "509533.3333",
						"units_traded"  : "14.71960286",
						"volume_1day"   : "14.71960286",
						"volume_7day"   : "15.81960286",
                        "buy_price"     : "505000",
                        "sell_price"    : "504000",
						"date"          : 1417141032622
					}
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
opening_pricetransaction amount starting within the recent 24 hours
closing_pricelast transaction amount within the recent 24 hours
min_pricelowest transaction amount within the recent 24 hours
max_pricehighest transaction amount within the recent 24 hours
average_priceaverage transaction amount within the recent 24 hours
units_tradedCurrency transactions in the recent 24 hours
volume_1dayCurrency trading volume within the day
volume_7dayCurrency trading volume within the recent 7 days
buy_price maximum Buy amount on the standby
sell_price minimum Sell amount on standby
dateTimestamp on the current time
https://api.bithumb.com/public/orderbook/{currency}More detail
standby for the purchase/sales of bithumb exchange or history information for transactions
* {currency} = BTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC), ALL(All
[Returned Example]
				{
					"status"    : "0000",
					"data"      : {
						"timestamp"         : 1417142049868,
						"order_currency"    : "BTC",
						"payment_currency"  : "KRW",
						"bids": [
							{
								"quantity"  : "6.1189306",
								"price"     : "504000"
							},
							{
								"quantity"  : "10.35117828",
								"price"     : "503000"
							}
						],
						"asks": [
							{
								"quantity"  : "2.67575",
								"price"     : "506000"
							},
							{
								"quantity"  : "3.54343",
								"price"     : "507000"
							}
						]
					}
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
timestampTimestamp on the current time
order_currencyOrder currency unit
payment_currencyPayment currency unit
bidsBuy request
asksSell request
quantityCurrency quantity
pricetransaction amount per 1Currency
[Request Parameters]
Parameter Name Data Type Description
group_ordersIntValue : 0 or 1 (Default : 1)
countIntValue : 1 ~ 50 (Default : 20), ALL : 1 ~ 5(Default : 5)
https://api.bithumb.com/public/recent_transactions/{currency}More detail
history of completion for transactions in bithumb
* {currency} = BTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
[Returned Example]
				{
					"status"    : "0000",
					"data"      : [
						{
							"transaction_date"  : "2015-04-20 11:17:21",
							"type"              : "bid",
							"units_traded"      : "0.03",
							"price"             : "270000",
							"total"             : "8100"
						},
						{
							"transaction_date"  : "2015-04-17 11:36:21",
							"type"              : "bid",
							"units_traded"      : "0.1",
							"price"             : "270000",
							"total"             : "27000"
						},
						{
							"transaction_date"  : "2015-04-17 11:36:13",
							"type"              : "ask",
							"units_traded"      : "0.1",
							"price"             : "260000",
							"total"             : "26000"
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
transaction_datetransaction settlement time
typeBuy/Sell (ask, bid)
units_tradedtransaction currency quantity
price1Currency transaction amount
totaltotal transaction amount
[Request Parameters]
Parameter Name Data Type Description
offsetIntValue : 0 ~ (Default : 0)
countIntValue : 1 ~ 100 (Default : 20)

2. Private API

Resource
Description
https://api.bithumb.com/info/accountMore detail
bithumb exchange customer information
[Returned Example]
				{
					"status"    : "0000",
					"data"      : {
						"created"       : 1388118018000,
						"account_id"    : "A000105A",
						"trade_fee"     : "0.000",
						"balance"       : "665.40127447"
					}
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
createdTimestamp
account_iduser ID
trade_feetransaction commission
balance1Currency balance (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/info/balanceMore detail
bithumb exchange customer wallet information
[Returned Example]
				{
					"status"    : "0000",
					"data"      : {
						"total_btc"     : "665.40127447",
						"total_krw"     : "305507280",
						"in_use_btc"    : "127.43629364",
						"in_use_krw"    : "8839047.0000000000",
						"available_btc" : "537.96498083",
						"available_krw" : "294932685.000000000000",
						"misu_btc"      : "0.0",
						"misu_krw"      : "-528905",
						"xcoin_last"    : "505000",
						"misu_depo_krw" : "1735548.000000000000"
					}
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
total_{currency}entire Currency (btc, eth, dash, ltc, etc, xrp, bch)
total_krwentire KRW
in_use_{currency}Currency in use (btc, eth, dash, ltc, etc, xrp, bch)
in_use_krwKRW in use
available_{currency}available currency (btc, eth, dash, ltc, etc, xrp, bch)
available_krwavailable KRW
misu_{currency}Currency for margin trading (btc, eth, dash, ltc, etc, xrp, bch)
misu_krwKRW for margin trading
xcoin_lastbithumb last transaction amount
misu_depo_krwoutstanding margin
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC), ALL(All )
https://api.bithumb.com/info/wallet_addressMore detail
bithumb exchange user deposit address
[Returned Example]
				{
					"status"    : "0000",
					"data"      : {
						"wallet_address"    : "1H7WL8Lb8mxCTwpL1RN8yckL2gcPLgqtqD",
						"currency"          : "BTC"
					}
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
wallet_addresselectronic wallet Address
currencyBTC, ETH, DASH, LTC, ETC, XRP, BCH
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/info/tickerMore detail
customer last transaction information
[Returned Example]
				{
					"status"    : "0000",
					"data"      : {
						"opening_price" : "507000",
						"closing_price" : "516000",
						"min_price"     : "507000",
						"max_price"     : "516000",
						"average_price" : "513875.0000",
						"units_traded"  : "3.91960286",
						"volume_1day"   : "3.91960286",
						"volume_7day"   : "5.01960286",
						"date"          : 1417148471595
					}
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
opening_pricetransaction amount starting within the recent 24 hours
closing_pricelast transaction amount within the recent 24 hours
min_pricelowest transaction amount within the recent 24 hours
max_pricehighest transaction amount within the recent 24 hours
average_priceaverage transaction amount within the recent 24 hours
units_tradedCurrency transactions in the recent 24 hours (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
volume_1dayCurrency trading volume within the day (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
volume_7dayCurrency trading volume within the recent 7 days (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
dateTimestamp on the current time
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
order_currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
payment_currencyStringKRW (currency currently provided by Bithumb KRW)
https://api.bithumb.com/info/ordersMore detail
registration for order of purchase/sales or transactions in progress
[Returned Example]
				{
					"status"    : "0000",
					"data"      : [
						{
							"order_id"          : "1412562509982",
							"order_currency"    : "BTC",
							"order_date"        : 1412562509982,
							"payment_currency"  : "KRW",
							"type"              : "bid",
							"status"            : "placed",
							"units"             : "5.0",
							"units_remaining"   : null,
							"price"             : "501000",
							"misu_yn"           : "N",
							"fee"               : null,
							"total"             : null,
							"date_completed"    : null
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
order_currencyOrder currency unit
order_dateorder date Timestamp
payment_currencyPayment currency unit
typeclassification of order request (bid : purchase, ask : sell)
statusorder status (placed : transaction in progress)
units Transaction request Currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
units_remainingorder balance
pricetransaction amount per 1Currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
misu_ynwhether to be credit transactions (Y : credit transactions, N : general transactions)
feetransaction commission
totalNULL if it is not the total transaction amount or completed status from the transactions
date_completeddate of completion for transactions Timestamp, NULL if it is not completed
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
order_idStringorder number registered for purchase/sales
typeStringtransaction type(bid : purchase, ask : sell)
countIntValue : 1 ~1000 (default : 100)
afterIntYYYY-MM-DD hh:mm:ss's UNIX Timestamp
(2014-11-28 16:40:01 = 1417160401000)
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/info/user_transactionsMore detail
customer transaction history
[Returned Example]
				{
					"status"    : "0000",
					"data"      : [
						{
							"search"        : "2",
							"transfer_date" : 1417139122544,
							"units"         : "- 0.1",
							"price"         : "51600",
							"btc1krw"       : "516000",
							"fee"           : "0 KRW",
							"btc_remain"    : "665.40127447",
							"krw_remain"    : "305507280"
						},
						{
							"search"        : "2",
							"transfer_date" : 1417138805912,
							"units"         : "- 0.1",
							"price"         : "51600",
							"btc1krw"       : "516000",
							"fee"           : "0 KRW",
							"btc_remain"    : "665.50127447",
							"krw_remain"    : "305455680"
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
searchsearch classification (0 : entire, 1 : purchase completed, 2 : sales completed, 3 : withdrawing, 4 : deposit, 5 : withdrawal, 9 : KRW depositing)
transfer_datedate of transaction Timestamp
unitstransaction currency quantity (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
pricetrading amount
{currency}1krwtransaction amount per 1Currency (btc, eth, dash, ltc, etc, xrp, bch)
feetrading commission
{currency}_remainCurrency balance after transactions (btc, eth, dash, ltc, etc, xrp, bch)
krw_remainKRW balance after transactions
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
offsetIntValue : 0 ~ (default : 0)
countIntValue : 1 ~ 50 (default : 20)
searchGbString0 : entire, 1 : completed purchase, 2 : completed sales, 3 : withdrawing, 4 : deposit, 5 : withdrawal, 9 : KRW depositing
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/trade/placeMore detail
bithumb customer purchase/sales transaction order, registration, and settlement
(registration for outstanding order and settlement are not supported with current API)
[Returned Example]
				{
					"status"    : "0000",
					"order_id"  : "1428646963419",
					"data": [
						{
							"cont_id"   : "15313",
							"units"     : "0.61460000",
							"price"     : "284000",
							"total"     : 174546,
							"fee"       : "0.00061460"
						},
						{
							"cont_id"   : "15314",
							"units"     : "0.18540000",
							"price"     : "289000",
							"total"     : 53581,
							"fee"       : "0.00018540"
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
order_idOrder Number
cont_idSettlement Number
unitsSettlement Quantity
priceTransaction price per 1Currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
totalKRW settled price
feeCommission
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
order_currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
Payment_currencyStringKRW (default value)
unitsFloatOrder quantity

- Minimum amount per transaction (BTC: 0.001 | ETH: 0.01 | DASH: 0.01 | LTC: 0.1 | ETC: 0.1 | XRP: 10 | BCH: 0.01)
- 1회 최대 수량 (BTC: 300 | ETH: 2,500 | DASH: 4,000 | LTC: 15,000 | ETC: 30,000 | XRP: 2,500,000 | BCH: 1,200)
priceInttransaction amount per 1Currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
typeStringtransaction type(bid : purchase, ask : sales)
misuStringmargin transactions (Y : use, N : general) – to be provided
https://api.bithumb.com/info/order_detailMore detail
bithumb customer Buy/Sell history
[Returned Example]
				{
					"status"    : "0000",
					"data"      : [
						{
							"transaction_date"  : "1428024598967",
							"type"              : "ask",
							"order_currency"    : "BTC",
							"payment_currency"  : "KRW",
							"units_traded"      : "0.0017",
							"price"             : "264000",
							"fee"               : "0.0000017",
							"total"             : "449"
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
transaction_datesettlement period Timestamp
typebid(Buy), ask(Sell)
order_currencyBTC, ETH, DASH, LTC, ETC, XRP, BCH
payment_currencyKRW
units_tradedSettlement Quantity
priceTransaction price per 1Currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
feeCommission
totalexecuted price
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
order_idStringorder number registered for purchase/sales
typeStringtransaction type(bid : purchase, ask : sales)
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/trade/cancelMore detail
bithumb customer purchase/sales transaction cancellation
[Returned Example]
				{
					"status"    : "0000"
				}
[Returned Value Description]
Key Name Description
status result status code (normal: 0000, refer to error code for codes other than the normal)
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
typeStringtransaction type(bid : purchase, ask : sales)
order_idStringorder number registered for purchase/sales
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/trade/btc_withdrawalMore detail
bithumb customer Currency withdrawal
(withdrawal from the customer grade BTC, ETH, DASH, LTC, ETC, XRP, BCH)
[Returned Example]
				{
					"status"    : "0000"
				}
[Returned Value Description]
Key Name Description
status result status code (normal: 0000, refer to error code for codes other than the normal)
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
unitsFloat quantity to withdraw currency

- Minimum amount per transaction (BTC: 0.001 | ETH: 0.01 | DASH: 0.01 | LTC: 0.01 | ETC: 0.01 | XRP: 21 | BCH: 0.005)
- Maximum amount per transaction : quantity based on customer grade
addressStringCurrency withdrawing address (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
destinationIntegerCurrency withdrawal Destination Tag (when withdraw XRP)
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/trade/krw_depositMore detail
bithumb customer request for virtual account of KRW deposit
[Returned Example]
				{
					"status"    : "0000",
					"account"   : "56208399422301",
					"bank"      : "Shinhan Bank",
					"BankUser"  : "BTC KoreaCom"
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
accountvirtual bank account number
bankShinhan Bank (bank name)
BankUserBTC KoreaCom (name of depositor)
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
https://api.bithumb.com/trade/krw_withdrawalMore detail
bithumb customer KRW withdrawal request
[Returned Example]
				{
					"status"    : "0000"
				}
[Returned Value Description]
Key Name Description
status result status code (normal: 0000, refer to error code for codes other than the normal)
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
bank String
accountStringwithdrawing bank account number
priceIntwithdrawing amount
https://api.bithumb.com/trade/market_buyMore detail
Buy with market price
[Returned Example]
				{
					"status"    : "0000",
					"order_id"  : "1429500241523",
					"data": [
						{
							"cont_id"   : "15364",
							"units"     : "0.16789964",
							"price"     : "270000",
							"total"     : 45333,
							"fee"       : "0.00016790"
						},
						{
							"cont_id"   : "15365",
							"units"     : "0.08210036",
							"price"     : "289000",
							"total"     : 23727,
							"fee"       : "0.00008210"
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
order_idorder number
cont_idsettlement number
unitstotal purchase quantity (including commission)
priceKRW market price per 1 currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
totalpurchase KRW
feeCommission
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
unitsFloatOrder quantity

- Minimum amount per transaction (BTC: 0.001 | ETH: 0.01 | DASH: 0.01 | LTC: 0.1 | ETC: 0.1 | XRP: 10 | BCH: 0.01)
- Amount threshold per transaction : 100 million KRW
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)
https://api.bithumb.com/trade/market_sellMore detail
Sell with market price
[Returned Example]
				{
				"status"    : "0000",
				"order_id"  : "1429500318982",
					"data"      : [
						{
							"cont_id"   : "15366",
							"units"     : "0.78230769",
							"price"     : "260000",
							"total"     : 203400,
							"fee"       : 203
						},
						{
							"cont_id"   : "15367",
							"units"     : "0.21769231",
							"price"     : "259500",
							"total"     : 56491,
							"fee"       : 56
						}
					]
				}
[Returned Value Description]
Key Name Description
statusresult status code (normal: 0000, refer to error code for codes other than the normal)
order_idorder number
cont_idsettlement number
unitstotal sales quantity (including commission)
priceKRW market price per 1 currency (BTC, ETH, DASH, LTC, ETC, XRP, BCH)
totalsale KRW
feecommission
[Request Parameters]
Parameter Name Data Type Description
apiKeyStringapiKey
secretKeyStringscretKey
unitsFloatOrder quantity

- Minimum amount per transaction (BTC: 0.001 | ETH: 0.01 | DASH: 0.01 | LTC: 0.1 | ETC: 0.1 | XRP: 10 | BCH: 0.01)
- Amount threshold per transaction : 100 million KRW
currencyStringBTC, ETH, DASH, LTC, ETC, XRP, BCH (default value: BTC)

3. ERROR CODE

CODE MESSAGE
5100 Bad Request
5200 Not Member
5300 Invalid Apikey
5302 Method Not Allowed
5400 Database Fail
5500 Invalid Parameter
5600 CUSTOM NOTICE (output the error message in each situation)
5900 Unknown Error
[Returned Example]
			{
				"success" : 5600,
				"message" : "minimum quantity is 0001BTC"
			}
    

4. Sample Code

1. PHPdownload
2. JAVAdownload
3. C++(Windows)download libcurldownload
4. C++(Linux)download
5. Node.jsdownload
6. python3download
7. pythondownload
8. C#download
9. GOdownload

Alert

- Public API
20 request available per second.
If the request exceeds 20 calls per second, API usage will be limited,
and also the administrator's approval is reqqired to remove the limitation.(Phone contact required)
- Private API
10 request available per second.
If the request exceeds 10 calls, API usage will be limited for 5 minutes.
Register security password
Register a security password to prevent hacking incidents and enhance
security.




Mobile phone verification Request
Registration
Change security password
Change your security password regularly to prevent hacking incidents.
Mobile phone verification Request
Change
Reset security password
Temporary security password will be sent to your registered e-mail address.
Mobile phone verification Request
Send e-mail
Register e-mail
Resetting your security password will be available on registering your
e-mail address.

Send verification e-mail