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](/#tag/WebSockets) for more details, or view our WebSockets [JavaScript](https://github.com/tradovate/example-api-js) or [C#](https://github.com/tradovate/example-api-csharp-trading) tutorials. ```js 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. ```

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
userslist of longsOptional
accountslist of longsOptional
splitResponsesbooleanOptional
cutoffTimestampdatetimeOptional
entityTypeslist of stringsOptional
shardingExpressionobjectOptional
fullOrgSnapshotbooleanOptional

Response

SyncMessage
userslist of objects
contractGroupslist of objects
userPropertieslist of objectsOptional
propertieslist of objectsOptional
accountslist of objectsOptional
accountRiskStatuseslist of objectsOptional
marginSnapshotslist of objectsOptional
userAccountAutoLiqslist of objectsOptional
cashBalanceslist of objectsOptional
currencieslist of objectsOptional
positionslist of objectsOptional
fillPairslist of objectsOptional
orderslist of objectsOptional
contractslist of objectsOptional
contractMaturitieslist of objectsOptional
productslist of objectsOptional
exchangeslist of objectsOptional
spreadDefinitionslist of objectsOptional
commandslist of objectsOptional
commandReportslist of objectsOptional
executionReportslist of objectsOptional
orderVersionslist of objectsOptional
fillslist of objectsOptional
fillFeeslist of objectsOptional
orderStrategieslist of objectsOptional
userPluginslist of objectsOptional
annualReviewslist of objectsOptional
userReadStatuseslist of objectsOptional
userPromoCodeslist of objectsOptional
orderStrategyTypeslist of objectsOptional