Skip to content

btcbox

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

btcbox{docsify-ignore}

Kind: global class
Extends: Exchange

fetchMarkets{docsify-ignore}

retrieves data on all markets for ace

Kind: instance method of btcbox
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 
btcbox.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 btcbox
Returns: object - a balance structure

See: https://blog.btcbox.jp/en/archives/8762#toc13

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
btcbox.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 btcbox
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://blog.btcbox.jp/en/archives/8762#toc6

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 
btcbox.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 btcbox
Returns: object - a ticker structure

See: https://blog.btcbox.jp/en/archives/8762#toc5

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

fetchTickers{docsify-ignore}

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

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

Param Type Required Description
symbols Array<string> No 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 
btcbox.fetchTickers ([symbols, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://blog.btcbox.jp/en/archives/8762#toc7

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

createOrder{docsify-ignore}

create a trade order

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

See: https://blog.btcbox.jp/en/archives/8762#toc18

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://blog.btcbox.jp/en/archives/8762#toc17

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 
btcbox.cancelOrder (id, symbol[, params])

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://blog.btcbox.jp/en/archives/8762#toc16

Param Type Required Description
id string Yes the 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 
btcbox.fetchOrder (id, symbol[, params])

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://blog.btcbox.jp/en/archives/8762#toc15

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://blog.btcbox.jp/en/archives/8762#toc15

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 
btcbox.fetchOpenOrders (symbol[, since, limit, 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