Check Replay Session | Tradovate Partner API

Before beginning a Market Replay session, call this endpoint to check that the given timeframe is valid within the scope of the user’s entitlements.

You should use this endpoint from a WebSocket hooked up to the Market Replay URL.

1 const URL = 'wss://replay.tradovateapi.com/v1/websocket'
2 
3 const myMarketReplaySocket = new WebSocket(URL)
4 
5 //simple WebSocket authorization procedure
6 myMarketReplaySocket.onopen = function() {
7     myMarketReplaySocket.send(`authorize\n0\n\n${accessToken}`)
8 })
9 
10 //JSON string for midnight April 30th 2018
11 const startTimestamp = new Date('2018-04-30').toJSON()
12 myMarketReplaySocket.send(`replay/checkreplaysession\n1\n\n${JSON.stringify({startTimestamp})}`)
13 
14 //listen for response
15 myMarketReplaySocket.addEventListener('message', msg => {
16     const datas = JSON.parse(msg.data.slice(1)) //chop off leading 'frame' char
17     //datas looks like this [{s: 200, i: 1, d: { checkStatus: 'OK' } }]
18     if(datas) {
19         datas.forEach(({i, d}) => {
20             if(i && i === 1)  { //id of our sent message is 1, response's `i` field will be 1.
21                 console.log(d) //=> { checkStatus: 'OK' }
22                 //if the status is OK we can send the initializeClock message
23             }
24         })
25     } 
26 }

### Before beginning a Market Replay session, call this endpoint to check that the given timeframe is valid within the scope of the user's entitlements. You should use this endpoint from a WebSocket hooked up to the Market Replay URL. ```js const URL = 'wss://replay.tradovateapi.com/v1/websocket' const myMarketReplaySocket = new WebSocket(URL) //simple WebSocket authorization procedure myMarketReplaySocket.onopen = function() { myMarketReplaySocket.send(`authorize\n0\n\n${accessToken}`) }) //JSON string for midnight April 30th 2018 const startTimestamp = new Date('2018-04-30').toJSON() myMarketReplaySocket.send(`replay/checkreplaysession\n1\n\n${JSON.stringify({startTimestamp})}`) //listen for response myMarketReplaySocket.addEventListener('message', msg => { const datas = JSON.parse(msg.data.slice(1)) //chop off leading 'frame' char //datas looks like this [{s: 200, i: 1, d: { checkStatus: 'OK' } }] if(datas) { datas.forEach(({i, d}) => { if(i && i === 1) { //id of our sent message is 1, response's `i` field will be 1. console.log(d) //=> { checkStatus: 'OK' } //if the status is OK we can send the initializeClock message } }) } } ```

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

startTimestampstringRequiredformat: "date-time"

Response

CheckReplaySessionResponse

checkStatusenum

Ineligible, OK, StartTimestampAdjusted

Allowed values:

startTimestampstring or nullformat: "date-time"

Before beginning a Market Replay session, call this endpoint to check that the given timeframe is valid within the scope of the user’s entitlements.

You should use this endpoint from a WebSocket hooked up to the Market Replay URL.

1 const URL = 'wss://replay.tradovateapi.com/v1/websocket'
2 
3 const myMarketReplaySocket = new WebSocket(URL)
4 
5 //simple WebSocket authorization procedure
6 myMarketReplaySocket.onopen = function() {
7     myMarketReplaySocket.send(`authorize\n0\n\n${accessToken}`)
8 })
9 
10 //JSON string for midnight April 30th 2018
11 const startTimestamp = new Date('2018-04-30').toJSON()
12 myMarketReplaySocket.send(`replay/checkreplaysession\n1\n\n${JSON.stringify({startTimestamp})}`)
13 
14 //listen for response
15 myMarketReplaySocket.addEventListener('message', msg => {
16     const datas = JSON.parse(msg.data.slice(1)) //chop off leading 'frame' char
17     //datas looks like this [{s: 200, i: 1, d: { checkStatus: 'OK' } }]
18     if(datas) {
19         datas.forEach(({i, d}) => {
20             if(i && i === 1)  { //id of our sent message is 1, response's `i` field will be 1.
21                 console.log(d) //=> { checkStatus: 'OK' }
22                 //if the status is OK we can send the initializeClock message
23             }
24         })
25     } 
26 }

1	curl -X POST https://demo.tradovateapi.com/v1/replay/checkreplaysession \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"startTimestamp": "2024-01-15T09:30:00Z"
6	}'

1	const URL = 'wss://replay.tradovateapi.com/v1/websocket'
2
3	const myMarketReplaySocket = new WebSocket(URL)
4
5	//simple WebSocket authorization procedure
6	myMarketReplaySocket.onopen = function() {
7	myMarketReplaySocket.send(`authorize\n0\n\n${accessToken}`)
8	})
9
10	//JSON string for midnight April 30th 2018
11	const startTimestamp = new Date('2018-04-30').toJSON()
12	myMarketReplaySocket.send(`replay/checkreplaysession\n1\n\n${JSON.stringify({startTimestamp})}`)
13
14	//listen for response
15	myMarketReplaySocket.addEventListener('message', msg => {
16	const datas = JSON.parse(msg.data.slice(1)) //chop off leading 'frame' char
17	//datas looks like this [{s: 200, i: 1, d: { checkStatus: 'OK' } }]
18	if(datas) {
19	datas.forEach(({i, d}) => {
20	if(i && i === 1) { //id of our sent message is 1, response's `i` field will be 1.
21	console.log(d) //=> { checkStatus: 'OK' }
22	//if the status is OK we can send the initializeClock message
23	}
24	})
25	}
26	}