REST API EndpointsUsers

Sync Request

### Used with WebSocket protocol. Returns all data associated with the user. This endpoint is essential for efficient use of the WebSocket API. ```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

Response

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