Skip to content

onetrading

github-actions[bot] edited this page Jun 11, 2026 · 2 revisions

onetrading{docsify-ignore}

Kind: global class
Extends: Exchange

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of onetrading
Returns: int - the current integer timestamp in milliseconds from the exchange server

See: https://docs.onetrading.com/rest/public/time

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
onetrading.fetchTime (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of onetrading
Returns: object - an associative dictionary of currencies

See: https://docs.onetrading.com/rest/public/currencies

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
onetrading.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for onetrading

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

See: https://docs.onetrading.com/rest/public/instruments

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
onetrading.fetchMarkets (params?)

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

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

See

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
params.method string No fetchPrivateTradingFees or fetchPublicTradingFees
onetrading.fetchTradingFees (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 onetrading
Returns: object - a ticker structure

See: https://docs.onetrading.com/rest/public/market-ticker-instrument

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
onetrading.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 onetrading
Returns: object - a dictionary of ticker structures

See: https://docs.onetrading.com/rest/public/market-ticker

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
onetrading.fetchTickers (symbols?, params?)

fetchOrderBook{docsify-ignore}

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

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

See: https://docs.onetrading.com/rest/public/orderbook

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
onetrading.fetchOrderBook (symbol, limit?, 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 onetrading
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.onetrading.com/rest/public/candlesticks

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
onetrading.fetchOHLCV (symbol, timeframe, since?, limit?, 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 onetrading
Returns: object - a balance structure

See: https://docs.onetrading.com/rest/trading/balances

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
onetrading.fetchBalance (params?)

createOrder{docsify-ignore}

create a trade order

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

See: https://docs.onetrading.com/rest/trading/create-order

Param Type Required Description
symbol string Yes unified symbol of the market to create an order in
type string Yes '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
params.triggerPrice float No onetrading only does stop limit orders and does not do stop market
onetrading.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

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

See

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

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See: https://docs.onetrading.com/rest/trading/cancel-all-orders

Param Type Required Description
symbol string Yes unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params object No extra parameters specific to the exchange API endpoint
onetrading.cancelAllOrders (symbol, params?)

cancelOrders{docsify-ignore}

cancel multiple orders

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

See: https://docs.onetrading.com/rest/trading/cancel-all-orders

Param Type Required Description
ids Array<string> Yes order ids
symbol string Yes unified market symbol, default is undefined
params object No extra parameters specific to the exchange API endpoint
onetrading.cancelOrders (ids, symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://docs.onetrading.com/rest/trading/get-order-order-id

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://docs.onetrading.com/rest/trading/get-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
onetrading.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://docs.onetrading.com/rest/trading/get-orders

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
onetrading.fetchClosedOrders (symbol, since?, limit?, params?)

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

See: https://docs.onetrading.com/rest/trading/get-trades-for-order

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
onetrading.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://docs.onetrading.com/rest/trading/get-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
onetrading.fetchMyTrades (symbol, since?, limit?, params?)

watchBalance{docsify-ignore}

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

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

See: https://developers.bitpanda.com/exchange/#account-history-channel

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
onetrading.watchBalance (params?)

watchTicker{docsify-ignore}

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

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

See: https://developers.bitpanda.com/exchange/#market-ticker-channel

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
onetrading.watchTicker (symbol, params?)

watchTickers{docsify-ignore}

watches price tickers, a statistical calculation with the information for all markets or those specified.

Kind: instance method of onetrading
Returns: object - an array of ticker structure

See: https://developers.bitpanda.com/exchange/#market-ticker-channel

Param Type Required Description
symbols string Yes unified symbols of the markets to fetch the ticker for
params object No extra parameters specific to the exchange API endpoint
onetrading.watchTickers (symbols, params?)

watchMyTrades{docsify-ignore}

get the list of trades associated with the user

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

See: https://developers.bitpanda.com/exchange/#account-history-channel

Param Type Required Description
symbol string Yes unified symbol of the market to fetch trades for. Use 'any' to watch all trades
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
onetrading.watchMyTrades (symbol, since?, limit?, params?)

watchOrderBook{docsify-ignore}

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

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

See: https://developers.bitpanda.com/exchange/#market-ticker-channel

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
onetrading.watchOrderBook (symbol, limit?, params?)

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

See: https://developers.bitpanda.com/exchange/#account-history-channel

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.channel string No can listen to orders using ACCOUNT_HISTORY or TRADING
onetrading.watchOrders (symbol, since?, limit?, params?)

watchOHLCV{docsify-ignore}

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

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

See: https://developers.bitpanda.com/exchange/#candlesticks-channel

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
onetrading.watchOHLCV (symbol, timeframe, since?, limit?, params?)

Clone this wiki locally