Sync Request

POST

https://live.tradovateapi.com/v1/user/syncrequest

POST

/v1/user/syncrequest

curl -X POST https://live.tradovateapi.com/v1/user/syncrequest \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Successful

{
  "users": [
    {
      "name": "string",
      "timestamp": "2024-01-15T09:30:00Z",
      "email": "string",
      "status": "Active",
      "professional": true,
      "id": 1,
      "organizationId": 1,
      "introducingPartnerId": 1
    }
  ],
  "contractGroups": [
    {
      "name": "string",
      "id": 1
    }
  ],
  "userProperties": [
    {
      "userId": 1,
      "propertyId": 1,
      "id": 1,
      "value": "string"
    }
  ],
  "properties": [
    {
      "name": "string",
      "propertyType": "Boolean",
      "id": 1,
      "enumOptions": "string",
      "defaultValue": "string"
    }
  ],
  "accounts": [
    {
      "name": "string",
      "userId": 1,
      "accountType": "Customer",
      "clearingHouseId": 1,
      "riskCategoryId": 1,
      "autoLiqProfileId": 1,
      "marginAccountType": "Hedger",
      "legalStatus": "Corporation",
      "timestamp": "2024-01-15T09:30:00Z",
      "id": 1,
      "restricted": true,
      "closed": true,
      "evaluationSize": 1.1,
      "readonly": true,
      "ccEmail": "string",
      "futuresDisabled": true,
      "swapEnabled": true,
      "ssfRiskDisclosureAcknowledgment": "2024-01-15T09:30:00Z",
      "spotMarginEnabled": true,
      "active": true
    }
  ],
  "accountRiskStatuses": [
    {
      "id": 1,
      "adminAction": "AgreedOnLiqOnlyModeByAutoLiq",
      "adminTimestamp": "2024-01-15T09:30:00Z",
      "liquidateOnly": "2024-01-15T09:30:00Z",
      "userTriggeredLiqOnly": true,
      "maxNetLiq": 1.1,
      "minNetLiq": 1.1
    }
  ],
  "marginSnapshots": [
    {
      "timestamp": "2024-01-15T09:30:00Z",
      "riskTimePeriodId": 1,
      "initialMargin": 1.1,
      "maintenanceMargin": 1.1,
      "totalUsedMargin": 1.1,
      "fullInitialMargin": 1.1,
      "positionMargin": 1.1,
      "totalUsedFullMargin": 1.1,
      "id": 1,
      "autoLiqLevel": 1.1,
      "liqOnlyLevel": 1.1,
      "openCollateralReq": 1.1
    }
  ],
  "userAccountAutoLiqs": [
    {
      "id": 1,
      "changesLocked": true,
      "marginPercentageAlert": 1.1,
      "dailyLossPercentageAlert": 1.1,
      "dailyLossAlert": 1.1,
      "marginPercentageLiqOnly": 1.1,
      "dailyLossPercentageLiqOnly": 1.1,
      "dailyLossLiqOnly": 1.1,
      "marginPercentageAutoLiq": 1.1,
      "dailyLossPercentageAutoLiq": 1.1,
      "dailyLossAutoLiq": 1.1,
      "weeklyLossAutoLiq": 1.1,
      "flattenTimestamp": "2024-01-15T09:30:00Z",
      "trailingMaxDrawdown": 1.1,
      "trailingMaxDrawdownLimit": 1.1,
      "trailingMaxDrawdownMode": "EOD",
      "dailyProfitAutoLiq": 1.1,
      "weeklyProfitAutoLiq": 1.1,
      "doNotUnlock": true,
      "steppedCooldown": {
        "steps": [
          {
            "stepNumber": 1,
            "stepDistance": 1.1,
            "cooldownMinutes": 1
          }
        ],
        "terminalStep": {
          "stepNumber": 1,
          "stepDistance": 1.1
        }
      },
      "steppedUnlimited": true,
      "fixedKillFloor": 1.1
    }
  ],
  "cashBalances": [
    {
      "accountId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "tradeDate": {
        "year": 1,
        "month": 1,
        "day": 1
      },
      "currencyId": 1,
      "amount": 1.1,
      "id": 1,
      "realizedPnL": 1.1,
      "weekRealizedPnL": 1.1,
      "amountSOD": 1.1
    }
  ],
  "currencies": [
    {
      "name": "string",
      "id": 1,
      "symbol": "string"
    }
  ],
  "positions": [
    {
      "accountId": 1,
      "contractId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "tradeDate": {
        "year": 1,
        "month": 1,
        "day": 1
      },
      "netPos": 1,
      "bought": 1,
      "boughtValue": 1.1,
      "sold": 1,
      "soldValue": 1.1,
      "prevPos": 1,
      "id": 1,
      "netPrice": 1.1,
      "prevPrice": 1.1,
      "settlementStatus": "PendingSettlement",
      "pendingSince": "2024-01-15T09:30:00Z",
      "settlementFallbackPrice": 1.1
    }
  ],
  "fillPairs": [
    {
      "positionId": 1,
      "buyFillId": 1,
      "sellFillId": 1,
      "qty": 1,
      "buyPrice": 1.1,
      "sellPrice": 1.1,
      "active": true,
      "id": 1
    }
  ],
  "orders": [
    {
      "accountId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "action": "Buy",
      "ordStatus": "Canceled",
      "admin": true,
      "id": 1,
      "contractId": 1,
      "spreadDefinitionId": 1,
      "executionProviderId": 1,
      "ocoId": 1,
      "parentId": 1,
      "linkedId": 1,
      "clOrdId": "string"
    }
  ],
  "contracts": [
    {
      "name": "string",
      "contractMaturityId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "id": 1
    }
  ],
  "contractMaturities": [
    {
      "productId": 1,
      "expirationMonth": 1,
      "expirationDate": "2024-01-15T09:30:00Z",
      "isFront": true,
      "id": 1,
      "firstIntentDate": "2024-01-15T09:30:00Z",
      "underlyingId": 1,
      "kalshiEventId": 1
    }
  ],
  "products": [
    {
      "name": "string",
      "currencyId": 1,
      "productType": "CommonStock",
      "description": "string",
      "exchangeId": 1,
      "contractGroupId": 1,
      "status": "Inactive",
      "valuePerPoint": 1.1,
      "priceFormatType": "Decimal",
      "priceFormat": 1,
      "tickSize": 1.1,
      "id": 1,
      "riskDiscountContractGroupId": 1,
      "months": "string",
      "isSecured": true,
      "postTradeCategoryId": 1
    }
  ],
  "exchanges": [
    {
      "name": "string",
      "id": 1,
      "micCode": "string"
    }
  ],
  "spreadDefinitions": [
    {
      "timestamp": "2024-01-15T09:30:00Z",
      "spreadType": "Bundle",
      "uds": true,
      "id": 1
    }
  ],
  "commands": [
    {
      "orderId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "commandType": "Cancel",
      "commandStatus": "AtExecution",
      "id": 1,
      "clOrdId": "string",
      "senderId": 1,
      "userSessionId": 1,
      "activationTime": "2024-01-15T09:30:00Z",
      "customTag50": "string",
      "isAutomated": true
    }
  ],
  "commandReports": [
    {
      "commandId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "commandStatus": "AtExecution",
      "id": 1,
      "rejectReason": "AccountClosed",
      "text": "string",
      "ordStatus": "Canceled"
    }
  ],
  "executionReports": [
    {
      "commandId": 1,
      "name": "string",
      "accountId": 1,
      "contractId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "orderId": 1,
      "execType": "Canceled",
      "action": "Buy",
      "id": 1,
      "tradeDate": {
        "year": 1,
        "month": 1,
        "day": 1
      },
      "execRefId": "string",
      "ordStatus": "Canceled",
      "cumQty": 1,
      "avgPx": 1.1,
      "lastQty": 1,
      "lastPx": 1.1,
      "rejectReason": "AccountClosed",
      "text": "string",
      "exchangeOrderId": "string"
    }
  ],
  "orderVersions": [
    {
      "orderId": 1,
      "orderQty": 1,
      "orderType": "Limit",
      "id": 1,
      "price": 1.1,
      "stopPrice": 1.1,
      "limitIfTouchedPrice": 1.1,
      "maxShow": 1,
      "pegDifference": 1.1,
      "timeInForce": "Day",
      "expireTime": "2024-01-15T09:30:00Z",
      "text": "string"
    }
  ],
  "fills": [
    {
      "orderId": 1,
      "contractId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "tradeDate": {
        "year": 1,
        "month": 1,
        "day": 1
      },
      "action": "Buy",
      "qty": 1,
      "price": 1.1,
      "active": true,
      "finallyPaired": 1,
      "id": 1
    }
  ],
  "fillFees": [
    {
      "id": 1,
      "clearingFee": 1.1,
      "clearingCurrencyId": 1,
      "exchangeFee": 1.1,
      "exchangeCurrencyId": 1,
      "nfaFee": 1.1,
      "nfaCurrencyId": 1,
      "brokerageFee": 1.1,
      "brokerageCurrencyId": 1,
      "ipFee": 1.1,
      "ipCurrencyId": 1,
      "commission": 1.1,
      "commissionCurrencyId": 1,
      "orderRoutingFee": 1.1,
      "orderRoutingCurrencyId": 1
    }
  ],
  "userAccountPositionExits": [
    {
      "accountId": 1,
      "contractId": 1,
      "id": 1,
      "flattenTimestamp": "2024-01-15T09:30:00Z",
      "repeatInterval": 1
    }
  ],
  "rfqs": [
    {
      "accountId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "quoteReqId": "string",
      "status": "AcceptQuoteAccepted",
      "id": 1,
      "exchangeRfqId": "string",
      "marketTicker": "string",
      "collectionTicker": "string",
      "legs": "string",
      "contractId": 1,
      "orderQty": 1,
      "cashOrderQty": 1.1,
      "replaceExisting": true,
      "autoAcceptAction": "Buy",
      "autoAcceptReferencePrice": 1.1,
      "autoAcceptThresholdDollars": 1.1,
      "autoAcceptOrderQty": 1,
      "autoAcceptPreferBetterQuote": true,
      "cancelRequestedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "rfqEvents": [
    {
      "rfqId": 1,
      "accountId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "eventType": "AcceptQuoteAccepted",
      "id": 1,
      "quoteId": "string",
      "requestedQuoteId": "string",
      "quoterId": "string",
      "bidPx": 1.1,
      "bidSize": 1,
      "offerPx": 1.1,
      "offerSize": 1,
      "orderId": 1,
      "preferBetterQuote": true,
      "reason": "string"
    }
  ],
  "orderStrategies": [
    {
      "accountId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "contractId": 1,
      "orderStrategyTypeId": 1,
      "action": "Buy",
      "status": "ActiveStrategy",
      "id": 1,
      "initiatorId": 1,
      "params": "string",
      "uuid": "string",
      "failureMessage": "string",
      "senderId": 1,
      "customTag50": "string",
      "userSessionId": 1
    }
  ],
  "orderStrategyLinks": [
    {
      "orderStrategyId": 1,
      "orderId": 1,
      "label": "string",
      "id": 1
    }
  ],
  "userPlugins": [
    {
      "userId": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "planPrice": 1.1,
      "pluginName": "string",
      "approval": true,
      "startDate": {
        "year": 1,
        "month": 1,
        "day": 1
      },
      "paidAmount": 1.1,
      "id": 1,
      "cashBalanceLogId": 1,
      "accountId": 1,
      "entitlementId": 1,
      "expirationDate": {
        "year": 1,
        "month": 1,
        "day": 1
      },
      "autorenewal": true,
      "planCategories": "string",
      "rebate": 1.1
    }
  ],
  "annualReviews": [
    {
      "userId": 1,
      "riskDisclosureNeeded": true,
      "archived": true,
      "status": "Closed",
      "id": 1,
      "firstEmail": "string",
      "secondEmail": "string",
      "jointFirstEmail": "string",
      "jointSecondEmail": "string",
      "firstEmailSent": "2024-01-15T09:30:00Z",
      "secondEmailSent": "2024-01-15T09:30:00Z",
      "finished": "2024-01-15T09:30:00Z",
      "jointFinished": "2024-01-15T09:30:00Z",
      "identityCheckResult": "Fail",
      "jointIdentityCheckResult": "Fail",
      "contactInfoId": 1
    }
  ],
  "userReadStatuses": [
    {
      "id": 1,
      "newsStoryId": 1
    }
  ],
  "userPromoCodes": [
    {
      "userId": 1,
      "promoCodeId": 1,
      "source": "Admin",
      "id": 1,
      "accountId": 1,
      "comments": "string"
    }
  ],
  "orderStrategyTypes": [
    {
      "name": "string",
      "enabled": true,
      "id": 1
    }
  ]
}

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.

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

userAccountPositionExitslist of objectsOptional

rfqslist of objectsOptional

rfqEventslist of objectsOptional

orderStrategieslist of objectsOptional

orderStrategyLinkslist of objectsOptional

userPluginslist of objectsOptional

annualReviewslist of objectsOptional

userReadStatuseslist of objectsOptional

userPromoCodeslist of objectsOptional

orderStrategyTypeslist of objectsOptional