Users

Sync Request

Used with WebSocket protocol. Returns all data associated with the user.

This endpoint is essential for efficient use of the WebSocket API. See WebSockets for more details, or view our WebSockets JavaScript or C# tutorials.

const URL = 'wss://live.tradovateapi.com/v1/websocket'

const myWebSocket = new WebSocket(URL)

//authorize websocket with your access token
myWebSocket.onopen = function() {
    myWebSocket.send(`authorize\n0\n\n${accessToken}`)
}

const requestBody = {
    users: [12345]
}

myWebSocket.send(`user/syncrequest\n1\n\n${JSON.stringify(requestBody)}`) 

//starts a subscription to real-time user data.
post/user/syncrequest

Request

  • Base URL: https://demo.tradovateapi.com/v1
  • URL: https://demo.tradovateapi.com/v1/user/syncrequest
  • Auth: HTTP bearer

Request body

usersinteger[]
accountsinteger[]
splitResponsesboolean
cutoffTimestampstring date-time
entityTypesstring[]
fullOrgSnapshotboolean

Response

SyncMessage

Changes

No recorded changes to this operation across all 1 revision of this API.