mzoe/ritmex-bot
1
0
Fork 0
mirror of https://github.com/discountry/ritmex-bot.git synced 2026-09-09 16:28:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fd034d493f85028731dd4e9729c579e3e1acd7cd
ritmex-bot/docs/ccxt/wiki/exchanges/woofipro.md
T
discountry fcb83bd16b commit
2025-10-03 15:28:16 +08:00

44 KiB
Raw Blame History

woofipro{docsify-ignore}

Kind: global class
Extends: Exchange

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of woofipro
Returns: object - a status structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-system-maintenance-status

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

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-system-maintenance-status

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

fetchMarkets{docsify-ignore}

retrieves data on all markets for woofipro

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-available-symbols

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

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-market-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 
woofipro.fetchTrades (symbol[, since, limit, params])

fetchFundingInterval{docsify-ignore}

fetch the current funding rate interval

Kind: instance method of woofipro
Returns: object - a funding rate structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rate-for-one-market

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchFundingInterval (symbol[, params])

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of woofipro
Returns: object - a funding rate structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rate-for-one-market

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchFundingRate (symbol[, params])

fetchFundingRates{docsify-ignore}

fetch the current funding rate for multiple markets

Kind: instance method of woofipro
Returns: Array<object> - an array of funding rate structures

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rates-for-all-markets

Param Type Required Description
symbols Array<string> Yes unified market symbols
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchFundingRates (symbols[, params])

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

Kind: instance method of woofipro
Returns: Array<object> - a list of funding rate structures

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-funding-rate-history-for-one-market

Param Type Required Description
symbol string Yes unified symbol of the market to fetch the funding rate history for
since int No timestamp in ms of the earliest funding rate to fetch
limit int No the maximum amount of funding rate structures to fetch
params object No extra parameters specific to the exchange API endpoint
params.until int No timestamp in ms of the latest funding rate
params.paginate boolean No default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters 
woofipro.fetchFundingRateHistory (symbol[, since, limit, params])

fetchFundingHistory{docsify-ignore}

fetch the history of funding payments paid and received on this account

Kind: instance method of woofipro
Returns: object - a funding history structure

See: https://orderly.network/docs/build-on-omnichain/evm-api/restful-api/private/get-funding-fee-history

Param Type Required Description
symbol string No unified market symbol
since int No the earliest time in ms to fetch funding history for
limit int No the maximum number of funding history structures to retrieve
params object No extra parameters specific to the exchange API endpoint
params.paginate boolean No default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters 
woofipro.fetchFundingHistory ([symbol, since, limit, params])

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-account-information

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

fetchOrderBook{docsify-ignore}

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

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/orderbook-snapshot

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 
woofipro.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 woofipro
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-kline

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 max=1000, max=100 when since is defined and is less than (now - (999 * (timeframe in ms)))
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchOHLCV (symbol, timeframe[, since, limit, params])

createOrder{docsify-ignore}

create a trade order

Kind: instance method of woofipro
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
params.triggerPrice float No The price a trigger order is triggered at
params.takeProfit object No takeProfit object in params containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
params.takeProfit.triggerPrice float No take profit trigger price
params.stopLoss object No stopLoss object in params containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
params.stopLoss.triggerPrice float No stop loss trigger price
params.algoType float No 'STOP'or 'TP_SL' or 'POSITIONAL_TP_SL'
params.cost float No spot market buy only the quote quantity that can be used as an alternative for the amount
params.clientOrderId string No a unique id for the order 
woofipro.createOrder (symbol, type, side, amount[, price, params])

createOrders{docsify-ignore}

contract only create a list of trade orders

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-create-order

Param Type Required Description
orders Array Yes list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params object No extra parameters specific to the exchange API endpoint 
woofipro.createOrders (orders[, params])

editOrder{docsify-ignore}

edit a trade order

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

See

Param Type Required Description
id string Yes order id
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
params.triggerPrice float No The price a trigger order is triggered at
params.stopLossPrice float No price to trigger stop-loss orders
params.takeProfitPrice float No price to trigger take-profit orders 
woofipro.editOrder (id, symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

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

See

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
params.trigger boolean No whether the order is a stop/algo order
params.clientOrderId string No a unique id for the order 
woofipro.cancelOrder (id, symbol[, params])

cancelOrders{docsify-ignore}

cancel multiple orders

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

See

Param Type Required Description
ids Array<string> Yes order ids
symbol string No unified market symbol
params object No extra parameters specific to the exchange API endpoint
params.client_order_ids Array<string> No max length 10 e.g. ["my_id_1","my_id_2"], encode the double quotes. No space after comma 
woofipro.cancelOrders (ids[, symbol, params])

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

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

See

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint
params.trigger boolean No whether the order is a stop/algo order 
woofipro.cancelAllOrders (symbol[, params])

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See

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
params.trigger boolean No whether the order is a stop/algo order
params.clientOrderId string No a unique id for the order 
woofipro.fetchOrder (id, symbol[, params])

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See

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.trigger boolean No whether the order is a stop/algo order
params.is_triggered boolean No whether the order has been triggered (false by default)
params.side string No 'buy' or 'sell'
params.paginate boolean No set to true if you want to fetch orders with pagination
params.until int Yes timestamp in ms of the latest order to fetch 
woofipro.fetchOrders (symbol[, since, limit, params])

fetchOpenOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See

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.trigger boolean No whether the order is a stop/algo order
params.is_triggered boolean No whether the order has been triggered (false by default)
params.side string No 'buy' or 'sell'
params.until int Yes timestamp in ms of the latest order to fetch
params.paginate boolean No set to true if you want to fetch orders with pagination 
woofipro.fetchOpenOrders (symbol[, since, limit, params])

fetchClosedOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See

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.trigger boolean No whether the order is a stop/algo order
params.is_triggered boolean No whether the order has been triggered (false by default)
params.side string No 'buy' or 'sell'
params.until int Yes timestamp in ms of the latest order to fetch
params.paginate boolean No set to true if you want to fetch orders with pagination 
woofipro.fetchClosedOrders (symbol[, since, limit, params])

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-all-trades-of-specific-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 
woofipro.fetchOrderTrades (id, symbol[, since, limit, params])

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/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
params.paginate boolean No set to true if you want to fetch trades with pagination
params.until int Yes timestamp in ms of the latest trade to fetch 
woofipro.fetchMyTrades (symbol[, 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 woofipro
Returns: object - a balance structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-current-holding

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

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 woofipro
Returns: object - a ledger structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history

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 
woofipro.fetchLedger ([code, since, limit, params])

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history

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 
woofipro.fetchDeposits (code[, since, limit, params])

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history

Param Type Required Description
code string Yes unified currency code
since int No the earliest time in ms to fetch withdrawals for
limit int No the maximum number of withdrawals structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchWithdrawals (code[, since, limit, params])

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

Kind: instance method of woofipro
Returns: object - a list of transaction structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history

Param Type Required Description
code string No unified currency code for the currency of the deposit/withdrawals, default is undefined
since int No timestamp in ms of the earliest deposit/withdrawal, default is undefined
limit int No max number of deposit/withdrawals to return, default is undefined
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchDepositsWithdrawals ([code, since, limit, params])

withdraw{docsify-ignore}

make a withdrawal

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

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-withdraw-request

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 
woofipro.withdraw (code, amount, address, tag[, params])

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

Kind: instance method of woofipro
Returns: object - a leverage structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-account-information

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchLeverage (symbol[, params])

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of woofipro
Returns: object - response from the exchange

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/update-leverage-setting

Param Type Required Description
leverage int No the rate of leverage
symbol string No unified market symbol
params object No extra parameters specific to the exchange API endpoint 
woofipro.setLeverage ([leverage, symbol, params])

fetchPosition{docsify-ignore}

fetch data on an open position

Kind: instance method of woofipro
Returns: object - a position structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-one-position-info

Param Type Required Description
symbol string Yes unified market symbol of the market the position is held in
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchPosition (symbol[, params])

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of woofipro
Returns: Array<object> - a list of position structure

See: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-all-positions-info

Param Type Required Description
symbols Array<string> No list of unified market symbols
params object No extra parameters specific to the exchange API endpoint 
woofipro.fetchPositions ([symbols, params])

watchOrderBook{docsify-ignore}

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

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

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/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 
woofipro.watchOrderBook (symbol[, limit, 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 woofipro
Returns: object - a ticker structure

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/24-hour-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 
woofipro.watchTicker (symbol[, params])

watchTickers{docsify-ignore}

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

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/24-hour-tickers

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 
woofipro.watchTickers (symbols[, params])

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

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

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/bbos

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 
woofipro.watchBidsAsks (symbols[, 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 woofipro
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/k-line

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

watchTrades{docsify-ignore}

watches information on multiple trades made in a market

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

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/trade

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

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

See

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.trigger bool No true if trigger order 
woofipro.watchOrders (symbol[, since, limit, params])

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

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

See

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.trigger bool No true if trigger order 
woofipro.watchMyTrades (symbol[, since, limit, params])

watchPositions{docsify-ignore}

watch all open positions

Kind: instance method of woofipro
Returns: Array<object> - a list of position structure

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/position-push

Param Type Required Description
symbols Array<string> No list of unified market symbols
since Yes timestamp in ms of the earliest position to fetch
limit Yes the maximum number of positions to fetch
params object Yes extra parameters specific to the exchange API endpoint 
woofipro.watchPositions ([symbols, 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 woofipro
Returns: object - a balance structure

See: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/balance

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
woofipro.watchBalance ([params])
Reference in New Issue View Git Blame Copy Permalink