Skip to content

bitso

Jump to bottom
github-actions[bot] edited this page Apr 6, 2026 · 1 revision

bitso{docsify-ignore}

Kind: global class
Extends: Exchange

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of bitso
Returns: object - a ledger structure

Param Type Required Description
code string No unified currency code, default is undefined
since int No timestamp in ms of the earliest ledger entry, default is undefined
limit int No max number of ledger entries to return, default is undefined
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchLedger ([code, since, limit, params])

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitso

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

See: https://docs.bitso.com/bitso-api/docs/list-available-books

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchMarkets ([params])

fetchBalance{docsify-ignore}

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

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

See: https://docs.bitso.com/bitso-api/docs/get-account-balance

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchBalance ([params])

fetchOrderBook{docsify-ignore}

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

Kind: instance method of bitso
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://docs.bitso.com/bitso-api/docs/list-order-book

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 
bitso.fetchOrderBook (symbol[, limit, params])

fetchTicker{docsify-ignore}

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

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

See: https://docs.bitso.com/bitso-api/docs/ticker

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 
bitso.fetchTicker (symbol[, params])

fetchOHLCV{docsify-ignore}

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

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

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 
bitso.fetchOHLCV (symbol, timeframe[, since, limit, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://docs.bitso.com/bitso-api/docs/list-trades

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 
bitso.fetchTrades (symbol[, since, limit, params])

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of bitso
Returns: object - a dictionary of fee structures indexed by market symbols

See: https://docs.bitso.com/bitso-api/docs/list-fees

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchTradingFees ([params])

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://docs.bitso.com/bitso-api/docs/user-trades

Param Type Required Description
symbol string Yes unified market symbol
since int No the earliest time in ms to fetch trades for
limit int No the maximum number of trades structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchMyTrades (symbol[, since, limit, params])

createOrder{docsify-ignore}

create a trade order

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

See: https://docs.bitso.com/bitso-api/docs/place-an-order

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 
bitso.createOrder (symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://docs.bitso.com/bitso-api/docs/cancel-an-order

Param Type Required Description
id string Yes order id
symbol string Yes not used by bitso cancelOrder ()
params object No extra parameters specific to the exchange API endpoint 
bitso.cancelOrder (id, symbol[, params])

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of bitso
Returns: object - an list of order structures

See: https://docs.bitso.com/bitso-api/docs/cancel-an-order

Param Type Required Description
ids Array<string> Yes order ids
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
bitso.cancelOrders (ids, symbol[, params])

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See: https://docs.bitso.com/bitso-api/docs/cancel-an-order

Param Type Required Description
symbol undefined Yes bitso does not support canceling orders for only a specific market
params object No extra parameters specific to the exchange API endpoint 
bitso.cancelAllOrders (symbol[, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://docs.bitso.com/bitso-api/docs/list-open-orders

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 orders structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchOpenOrders (symbol[, since, limit, params])

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://docs.bitso.com/bitso-api/docs/look-up-orders

Param Type Required Description
id string Yes the order id
symbol string Yes not used by bitso fetchOrder
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchOrder (id, symbol[, params])

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

See: https://docs.bitso.com/bitso-api/docs/list-user-trades

Param Type Required Description
id string Yes order id
symbol string Yes unified market symbol
since int No the earliest time in ms to fetch trades for
limit int No the maximum number of trades to retrieve
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchOrderTrades (id, symbol[, since, limit, params])

fetchDeposit{docsify-ignore}

fetch information on a deposit

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

See: https://docs.bitso.com/bitso-payouts-funding/docs/fundings

Param Type Required Description
id string Yes deposit id
code string Yes bitso does not support filtering by currency code and will ignore this argument
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchDeposit (id, code[, params])

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://docs.bitso.com/bitso-payouts-funding/docs/fundings

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 structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchDeposits (code[, since, limit, params])

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

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

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchDepositAddress (code[, params])

fetchTransactionFees{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFees instead

Kind: instance method of bitso
Returns: Array<object> - a list of fee structures

See: https://docs.bitso.com/bitso-api/docs/list-fees

Param Type Required Description
codes Array<string>, undefined Yes list of unified currency codes
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchTransactionFees (codes[, params])

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of bitso
Returns: Array<object> - a list of fee structures

See: https://docs.bitso.com/bitso-api/docs/list-fees

Param Type Required Description
codes Array<string>, undefined Yes list of unified currency codes
params object No extra parameters specific to the exchange API endpoint 
bitso.fetchDepositWithdrawFees (codes[, params])

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of bitso
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 
bitso.withdraw (code, amount, address, tag[, params])

(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)

Clone this wiki locally