radar-types
Custom type definitions used by the Radar API and SDK
Enums
Interfaces
RadarToken
Information specific to a single token.
interface RadarToken address: string; symbol: string; name: string; decimals: number; zeroex_official: boolean; active: boolean; createdDate: string; quote: boolean;
RadarMarket
Market information for a base/quote token pair.
interface RadarMarket id: string; // "ZRX-WETH", baseTokenAddress: string; quoteTokenAddress: string; baseTokenDecimals: number; quoteTokenDecimals: number; quoteIncrement: BigNumber; // analogous to the current "precision" displayName: string; // "ZRX/WETH", minOrderSize: BigNumber; // calculated min base token size based on last trade price maxOrderSize: BigNumber; // calculated max base token size based on last trade price lastTradePrice: BigNumber; // last trade price
RadarSignedOrder
ZRX Signed Order with included order state.
interface RadarSignedOrder orderHash: string; type: RadarOrderType; state: RadarOrderState; baseTokenAddress: string; quoteTokenAddress: string; remainingBaseTokenAmount: BigNumber // converted amount remainingQuoteTokenAmount: BigNumber // converted amount price: BigNumber; createdDate: BigNumber; // unix signedOrder: SignedOrder;
RadarLimitOrderRequest
A request for an unsigned order at the specified quantity and price, which can then we signed and POSTed back.
interface RadarLimitOrder type: UserOrderType; quantity: BigNumber; price: BigNumber;
RadarMarketOrderRequest
A request for fillable orders, up to the specified quantity, at the best price.
interface RadarMarketOrder type: UserOrderType; quantity : BigNumber;
RadarMarketOrderResponse
A response with price information and fillable orders at the best price.
interface RadarMarketOrderResponse averagePrice: BigNumber; bestPrice: BigNumber; worstPrice: BigNumber; spread: BigNumber; orders: SignedOrder;
RadarOrderFeeResponse
Fee information for a given market.
interface RadarOrderFeeResponse makerFee: BigNumber; takerFee: BigNumber; feeRecipient: string; gasEstimate?: BigNumber;
RadarTicker
Price, volume, and related information for a given market.
interface RadarTicker transactionHash: string; // last trade tx hash price: BigNumber; // last trade price size: BigNumber; // last trade size (in quote) bid: BigNumber; // best bid ask: BigNumber; // best ask volume: BigNumber; // 24hr volume of market in quote timestamp: BigNumber // last trade time in unix time (seconds)
RadarBook
The orderbook for a given market.
interface RadarBook baseTokenAddress: string; quoteTokenAddress: string; bids: RadarSignedOrder; asks: RadarSignedOrder;
Radar Candle
Open-high-low-close chart data.
interface Ohlc open: BigNumber; high: BigNumber; low: BigNumber; close: BigNumber; interface RadarCandle extends Ohlc startBlock: number; startBlockTimestamp: number; endBlock: number; // the last block included in this candle (inclusive) endBlockTimestamp: number; baseTokenAddress: string; baseTokenVolume: BigNumber; quoteTokenAddress: string; quoteTokenVolume: BigNumber;
Radar Websocket Events
Radar Events utilized by the Websocket Endpoint.
RadarEvent
interface RadarEvent baseTokenAddress: string; quoteTokenAddress: string; order: RadarSignedOrder;
Order Events
interface RadarNewOrder extends RadarEvent interface RadarCancelOrder extends RadarEvent interface RadarRemoveOrder extends RadarEvent reason: string;
WebsocketEvent
interface WebsocketEvent action: WebsocketAction; event: RadarFill | RadarNewOrder | RadarCancelOrder | RadarRemoveOrder;
RadarFill
interface RadarFill extends RadarEvent transactionHash: string; blockNumber: number; maker: string; taker: string; feeRecipient: string; paidMakerFee: BigNumber; // converted paidTakerFee: BigNumber; // converted filledBaseTokenAmount: BigNumber; // converted filledQuoteTokenAmount: BigNumber; // converted orderHash: string; timestamp: number;
Radar Websocket Request Types
Radar Request Types utilized by the Websocket Endpoint.
RadarWebsocketRequest
RadarSubscribeRequest
RadarUnsubscribeRequest
Radar Websocket Response Types
Radar Response Types utilized by the Websocket Endpoint.
RadarWebsocketResponse