> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://partner.ninjatrader.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server.

# Check Replay Session

POST https://live.tradovateapi.com/v1/replay/checkreplaysession
Content-Type: application/json

### 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
            }
        })
    } 
}

```

Reference: https://partner.ninjatrader.com/connect/api/rest-api-endpoints/prices/check-replay-session

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: connect
  version: 1.0.0
paths:
  /replay/checkreplaysession:
    post:
      operationId: check-replay-session
      summary: Check Replay Session
      description: >-
        ### 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
                    }
                })
            } 
        }


        ```
      tags:
        - subpackage_prices
      parameters:
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: CheckReplaySessionResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckReplaySessionResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckReplaySession'
servers:
  - url: https://live.tradovateapi.com/v1
    description: https://live.tradovateapi.com/v1
components:
  schemas:
    CheckReplaySession:
      type: object
      properties:
        startTimestamp:
          type: string
          format: date-time
      required:
        - startTimestamp
      title: CheckReplaySession
    CheckReplaySessionResponseCheckStatus:
      type: string
      enum:
        - Ineligible
        - OK
        - StartTimestampAdjusted
      description: Ineligible, OK, StartTimestampAdjusted
      title: CheckReplaySessionResponseCheckStatus
    CheckReplaySessionResponse:
      type: object
      properties:
        checkStatus:
          $ref: '#/components/schemas/CheckReplaySessionResponseCheckStatus'
          description: Ineligible, OK, StartTimestampAdjusted
        startTimestamp:
          type: string
          format: date-time
      required:
        - checkStatus
      title: CheckReplaySessionResponse
  securitySchemes:
    bearer_access_token:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{
  "startTimestamp": "2024-01-15T09:30:00Z"
}
```

**Response**

```json
{
  "checkStatus": "Ineligible",
  "startTimestamp": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://live.tradovateapi.com/v1/replay/checkreplaysession"

payload = { "startTimestamp": "2024-01-15T09:30:00Z" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://live.tradovateapi.com/v1/replay/checkreplaysession';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"startTimestamp":"2024-01-15T09:30:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://live.tradovateapi.com/v1/replay/checkreplaysession"

	payload := strings.NewReader("{\n  \"startTimestamp\": \"2024-01-15T09:30:00Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://live.tradovateapi.com/v1/replay/checkreplaysession")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startTimestamp\": \"2024-01-15T09:30:00Z\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://live.tradovateapi.com/v1/replay/checkreplaysession")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startTimestamp\": \"2024-01-15T09:30:00Z\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://live.tradovateapi.com/v1/replay/checkreplaysession', [
  'body' => '{
  "startTimestamp": "2024-01-15T09:30:00Z"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://live.tradovateapi.com/v1/replay/checkreplaysession");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"startTimestamp\": \"2024-01-15T09:30:00Z\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["startTimestamp": "2024-01-15T09:30:00Z"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/replay/checkreplaysession")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```