Stock quotes

NOTE: This is the documentation for the websocket channels quotes and quotes:<TICKER>. Websocket access for personal use is only available through the Advanced plan. You can find fully-functional examples that stream data from many channels here:

Connect to the websocket URI: wss://api.unusualwhales.com/socket?token=<YOUR_API_TOKEN> then join the channel you wish to stream, for example quotes:AAPL for the live best bid and ask on AAPL. Join quotes for every ticker at once, or quotes:AAPL for one. This is the live counterpart of /stock/:ticker/quote, which returns the same values on the same scale, nested under bid and ask objects rather than flat. Use it to fetch the current book when you subscribe: the channel sends nothing until the ticker’s next quote. Payload format:

[
  "quotes:AAPL",
  {
    "ticker": "AAPL",
    "bid": "229.955",
    "bid_size": 300,
    "ask": "229.965",
    "ask_size": 100
  }
]

Field reference

Field	Type	Description
`ticker`	string	Underlying ticker. Same as the `:` suffix on the channel name.
`bid`	decimal string	Best bid price in dollars.
`bid_size`	int	Number of shares displayed at the best bid.
`ask`	decimal string	Best ask price in dollars.
`ask_size`	int	Number of shares displayed at the best ask.

Overview

Channels

Field reference

​Field reference

Field reference