bithumb

bithumb cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.

🔌 Looking for raw exchange endpoints? See the bithumb implicit API — every endpoint in this exchange's API exposed as an implicit method.

Kind: global class
Extends: Exchange

fetchMarkets
fetchBalance
fetchOrderBook
fetchTickers
fetchTicker
fetchOHLCV
fetchTrades
createOrders
createOrder
createMarketBuyOrderWithCost
createTwapOrder
fetchOrder
fetchOpenOrders
fetchOrders
fetchClosedOrders
fetchCanceledOrders
cancelOrder
cancelOrders
withdraw
fetchWithdrawalWhitelist
fetchWithdrawal
fetchWithdrawals
fetchDeposit
fetchDeposits
createDepositAddress
fetchDepositAddress
fetchDepositAddresses
watchTicker
watchTickers
watchOrderBook
watchTrades
watchBalance
watchOrders

fetchMarkets

retrieves data on all markets for bithumb

Kind: instance method of bithumb
Returns: Array<object> - an array of objects representing market data

See

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchMarkets (params?)

fetchBalance

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bithumb
Returns: object - a balance structure

See

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchBalance (params?)

fetchOrderBook

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bithumb
Returns: object - an order book structure

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchOrderBook (symbol, limit?, params?)

fetchTickers

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of bithumb
Returns: object - a dictionary of ticker structures

See

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchTickers (symbols, params?)

fetchTicker

fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bithumb
Returns: object - a ticker structure

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchTicker (symbol, params?)

fetchOHLCV

fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of bithumb
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch OHLCV data for
timeframe	`string`	Yes	the length of time each candle represents
since	`int`	No	timestamp in ms of the earliest candle to fetch
limit	`int`	No	the maximum amount of candles to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

fetchTrades

get the list of most recent trades for a particular symbol

Kind: instance method of bithumb
Returns: Array<Trade> - a list of trade structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch trades for
since	`int`	No	timestamp in ms of the earliest trade to fetch
limit	`int`	No	the maximum amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.fetchTrades (symbol, since?, limit?, params?)

createOrders

create a list of trade orders, only available for the generation 2 API

Kind: instance method of bithumb
Returns: Array<object> - a list of order structures

See: https://apidocs.bithumb.com/reference/%EB%8B%A4%EA%B1%B4-%EC%A3%BC%EB%AC%B8-%EC%9A%94%EC%B2%AD

Param	Type	Required	Description
orders	`Array`	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	`object`	No	extra parameters specific to the exchange API endpoint
params.timeInForce	`string`	No	supports 'IOC', 'FOK', and 'PO'
params.postOnly	`bool`	No	true or false
params.clientOrderId	`string`	No	the clientOrderId of the order
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.createOrders (orders, params?)

createOrder

create a trade order

Kind: instance method of bithumb
Returns: object - an order structure

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency
price	`float`	No	the price at which the order is to be fulfilled, in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint
params.timeInForce	`string`	No	supports 'IOC', 'FOK', and 'PO'
params.postOnly	`bool`	No	true or false
params.clientOrderId	`string`	No	the clientOrderId of the order
params.cost	`string`	No	generation 2 only optional cost parameter for market buy orders instead of setting the price, must also set createMarketBuyOrderRequiresPrice to false
params.createMarketBuyOrderRequiresPrice	`bool`	No	generation 2 only set to false if passing a cost param or using cost in the amount argument, defaults to true
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.createOrder (symbol, type, side, amount, price?, params?)

createMarketBuyOrderWithCost

create a market buy order by providing the symbol and cost

Kind: instance method of bithumb
Returns: object - an order structure

See: https://apidocs.bithumb.com/reference/%EC%A3%BC%EB%AC%B8-%EC%9A%94%EC%B2%AD

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.createMarketBuyOrderWithCost (symbol, cost, params?)

createTwapOrder

create a trade order that is executed as a TWAP order over a specified duration.

Kind: instance method of bithumb
Returns: object - an order structure

See: https://apidocs.bithumb.com/reference/twap-%EC%A3%BC%EB%AC%B8-%EC%9A%94%EC%B2%AD

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency, only required for sale
duration	`int`	Yes	the duration of the TWAP order in milliseconds
params	`object`	No	extra parameters specific to the exchange API endpoint
params.frequency	`string`	Yes	required order interval in seconds, 15, 20, 30, 60 or 120
params.price	`string`	No	order price, required for purchase
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.createTwapOrder (symbol, side, amount, duration, params?)

fetchOrder

fetches information on an order made by the user

Kind: instance method of bithumb
Returns: object - An order structure

See

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	No	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderId	`string`	No	the clientOrderId of the order, alternative to using the order id
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2
params.twap	`bool`	No	generation 2 only if you want to fetch a generation 2 twap order
params.state	`string`	No	generation 2 only the order state, either wait, watch, done, or cancel. For twap either progress (default), done, or cancel

bithumb.fetchOrder (id, symbol?, params?)

fetchOpenOrders

fetch all unfilled currently open orders

Kind: instance method of bithumb
Returns: Array<Order> - a list of order structures

See

Param	Type	Required	Description
symbol	`string`	No	unified market symbol
since	`int`	No	the earliest time in ms to fetch open orders for
limit	`int`	No	the maximum number of open order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2
params.twap	`bool`	No	generation 2 only if you want to fetch generation 2 twap orders
params.state	`string`	No	generation 2 only the order state, either wait, watch, done, or cancel. For twap either progress (default), done, or cancel

bithumb.fetchOpenOrders (symbol?, since?, limit?, params?)

fetchOrders

fetches information on multiple orders made by the user

Kind: instance method of bithumb
Returns: Array<Order> - a list of order structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderIds	`Array<string>`	No	an array of client order ids
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.twap	`bool`	No	generation 2 only if you want to fetch generation 2 twap orders
params.state	`string`	No	generation 2 only the order state, either wait, watch, done, or cancel. For twap either progress (default), done, or cancel

bithumb.fetchOrders (symbol, since?, limit?, params?)

fetchClosedOrders

fetches information on multiple closed orders made by the user

Kind: instance method of bithumb
Returns: Array<Order> - a list of order structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderIds	`Array<string>`	No	an array of client order ids
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.twap	`bool`	No	if you want to fetch generation 2 twap orders

bithumb.fetchClosedOrders (symbol, since?, limit?, params?)

fetchCanceledOrders

fetches information on multiple canceled orders made by the user

Kind: instance method of bithumb
Returns: Array<object> - a list of order structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market the orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderIds	`Array<string>`	No	an array of client order ids
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.twap	`bool`	No	if you want to fetch generation 2 twap orders

bithumb.fetchCanceledOrders (symbol, since?, limit?, params?)

cancelOrder

cancels an open order

Kind: instance method of bithumb
Returns: object - An order structure

See

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	No	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderId	`string`	No	the clientOrderId of the order, alternative to using the order id
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2
params.twap	`bool`	No	if you want to cancel a generation 2 twap order

bithumb.cancelOrder (id, symbol?, params?)

cancelOrders

cancel multiple orders

Kind: instance method of bithumb
Returns: Array<object> - a list of order structures

See: https://apidocs.bithumb.com/reference/%EB%8B%A4%EA%B1%B4-%EC%A3%BC%EB%AC%B8-%EC%B7%A8%EC%86%8C-%EC%A0%91%EC%88%98

Param	Type	Required	Description
ids	`Array<string>`	Yes	order ids
symbol	`string`	No	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderIds	`Array<string>`	No	alternative to ids, array of client order ids
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.cancelOrders (ids, symbol?, params?)

withdraw

make a withdrawal

Kind: instance method of bithumb
Returns: object - a transaction structure

See

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	the amount to withdraw
address	`string`	Yes	the address to withdraw to
tag	`string`	Yes	the secondary withdrawal destination address
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2
params.network	`string`	No	the blockchain network to withdraw on, for example BTC or DASH
params.destination	`string`	No	secondary address destination for specific currencies, can alternatively use the tag argument
params.exchange_name	`string`	No	withdrawal exchange name
params.receiver_type	`string`	No	either personal or corporation
params.ko_name	`string`	No	generation 1 only the receiver name in korean
params.en_name	`string`	No	generation 1 only the receiver name in english
params.receiver_ko_name	`string`	No	generation 2 only the personal receiver name in korean
params.receiver_en_name	`string`	No	generation 2 only the personal receiver name in english
params.receiver_corp_ko_name	`string`	No	generation 2 only the corporation receiver name in korean
params.receiver_corp_en_name	`string`	No	generation 2 only the corporation receiver name in english
params.two_factor_type	`string`	No	generation 2 KRW withdraw only the two factor type, for example kakao

bithumb.withdraw (code, amount, address, tag, params?)

fetchWithdrawalWhitelist

fetch a list of allowed withdrawal addresses

Kind: instance method of bithumb
Returns: Array<object> - a list response from the exchange

See: https://apidocs.bithumb.com/reference/%EC%B6%9C%EA%B8%88-%ED%97%88%EC%9A%A9-%EC%A3%BC%EC%86%8C-%EB%A6%AC%EC%8A%A4%ED%8A%B8-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.fetchWithdrawalWhitelist (params?)

fetchWithdrawal

fetch data on a currency withdrawal via the withdrawal id

Kind: instance method of bithumb
Returns: object - a transaction structure

See: https://apidocs.bithumb.com/reference/%EA%B0%9C%EB%B3%84-%EC%B6%9C%EA%B8%88-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
id	`string`	Yes	withdrawal id
code	`string`	No	the currency code
params	`object`	No	extra parameters specific to the exchange API endpoint
params.txid	`string`	No	the transaction id for the withdrawal
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.fetchWithdrawal (id, code?, params?)

fetchWithdrawals

fetch all withdrawals made from an account

Kind: instance method of bithumb
Returns: Array<object> - a list of transaction structures

See

Param	Type	Required	Description
code	`string`	No	unified currency code
since	`int`	No	the earliest time in ms to fetch withdrawals for
limit	`int`	No	the maximum number of withdrawals to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.page	`int`	No	the number of pages to return, default is 1
params.state	`string`	No	the withdrawal state, either PROCESSING, DONE or CANCELLED
params.order_by	`string`	No	either asc or desc, desc is the default
params.uuids	`Array<string>`	No	an array of uuid strings
params.txids	`Array<string>`	No	an array of txid strings

bithumb.fetchWithdrawals (code?, since?, limit?, params?)

fetchDeposit

fetch information on a deposit

Kind: instance method of bithumb
Returns: object - a transaction structure

See: https://apidocs.bithumb.com/reference/%EA%B0%9C%EB%B3%84-%EC%9E%85%EA%B8%88-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
id	`string`	Yes	deposit id
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint
params.txid	`string`	No	the transaction id for the deposit
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.fetchDeposit (id, code, params?)

fetchDeposits

fetch all deposits made to an account

Kind: instance method of bithumb
Returns: Array<object> - a list of transaction structures

See

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch deposits for
limit	`int`	No	the maximum number of deposits to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.page	`int`	No	the number of pages to return, default is 1
params.state	`string`	No	the deposit state, for KRW, PROCESSING, ACCEPTED or CANCELLED, for others, DEPOSIT_PROCESSING, DEPOSIT_ACCEPTED, DEPOSIT_CANCELLED
params.order_by	`string`	No	either asc or desc, desc is the default
params.uuids	`Array<string>`	No	an array of uuid strings
params.txids	`Array<string>`	No	an array of txid strings

bithumb.fetchDeposits (code, since?, limit?, params?)

createDepositAddress

create a currency deposit address

Kind: instance method of bithumb
Returns: object - an address structure

See: https://apidocs.bithumb.com/reference/%EC%9E%85%EA%B8%88-%EC%A3%BC%EC%86%8C-%EC%83%9D%EC%84%B1-%EC%9A%94%EC%B2%AD

Param	Type	Required	Description
code	`string`	Yes	unified currency code of the currency for the deposit address
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.network	`string`	No	the blockchain network to create a deposit address on

bithumb.createDepositAddress (code, params?)

fetchDepositAddress

fetch the deposit address for a currency associated with this account

Kind: instance method of bithumb
Returns: object - an address structure

See: https://apidocs.bithumb.com/reference/%EA%B0%9C%EB%B3%84-%EC%9E%85%EA%B8%88-%EC%A3%BC%EC%86%8C-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2
params.network	`string`	No	network for fetch deposit address

bithumb.fetchDepositAddress (code, params?)

fetchDepositAddresses

fetch deposit addresses for multiple currencies (when available)

Kind: instance method of bithumb
Returns: object - a dictionary of address structures indexed by currency code

See: https://apidocs.bithumb.com/reference/%EC%A0%84%EC%B2%B4-%EC%9E%85%EA%B8%88-%EC%A3%BC%EC%86%8C-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
codes	`Array<string>`	No	list of unified currency codes, default is undefined (all currencies)
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.fetchDepositAddresses (codes?, params?)

watchTicker

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bithumb
Returns: object - a ticker structure

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.tickTypes	`string`	No	generation 1 only, the tick type to subscribe to, '24H' by default (30M, 1H, 12H, 24H, MID)
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.watchTicker (symbol, params?)

watchTickers

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list

Kind: instance method of bithumb
Returns: object - a dictionary of ticker structures indexed by market symbols

See

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbols of the markets to fetch tickers for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.tickTypes	`string`	No	generation 1 only, the tick type to subscribe to, '24H' by default (30M, 1H, 12H, 24H, MID)
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.watchTickers (symbols, params?)

watchOrderBook

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bithumb
Returns: object - an order book structure

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.watchOrderBook (symbol, limit?, params?)

watchTrades

get the list of most recent trades for a particular symbol

Kind: instance method of bithumb
Returns: Array<object> - a list of trade structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch trades for
since	`int`	No	timestamp in ms of the earliest trade to fetch
limit	`int`	No	the maximum amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	if you want to use the API generation 1 or 2, default is 2

bithumb.watchTrades (symbol, since?, limit?, params?)

watchBalance

watch balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bithumb
Returns: object - a balance structure

See: https://apidocs.bithumb.com/v2.1.5/reference/%EB%82%B4-%EC%9E%90%EC%82%B0-myasset

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.watchBalance (params?)

watchOrders

watches information on multiple orders made by the user

Kind: instance method of bithumb
Returns: Array<object> - a list of order structures

See: https://apidocs.bithumb.com/v2.1.5/reference/%EB%82%B4-%EC%A3%BC%EB%AC%B8-%EB%B0%8F-%EC%B2%B4%EA%B2%B0-myorder

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.codes	`Array<string>`	No	market codes to filter orders
params.generation	`int`	No	only generation 2 is supported if you want to use the API generation 1 or 2, default is 2

bithumb.watchOrders (symbol, since?, limit?, params?)

bithumb

On this page