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
accountslist of objects
accountRiskStatuseslist of objects
marginSnapshotslist of objects
userAccountAutoLiqslist of objects
cashBalanceslist of objects
currencieslist of objects
positionslist of objects
fillPairslist of objects
orderslist of objects
contractslist of objects
contractMaturitieslist of objects
productslist of objects
exchangeslist of objects
spreadDefinitionslist of objects
commandslist of objects
commandReportslist of objects
executionReportslist of objects
orderVersionslist of objects
fillslist of objects
fillFeeslist of objects
orderStrategieslist of objects
userPropertieslist of objects
propertieslist of objects
userPluginslist of objects
annualReviewslist of objects
userReadStatuseslist of objects
userPromoCodeslist of objects
orderStrategyTypeslist of objects