-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
bithumb
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchOHLCV
- fetchTrades
- createOrder
- fetchOrder
- fetchOpenOrders
- cancelOrder
- withdraw
- watchTicker
- watchTickers
- watchOrderBook
- watchTrades
- watchBalance
- watchOrders
retrieves data on all markets for bithumb
Kind: instance method of bithumb
Returns: Array<object> - an array of objects representing market data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
bithumb.fetchMarkets ([params])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])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
| 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])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
| 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])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
| 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])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])get the list of most recent trades for a particular symbol
Kind: instance method of bithumb
Returns: Array<Trade> - a list of trade structures
| 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])create a trade order
Kind: instance method of bithumb
Returns: object - an order structure
See
- https://apidocs.bithumb.com/v1.2.0/reference/%EC%A7%80%EC%A0%95%EA%B0%80-%EC%A3%BC%EB%AC%B8%ED%95%98%EA%B8%B0
- https://apidocs.bithumb.com/v1.2.0/reference/%EC%8B%9C%EC%9E%A5%EA%B0%80-%EB%A7%A4%EC%88%98%ED%95%98%EA%B8%B0
- https://apidocs.bithumb.com/v1.2.0/reference/%EC%8B%9C%EC%9E%A5%EA%B0%80-%EB%A7%A4%EB%8F%84%ED%95%98%EA%B8%B0
| 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])fetches information on an order made by the user
Kind: instance method of bithumb
Returns: object - An order structure
| 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])fetch all unfilled currently open orders
Kind: instance method of bithumb
Returns: Array<Order> - a list of order structures
| 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])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])make a withdrawal
Kind: instance method of bithumb
Returns: object - a transaction structure
| 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])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
| 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])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
| 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])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
| 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])get the list of most recent trades for a particular symbol
Kind: instance method of bithumb
Returns: Array<object> - a list of trade structures
| 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])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])watches information on multiple orders made by the user
Kind: instance method of bithumb
Returns: Array<object> - a list of order structures
| 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])(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)
- Install
- Examples
- Manual
- CCXT Pro
- Contributing
- Supported Exchanges
- Exchanges By Country
- API Spec By Method
- FAQ
- Changelog
- Awesome
- API Spec by Exchange
- fetchCurrencies
- alpaca
- apex
- arkham
- ascendex
- aster
- backpack
- bigone
- binance
- bingx
- bit2c
- bitbank
- bitbns
- bitfinex
- bitflyer
- bitget
- bithumb
- bitmart
- bitmex
- bitopro
- bitrue
- bitso
- bitstamp
- bitteam
- bittrade
- bitvavo
- blockchaincom
- blofin
- btcbox
- btcmarkets
- btcturk
- bullish
- bybit
- bydfi
- cex
- coinbase
- coinbaseexchange
- coinbaseinternational
- coincheck
- coinex
- coinmate
- coinmetro
- coinone
- coinsph
- coinspot
- cryptocom
- cryptomus
- deepcoin
- delta
- deribit
- derive
- digifinex
- dydx
- exmo
- foxbit
- gate
- gemini
- grvt
- hashkey
- hibachi
- hitbtc
- hollaex
- htx
- hyperliquid
- independentreserve
- indodax
- kraken
- krakenfutures
- kucoin
- fetchBidsAsks
- latoken
- lbank
- lighter
- luno
- mercado
- mexc
- modetrade
- ndax
- novadax
- okx
- onetrading
- oxfun
- p2b
- pacifica
- paradex
- paymium
- phemex
- poloniex
- tokocrypto
- toobit
- upbit
- wavesexchange
- weex
- whitebit
- woo
- woofipro
- xt
- yobit
- zaif
- fetchStatus