React HookuseOrderbookStream
useOrderbookStream(symbol, initial, options?):{
allDepths:undefined,
asks:OrderBookItem[],
bids:OrderBookItem[],
depth:undefined,
isLoading:undefined,
markPrice:any,
middlePrice:number[],
onDepthChange:undefined,
onItemClick:undefined
}|{
allDepths:any[],
asks:undefined,
bids:undefined,
depth:undefined|number,
isLoading:boolean,
markPrice:undefined,
middlePrice:undefined,
onDepthChange:(depth)=>void,
onItemClick:(item)=>void
}[]
allDepths:undefined,
asks:OrderBookItem[],
bids:OrderBookItem[],
depth:undefined,
isLoading:undefined,
markPrice:any,
middlePrice:number[],
onDepthChange:undefined,
onItemClick:undefined
}|{
allDepths:any[],
asks:undefined,
bids:undefined,
depth:undefined|number,
isLoading:boolean,
markPrice:undefined,
middlePrice:undefined,
onDepthChange:(depth)=>void,
onItemClick:(item)=>void
}[]
Parameters
- symbol:string
- initial:OrderbookData
- Optionaloptions:OrderbookOptions
Returns
{allDepths:undefined,
asks:OrderBookItem[],
bids:OrderBookItem[],
depth:undefined,
isLoading:undefined,
markPrice:any,
middlePrice:number[],
onDepthChange:undefined,
onItemClick:undefined
}|{
allDepths:any[],
asks:undefined,
bids:undefined,
depth:undefined|number,
isLoading:boolean,
markPrice:undefined,
middlePrice:undefined,
onDepthChange:(depth)=>void,
onItemClick:(item)=>void
}[]