Stream market updates using HTTP streaming. You will receive a different payload depending on the market event that occurred. Details about each event can be found in the response definition.
Note: In order to stream data, you must first create a streaming session. Upon receiving a sessionid, you will have up to 5 minutes to connect to a streaming endpoint before the session expires.
Header | Required | Values/Example | Default |
---|---|---|---|
Accept | Optional | application/xml, application/json | application/xml |
Authorization | Required | Bearer {token} |
Parameter | Type | Param Type | Required | Values/Example | Default |
---|---|---|---|---|---|
symbols | Form | String | Required | AAPL,VXX190517P00016000 | |
Comma-delimited list of symbols (equity or option) | |||||
sessionid | Form | String | Required | 9D1C7018CFEB6F8ECF8CAA58B33 | |
Session Id retrieved from the create session endpoint | |||||
filter | Form | String | Optional | trade | All payloads. |
Comma-delimited list of types of payloads to retrieve in the stream. trade,quote,summary,timesale,tradex
|
|||||
linebreak | Form | String | Optional | true | false |
Insert a line break after a completed payload | |||||
validOnly | Form | String | Optional | true | true |
Include only ticks that are considered valid by exchanges. | |||||
advancedDetails | Form | String | Optional | true | false |
Include advanced details in timesale payloads |