API Documentation


Market

Examples | Type Definition

Metadata regarding a single trading pair on an exchange. A market is accessed via the intersection of an exchangeSymbol, baseSymbol, and quoteSymbol. A shorthand marketSymbol can be used instead in the format exchangeSymbol:baseSymbol/quoteSymbol. If a marketSymbol is provided, all three must be present.

A single market holds market metadata and several useful sub-objects.

Examples

Binance:BTC/USDT with ticker

query market {
  market(marketSymbol: "binance:btc/usdt") {
    marketSymbol
    ticker {
      percentChange
      lastPrice
      lowPrice
      highPrice
      baseVolume
      quoteVolume
    }
  }
}

Binance:BTC/USDT with last 30 days OHLCV

query market {
  market(marketSymbol: "binance:btc/usdt") {
    marketSymbol
    ohlcv(resolution: _1d, limit: 30)
  }
}

Type Definitions

OBJECT: Market #

Market where an asset is traded against a quote asset
FieldTypeDescription
idUnique identifier for the market
marketTypeMarketTypeType of market
marketStatusMarketStatusStatus of market
marketSymbolStringUnique symbol identifying the market in the format {exchange_symbol}:{base_symbol}/{quote_symbol}
baseSymbolStringBase asset symbol
quoteSymbolStringQuote asset symbol
exchangeSymbolStringExchange symbol
remoteIdStringRemote identifier on the exchange
openedOnInt
openedOnDateString
firstUnixIntThe unix timestamp of the first market data
firstDateStringThe unix timestamp of the first market data as an ISO 8601 formatted string
lastUnixIntThe unix timestamp of the last market update
lastDateStringthe unix timestamp of the last market update as an ISO 8601 formatted string
tickerTickerCurrent market statistics
ohlcvOHLCVCompressed OHLCV for the market. By default returns the newest candles.
Inputs
Input NameInput TypeInput Description
resolutionTimeResolutionREQUIRED - Size of the time bucket
limitIntNumber of records to return. Can be combined with start to retain the tail.
startIntUnix timestamp to start the time series. Can be combined with limit or end, but not both.
startDateStringStarting date and time in ISO 8601 format
endIntUnix timestamp to end the time series. Must be combined with
endDateStringEnding date and time in ISO 8601 format
sortTimeSortSort direction as NEW_FIRST or OLD_FIRST

OBJECT: Ticker #

Market statistics generated by the lasted market ticks
FieldTypeDescription
percentChangeStringPercent change in 24 hours
lastPriceStringLast price
lowPriceStringLowest price in the past 24 hours
highPriceStringHighest price in the past 24 hours
baseVolumeStringBase asset volume traded in past 24 hours
quoteVolumeStringQuote asset volume traded in past 24 hours

Filter and Sort Definitions

INPUT_OBJECT: MarketFilter #

Filter markets for an asset
FieldTypeDescription
_and[MarketFilter]And operator
_or[MarketFilter]Or operator
idStringFilterid filters
marketSymbolStringFiltermarketSymbol filters
marketTypeMarketTypeFiltermarketType filters
marketStatusMarketStatusFiltermarketStatus filters
exchangeSymbolStringFilterexchangeSymbol filters
baseSymbolStringFilterbaseSymbol filters
quoteSymbolStringFilterquoteSymbol filters
openedOnIntFilter
firstUnixIntFilterfirstUnix filter
lastUnixIntFilterlastUnix filter
baseAssetAssetFilterFilter by base asset
quoteAssetAssetFilterFilter by quote asset
exchangeExchangeFilterFilter by exchange