grvt
grvt cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
grvt
Kind: global class
Extends: Exchange
- signIn
- fetchMarkets
- fetchCurrencies
- fetchTicker
- fetchOrderBook
- fetchTrades
- fetchOHLCV
- fetchFundingRateHistory
- fetchBalance
- fetchDeposits
- fetchTransfers
- transfer
- withdraw
- createOrder
- fetchMyTrades
- fetchPositions
- fetchLeverages
- setLeverage
- fetchMarginModes
- fetchFundingHistory
- fetchOrders
- fetchOpenOrders
- fetchOrder
- cancelAllOrders
- cancelOrder
- watchTicker
- watchTickers
- watchTrades
- watchTradesForSymbols
- watchOHLCV
- watchOHLCVForSymbols
- watchOrderBook
- watchOrderBookForSymbols
- watchMyTrades
- watchPositions
- watchOrders
signIn
sign in, must be called prior to using other authenticated methods
Kind: instance method of grvt
Returns: response from exchange
See: https://api-docs.grvt.io/#authentication
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.signIn (params?)fetchMarkets
retrieves data on all markets
Kind: instance method of grvt
Returns: Array<object> - an array of objects representing market data
See: https://api-docs.grvt.io/market_data_api/#get-instrument-prod
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange api endpoint |
grvt.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of grvt
Returns: object - an associative dictionary of currencies
See: https://api-docs.grvt.io/market_data_api/#get-currency-response
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.fetchCurrencies (params?)fetchTicker
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of grvt
Returns: object - a ticker structure
See: https://api-docs.grvt.io/market_data_api/#ticker_1
| 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 |
grvt.fetchTicker (symbol, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of grvt
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://api-docs.grvt.io/market_data_api/#orderbook-levels
| 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 |
| params.loc | string | No | crypto location, default: us |
grvt.fetchOrderBook (symbol, limit?, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of grvt
Returns: Array<Trade> - a list of trade structures
See: https://api-docs.grvt.io/market_data_api/#trade_1
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market |
| since | int | No | timestamp in ms of the earliest item to fetch |
| limit | int | No | the maximum amount of items to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms for the ending date filter, default is the current time |
grvt.fetchTrades (symbol, since?, limit?, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of grvt
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-docs.grvt.io/market_data_api/#candlestick_1
| 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 item to fetch |
| limit | int | No | the maximum amount of items to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms for the ending date filter, default is the current time |
| 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 |
grvt.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchFundingRateHistory
fetches historical funding rate prices
Kind: instance method of grvt
Returns: Array<object> - a list of funding rate structures
See: https://api-docs.grvt.io/market_data_api/#funding-rate
| 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 item |
| 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 |
grvt.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchBalance
query for account info
Kind: instance method of grvt
Returns: object - a balance structure
See: https://api-docs.grvt.io/trading_api/#sub-account-summary
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.fetchBalance (params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of grvt
Returns: Array<object> - a list of transaction structures
See: https://api-docs.grvt.io/trading_api/#transfer
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | 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 |
| params.until | int | No | timestamp in ms of the latest item |
grvt.fetchDeposits (code?, since?, limit?, params?)fetchTransfers
fetch a history of internal transfers made on an account
Kind: instance method of grvt
Returns: Array<object> - a list of transfer structures
See: https://api-docs.grvt.io/trading_api/#transfer-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code of the currency transferred |
| since | int | No | the earliest time in ms to fetch transfers for |
| limit | int | No | the maximum number of transfers structures to retrieve (default 10, max 100) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean | No | whether to paginate the results (default false) |
grvt.fetchTransfers (code, since?, limit?, params?)transfer
transfer currency internally between wallets on the same account
Kind: instance method of grvt
Returns: object - a transfer structure
See: https://api-docs.grvt.io/trading_api/#transfer_1
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency codeåå |
| amount | float | Yes | amount to transfer |
| fromAccount | string | Yes | account to transfer from |
| toAccount | string | Yes | account to transfer to |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.transfer (code, amount, fromAccount, toAccount, params?)withdraw
make a withdrawal
Kind: instance method of grvt
Returns: object - a transaction structure
See: https://api-docs.grvt.io/trading_api/#withdrawal
| 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 |
| params.network | string | Yes | the network to withdraw on (mandatory) |
grvt.withdraw (code, amount, address, tag, params?)createOrder
create a trade order
Kind: instance method of grvt
Returns: object - an order structure
See: https://api-docs.grvt.io/trading_api/#create-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 fullfilled, 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 | The price a stop loss order is triggered at |
| params.takeProfitPrice | float | No | The price a take profit order is triggered at |
| params.timeInForce | string | No | "GTC", "IOC", or "POST_ONLY" |
| params.postOnly | bool | No | true or false |
| params.reduceOnly | bool | No | Ensures that the executed order does not flip the opened position. |
| params.clientOrderId | string | No | a unique id for the order |
grvt.createOrder (symbol, type, side, amount, price?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of grvt
Returns: Array<Trade> - a list of trade structures
See: https://api-docs.grvt.io/trading_api/#fill-history
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| 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 |
| params.until | int | No | timestamp in ms of the latest item |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
grvt.fetchMyTrades (symbol?, since?, limit?, params?)fetchPositions
fetch all open positions
Kind: instance method of grvt
Returns: Array<object> - a list of position structures
See: https://api-docs.grvt.io/trading_api/#positions-request
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.fetchPositions (symbols, params?)fetchLeverages
fetch the set leverage for all contract markets
Kind: instance method of grvt
Returns: object - a list of leverage structures
See: https://api-docs.grvt.io/trading_api/#get-all-initial-leverage
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | a list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.fetchLeverages (symbols?, params?)setLeverage
set the level of leverage for a market
Kind: instance method of grvt
Returns: object - response from the exchange
See: https://api-docs.grvt.io/trading_api/#set-initial-leverage
| Param | Type | Required | Description |
|---|---|---|---|
| leverage | float | Yes | the rate of leverage |
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.setLeverage (leverage, symbol, params?)fetchMarginModes
fetches margin mode of the user
Kind: instance method of grvt
Returns: object - a list of margin mode structures
See: https://api-docs.grvt.io/trading_api/#get-all-initial-leverage
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.fetchMarginModes (symbols, params?)fetchFundingHistory
fetch the history of funding payments paid and received on this account
Kind: instance method of grvt
Returns: object - a funding history structure
See: https://api-docs.grvt.io/trading_api/#funding-payment-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.until | int | No | timestamp in ms of the latest item |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
grvt.fetchFundingHistory (symbol?, since?, limit?, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of grvt
Returns: Array<Order> - a list of order structures
See: https://api-docs.grvt.io/trading_api/#order-history
| 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.until | int | No | timestamp in ms of the latest item |
grvt.fetchOrders (symbol, since?, limit?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of grvt
Returns: Array<Order> - a list of order structures
See: https://api-docs.grvt.io/trading_api/#open-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| 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 |
grvt.fetchOpenOrders (symbol?, since?, limit?, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of grvt
Returns: object - An order structure
See: https://api-docs.grvt.io/trading_api/#get-order
| 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.clientOrderId | string | No | client order id |
grvt.fetchOrder (id, symbol, params?)cancelAllOrders
cancel all open orders in a market
Kind: instance method of grvt
Returns: Array<object> - a list of order structures
See: https://api-docs.grvt.io/trading_api/#cancel-all-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | cancel alls open orders |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.cancelAllOrders (symbol, params?)cancelOrder
cancels an open order
Kind: instance method of grvt
Returns: object - An order structure
See: https://api-docs.grvt.io/trading_api/#cancel-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | No | unified symbol of the market the order was made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string | No | client order id |
grvt.cancelOrder (id, symbol?, params?)watchTicker
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of grvt
Returns: object - a ticker structure
See: https://api-docs.grvt.io/market_data_streams/#mini-ticker-snap-feed-selector
| 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 |
grvt.watchTicker (symbol, params?)watchTickers
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 grvt
Returns: object - a ticker structure
See: https://docs.backpack.exchange/#tag/Streams/Public/Ticker
| 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 |
grvt.watchTickers (symbols, params?)watchTrades
watches information on multiple trades made in a market
Kind: instance method of grvt
Returns: Array<object> - a list of trade structures
See: https://api-docs.grvt.io/market_data_streams/#trade_1
| 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 orders for |
| limit | int | No | the maximum number of trade structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.watchTrades (symbol, since?, limit?, params?)watchTradesForSymbols
get the list of most recent trades for a list of symbols
Kind: instance method of grvt
Returns: Array<object> - a list of trade structures
See: https://api-docs.grvt.io/market_data_streams/#trade_1
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<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 |
| params.limit | string | No | 50, 200, 500, 1000 (default 50) |
grvt.watchTradesForSymbols (symbols, since?, limit?, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of grvt
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-docs.grvt.io/market_data_streams/#candlestick_1
| 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 |
grvt.watchOHLCV (symbol, timeframe, since?, limit?, params?)watchOHLCVForSymbols
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of grvt
Returns: object - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-docs.grvt.io/market_data_streams/#candlestick_1
| Param | Type | Required | Description |
|---|---|---|---|
| symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] |
| 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 |
grvt.watchOHLCVForSymbols (symbolsAndTimeframes, since?, limit?, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of grvt
Returns: object - A dictionary of order book structures indexed by market symbols
See
- https://api-docs.grvt.io/market_data_streams/#orderbook-snap
- https://api-docs.grvt.io/market_data_streams/#orderbook-delta
| 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 |
grvt.watchOrderBook (symbol, limit?, params?)watchOrderBookForSymbols
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of grvt
Returns: object - A dictionary of order book structures indexed by market symbols
See
- https://api-docs.grvt.io/market_data_streams/#orderbook-snap
- https://api-docs.grvt.io/market_data_streams/#orderbook-delta
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified array of symbols |
| limit | int | No | the maximum amount of order book entries to return. |
| params | object | No | extra parameters specific to the exchange API endpoint |
grvt.watchOrderBookForSymbols (symbols, limit?, params?)watchMyTrades
watches information on multiple trades made by the user
Kind: instance method of grvt
Returns: Array<object> - a list of trade structures
See: https://api-docs.grvt.io/trading_streams/#fill
| 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 |
| params.unifiedMargin | boolean | No | use unified margin account |
grvt.watchMyTrades (symbol, since?, limit?, params?)watchPositions
watch all open positions
Kind: instance method of grvt
Returns: Array<object> - a list of position structure
See: https://api-docs.grvt.io/trading_streams/#positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| since | int | No | the earliest time in ms to fetch positions for |
| limit | int | No | the maximum number of positions to retrieve |
| params | object | Yes | extra parameters specific to the exchange API endpoint |
grvt.watchPositions (symbols?, since?, limit?, params)watchOrders
watches information on multiple orders made by the user
Kind: instance method of grvt
Returns: Array<object> - a list of order structures
See: https://api-docs.grvt.io/trading_streams/#order_1-feed-selector
| 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 |
grvt.watchOrders (symbol, since?, limit?, params?)