bithumb

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

bithumb

Kind: global class
Extends: Exchange

fetchMarkets
fetchBalance
fetchOrderBook
fetchTickers
fetchTicker
fetchOHLCV
fetchTrades
createOrder
fetchOrder
fetchOpenOrders
cancelOrder
withdraw
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: https://apidocs.bithumb.com/v1.2.0/reference/%ED%98%84%EC%9E%AC%EA%B0%80-%EC%A0%95%EB%B3%B4-%EC%A1%B0%ED%9A%8C-all

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

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: https://apidocs.bithumb.com/v1.2.0/reference/%EB%B3%B4%EC%9C%A0%EC%9E%90%EC%82%B0-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

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 - A dictionary of order book structures indexed by market symbols

See: https://apidocs.bithumb.com/v1.2.0/reference/%ED%98%B8%EA%B0%80-%EC%A0%95%EB%B3%B4-%EC%A1%B0%ED%9A%8C

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

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: https://apidocs.bithumb.com/v1.2.0/reference/%ED%98%84%EC%9E%AC%EA%B0%80-%EC%A0%95%EB%B3%B4-%EC%A1%B0%ED%9A%8C-all

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

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: https://apidocs.bithumb.com/v1.2.0/reference/%ED%98%84%EC%9E%AC%EA%B0%80-%EC%A0%95%EB%B3%B4-%EC%A1%B0%ED%9A%8C

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

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: https://apidocs.bithumb.com/v1.2.0/reference/candlestick-rest-api

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

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: https://apidocs.bithumb.com/v1.2.0/reference/%EC%B5%9C%EA%B7%BC-%EC%B2%B4%EA%B2%B0-%EB%82%B4%EC%97%AD

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

bithumb.fetchTrades (symbol, since?, limit?, 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, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint

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

fetchOrder

fetches information on an order made by the user

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

See: https://apidocs.bithumb.com/v1.2.0/reference/%EA%B1%B0%EB%9E%98-%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD-%EC%83%81%EC%84%B8-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint

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: https://apidocs.bithumb.com/v1.2.0/reference/%EA%B1%B0%EB%9E%98-%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD-%EC%A1%B0%ED%9A%8C

Param	Type	Required	Description
symbol	`string`	Yes	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

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

cancelOrder

cancels an open order

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

See: https://apidocs.bithumb.com/v1.2.0/reference/%EC%A3%BC%EB%AC%B8-%EC%B7%A8%EC%86%8C%ED%95%98%EA%B8%B0

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint

bithumb.cancelOrder (id, symbol, params?)

withdraw

make a withdrawal

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

See: https://apidocs.bithumb.com/v1.2.0/reference/%EC%BD%94%EC%9D%B8-%EC%B6%9C%EA%B8%88%ED%95%98%EA%B8%B0-%EA%B0%9C%EC%9D%B8

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
params	`object`	No	extra parameters specific to the exchange API endpoint

bithumb.withdraw (code, amount, address, tag, 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: https://apidocs.bithumb.com/v1.2.0/reference/%EB%B9%97%EC%8D%B8-%EA%B1%B0%EB%9E%98%EC%86%8C-%EC%A0%95%EB%B3%B4-%EC%88%98%EC%8B%A0

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.channel	`string`	No	the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers

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 ticker structure

See: https://apidocs.bithumb.com/v1.2.0/reference/%EB%B9%97%EC%8D%B8-%EA%B1%B0%EB%9E%98%EC%86%8C-%EC%A0%95%EB%B3%B4-%EC%88%98%EC%8B%A0

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

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 - A dictionary of order book structures indexed by market symbols

See: https://apidocs.bithumb.com/v1.2.0/reference/%EB%B9%97%EC%8D%B8-%EA%B1%B0%EB%9E%98%EC%86%8C-%EC%A0%95%EB%B3%B4-%EC%88%98%EC%8B%A0

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

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: https://apidocs.bithumb.com/v1.2.0/reference/%EB%B9%97%EC%8D%B8-%EA%B1%B0%EB%9E%98%EC%86%8C-%EC%A0%95%EB%B3%B4-%EC%88%98%EC%8B%A0

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

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

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

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

bithumb

On this page