Skip to main content

UseOrderBookReturn

Stock Screening Platform - Frontend API v0.1.0

Stock Screening Platform - Frontend API / hooks/useOrderBook / UseOrderBookReturn

Interface: UseOrderBookReturn

Defined in: src/hooks/useOrderBook.ts:20

Order book hook return type

Properties​

orderBook​

orderBook: OrderBookData | null

Defined in: src/hooks/useOrderBook.ts:22

Current order book data

imbalance​

imbalance: OrderImbalance | null

Defined in: src/hooks/useOrderBook.ts:24

Order imbalance indicator

connectionState​

connectionState: WSConnectionState

Defined in: src/hooks/useOrderBook.ts:26

WebSocket connection state

isLoading​

isLoading: boolean

Defined in: src/hooks/useOrderBook.ts:28

Loading state

error​

error: string | null

Defined in: src/hooks/useOrderBook.ts:30

Error state

refresh()​

refresh: () => void

Defined in: src/hooks/useOrderBook.ts:32

Manually refresh order book

Returns​

void

frozen​

frozen: boolean

Defined in: src/hooks/useOrderBook.ts:34

Freeze/unfreeze updates

toggleFreeze()​

toggleFreeze: () => void

Defined in: src/hooks/useOrderBook.ts:36

Toggle freeze state

Returns​

void