Skip to content

timex

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

timex{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 timex
Returns: int - the current integer timestamp in milliseconds from the exchange server

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

fetchMarkets{docsify-ignore}

retrieves data on all markets for timex

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/listMarkets

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

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/listCurrencies

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

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Manager/getDeposits

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

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made to an account

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Manager/getWithdraws

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 transaction structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
timex.fetchWithdrawals (code[, since, limit, 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 timex
Returns: object - a dictionary of ticker structures

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/listTickers

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 
timex.fetchTickers (symbols[, 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 timex
Returns: object - a ticker structure

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/listTickers

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

fetchOrderBook{docsify-ignore}

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

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/orderbookV2

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/listTrades

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Public/listCandles

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
params.until int No timestamp in ms of the latest candle to fetch 
timex.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 timex
Returns: object - a balance structure

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Trading/getBalances

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

createOrder{docsify-ignore}

create a trade order

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Trading/createOrder

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Trading/deleteOrders

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

cancelOrders{docsify-ignore}

cancel multiple orders

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Trading/deleteOrders

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 
timex.cancelOrders (ids, symbol[, params])

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/History/getOrderDetails

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Trading/getOpenOrders

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/History/getOrders

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/History/getTrades_1

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

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of timex
Returns: object - a fee structure

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Trading/getFees

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

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account, does not accept params["network"]

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

See: https://plasma-relay-backend.timex.io/swagger-ui/index.html?urls.primaryName=Relay#/Currency/selectCurrencyBySymbol

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint 
timex.fetchDepositAddress (code[, 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