Websocket API Documentation


OVERVIEW
This websocket returns changes in prices of stocks you subscribe to. You need Professional or Enterprise plan to use it. You can change you plan here.

Login: { "event": "login", "data": { "apiKey": "your_api_key" } }
Subscribe: { "event": "subscribe", "data": { "ticker": "aapl" } }

Response:
s: Ticker related to the asset.
t: Timestamp
type: Trade type (Communicates what type of price update this is. Will always be "T" for last trade message, "Q" for top-of-book update message, and "B" for trade break messages.)
ap: The current lowest ask price. Only available for Quote updates, null otherwise.
as: The number of shares at the ask price. Only available for Quote updates, null otherwise.
bp: The number shares at the bid price. Only available for Quote updates, null otherwise.
bs: The current highest bid price. Only available for Quote updates, null otherwise.
lp: The last price the last trade was executed at. Only available for Trade and Break updates, null otherwise.
ls: The amount of shares (volume) traded at the last price. Only available for Trade and Break updates, null otherwise.

Unsubscribe: { "event": "unsubscribe", "data": { "ticker": "aapl" } }

To get price of stocks you can also use our Stock Quote endpoint that is available for all plans.

Websocket API Documentation


OVERVIEW
This websocket returns changes in prices of stocks you subscribe to. You need Professional or Enterprise plan to use it. You can change you plan here.

Login: { "event": "login", "data": { "apiKey": "your_api_key" } }
Subscribe: { "event": "subscribe", "data": { "ticker": "aapl" } }

Response:
s: Ticker related to the asset.
t: Timestamp
type: Trade type (Communicates what type of price update this is. Will always be "T" for last trade message, "Q" for top-of-book update message, and "B" for trade break messages.)
ap: The current lowest ask price. Only available for Quote updates, null otherwise.
as: The number of shares at the ask price. Only available for Quote updates, null otherwise.
bp: The number shares at the bid price. Only available for Quote updates, null otherwise.
bs: The current highest bid price. Only available for Quote updates, null otherwise.
lp: The last price the last trade was executed at. Only available for Trade and Break updates, null otherwise.
ls: The amount of shares (volume) traded at the last price. Only available for Trade and Break updates, null otherwise.

Unsubscribe: { "event": "unsubscribe", "data": { "ticker": "aapl" } }

To get price of stocks you can also use our Stock Quote endpoint that is available for all plans.

Websocket

      Resource List :