> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://partner.ninjatrader.com/eval/api/rest-api-endpoints/users/sync-request/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server.

# Sync Request

POST https://live.tradovateapi.com/v1/user/syncrequest
Content-Type: application/json

### 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.
```

Reference: https://partner.ninjatrader.com/eval/api/rest-api-endpoints/users/sync-request

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a SyncRequest.

- `users` (list of long, optional)
- `accounts` (list of long, optional)
- `splitResponses` (boolean, optional)
- `cutoffTimestamp` (datetime, optional)
- `entityTypes` (list of string, optional)
- `shardingExpression` (ShardingExpression, optional)
- `fullOrgSnapshot` (boolean, optional)

## Response

### 200

SyncMessage

- `users` (list of User, required)
- `contractGroups` (list of ContractGroup, required)
- `userProperties` (list of UserProperty, optional)
- `properties` (list of Property, optional)
- `accounts` (list of Account, optional)
- `accountRiskStatuses` (list of AccountRiskStatus, optional)
- `marginSnapshots` (list of MarginSnapshot, optional)
- `userAccountAutoLiqs` (list of UserAccountAutoLiq, optional)
- `cashBalances` (list of CashBalance, optional)
- `currencies` (list of Currency, optional)
- `positions` (list of Position, optional)
- `fillPairs` (list of FillPair, optional)
- `orders` (list of Order, optional)
- `contracts` (list of Contract, optional)
- `contractMaturities` (list of ContractMaturity, optional)
- `products` (list of Product, optional)
- `exchanges` (list of Exchange, optional)
- `spreadDefinitions` (list of SpreadDefinition, optional)
- `commands` (list of Command, optional)
- `commandReports` (list of CommandReport, optional)
- `executionReports` (list of ExecutionReport, optional)
- `orderVersions` (list of OrderVersion, optional)
- `fills` (list of Fill, optional)
- `fillFees` (list of FillFee, optional)
- `userAccountPositionExits` (list of UserAccountPositionExit, optional)
- `rfqs` (list of Rfq, optional)
- `rfqEvents` (list of RfqEvent, optional)
- `orderStrategies` (list of OrderStrategy, optional)
- `orderStrategyLinks` (list of OrderStrategyLink, optional)
- `userPlugins` (list of UserPlugin, optional)
- `annualReviews` (list of AnnualReview, optional)
- `userReadStatuses` (list of UserReadStatus, optional)
- `userPromoCodes` (list of UserPromoCode, optional)
- `orderStrategyTypes` (list of OrderStrategyType, optional)

## Types

### ShardingExpression

- `expressionType` (string, required)
- `divisor` (integer, required)
- `remainder` (integer, required)

### User

- `name` (string, required)
- `timestamp` (datetime, required)
- `email` (string, required)
- `status` (enum, required) — Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail
  - Allowed values: `Active`, `Closed`, `Initiated`, `TemporaryLocked`, `UnconfirmedEmail`
- `professional` (boolean, required)
- `id` (long, optional)
- `organizationId` (long, optional)
- `introducingPartnerId` (long, optional)

### ContractGroup

- `name` (string, required)
- `id` (long, optional)

### UserProperty

- `userId` (long, required)
- `propertyId` (long, required)
- `id` (long, optional)
- `value` (string, optional)

### Property

- `name` (string, required)
- `propertyType` (enum, required) — Boolean, Enum, Integer, String
  - Allowed values: `Boolean`, `Enum`, `Integer`, `String`
- `id` (long, optional)
- `enumOptions` (string, optional)
- `defaultValue` (string, optional)

### Account

- `name` (string, required)
- `userId` (long, required)
- `accountType` (enum, required) — Customer, Employee, Giveup, House, Omnibus, Wash
  - Allowed values: `Customer`, `Employee`, `Giveup`, `House`, `Omnibus`, `Wash`
- `clearingHouseId` (long, required)
- `riskCategoryId` (long, required)
- `autoLiqProfileId` (long, required)
- `marginAccountType` (enum, required) — Hedger, Speculator
  - Allowed values: `Hedger`, `Speculator`
- `legalStatus` (enum, required) — Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust
  - Allowed values: `Corporation`, `GP`, `IRA`, `Individual`, `Joint`, `LLC`, `LLP`, `LP`, `PTR`, `Trust`
- `timestamp` (datetime, required)
- `id` (long, optional)
- `restricted` (boolean, optional)
- `closed` (boolean, optional)
- `evaluationSize` (double, optional)
- `readonly` (boolean, optional)
- `ccEmail` (string, optional)
- `futuresDisabled` (boolean, optional)
- `swapEnabled` (boolean, optional)
- `ssfRiskDisclosureAcknowledgment` (datetime, optional)
- `spotMarginEnabled` (boolean, optional)
- `active` (boolean, optional)

### AccountRiskStatus

- `id` (long, optional)
- `adminAction` (enum, optional) — AgreedOnLiqOnlyModeByAutoLiq, AgreedOnLiquidationByAutoLiq, DisableAutoLiq, LiquidateImmediately, LiquidateOnlyModeImmediately, LockTradingImmediately, Normal, PlaceAutoLiqOnHold
  - Allowed values: `AgreedOnLiqOnlyModeByAutoLiq`, `AgreedOnLiquidationByAutoLiq`, `DisableAutoLiq`, `LiquidateImmediately`, `LiquidateOnlyModeImmediately`, `LockTradingImmediately`, `Normal`, `PlaceAutoLiqOnHold`
- `adminTimestamp` (datetime, optional)
- `liquidateOnly` (datetime, optional)
- `userTriggeredLiqOnly` (boolean, optional)
- `maxNetLiq` (double, optional) — $ Max Net Liq
- `minNetLiq` (double, optional) — $ Min Net Liq

### MarginSnapshot

- `timestamp` (datetime, required)
- `riskTimePeriodId` (long, required)
- `initialMargin` (double, required)
- `maintenanceMargin` (double, required)
- `totalUsedMargin` (double, required)
- `fullInitialMargin` (double, required)
- `positionMargin` (double, required)
- `totalUsedFullMargin` (double, required)
- `id` (long, optional)
- `autoLiqLevel` (double, optional)
- `liqOnlyLevel` (double, optional)
- `openCollateralReq` (double, optional)

### UserAccountAutoLiq

- `id` (long, optional)
- `changesLocked` (boolean, optional) — Changes Locked
- `marginPercentageAlert` (double, optional) — Margin % for an Alert
- `dailyLossPercentageAlert` (double, optional) — Daily Loss % for an Alert
- `dailyLossAlert` (double, optional) — $ Daily Loss for an Alert
- `marginPercentageLiqOnly` (double, optional) — Margin % for an Liq Only
- `dailyLossPercentageLiqOnly` (double, optional) — Daily Loss % for an Liq Only
- `dailyLossLiqOnly` (double, optional) — $ Daily Loss for an Liq Only
- `marginPercentageAutoLiq` (double, optional) — Margin % for an Auto-Liq
- `dailyLossPercentageAutoLiq` (double, optional) — Daily Loss % for an AutoLiq
- `dailyLossAutoLiq` (double, optional) — $ Daily Loss for an Auto-Liq
- `weeklyLossAutoLiq` (double, optional) — $ Weekly Loss for an Auto-Liq
- `flattenTimestamp` (datetime, optional) — Flatten &amp; Cancel
- `trailingMaxDrawdown` (double, optional) — $ Trailing Max Drawdown
- `trailingMaxDrawdownLimit` (double, optional) — $ Trailing Max Drawdown Limit
- `trailingMaxDrawdownMode` (enum, optional) — EOD, RealTime, SteppedEOD, SteppedRealTime
  - Allowed values: `EOD`, `RealTime`, `SteppedEOD`, `SteppedRealTime`
- `dailyProfitAutoLiq` (double, optional) — $ Daily Profit for an Auto-Liq
- `weeklyProfitAutoLiq` (double, optional) — $ Weekly Profit for an Auto-Liq
- `doNotUnlock` (boolean, optional) — Do not automatically unlock account if triggered
- `steppedCooldown` (SteppedCooldownConfig, optional)
- `steppedUnlimited` (boolean, optional)
- `fixedKillFloor` (double, optional)

### CashBalance

- `accountId` (long, required)
- `timestamp` (datetime, required)
- `tradeDate` (TradeDate, required)
- `currencyId` (long, required)
- `amount` (double, required)
- `id` (long, optional)
- `realizedPnL` (double, optional)
- `weekRealizedPnL` (double, optional)
- `amountSOD` (double, optional)

### Currency

- `name` (string, required)
- `id` (long, optional)
- `symbol` (string, optional)

### Position

- `accountId` (long, required)
- `contractId` (long, required)
- `timestamp` (datetime, required)
- `tradeDate` (TradeDate, required)
- `netPos` (integer, required)
- `bought` (integer, required)
- `boughtValue` (double, required)
- `sold` (integer, required)
- `soldValue` (double, required)
- `prevPos` (integer, required)
- `id` (long, optional)
- `netPrice` (double, optional)
- `prevPrice` (double, optional)
- `settlementStatus` (enum, optional) — PendingSettlement, SettlementBooked
  - Allowed values: `PendingSettlement`, `SettlementBooked`
- `pendingSince` (datetime, optional)
- `settlementFallbackPrice` (double, optional)

### FillPair

- `positionId` (long, required)
- `buyFillId` (long, required)
- `sellFillId` (long, required)
- `qty` (integer, required)
- `buyPrice` (double, required)
- `sellPrice` (double, required)
- `active` (boolean, required)
- `id` (long, optional)

### Order

- `accountId` (long, required)
- `timestamp` (datetime, required) — Create Time
- `action` (enum, required) — Buy, Sell
  - Allowed values: `Buy`, `Sell`
- `ordStatus` (enum, required) — Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working
  - Allowed values: `Canceled`, `Completed`, `Expired`, `Filled`, `PendingCancel`, `PendingNew`, `PendingReplace`, `Rejected`, `Suspended`, `Unknown`, `Working`
- `admin` (boolean, required)
- `id` (long, optional)
- `contractId` (long, optional)
- `spreadDefinitionId` (long, optional)
- `executionProviderId` (long, optional)
- `ocoId` (long, optional)
- `parentId` (long, optional)
- `linkedId` (long, optional)
- `clOrdId` (string, optional)

### Contract

- `name` (string, required)
- `contractMaturityId` (long, required)
- `timestamp` (datetime, required)
- `id` (long, optional)

### ContractMaturity

- `productId` (long, required)
- `expirationMonth` (integer, required)
- `expirationDate` (datetime, required)
- `isFront` (boolean, required)
- `id` (long, optional)
- `firstIntentDate` (datetime, optional)
- `underlyingId` (long, optional) — Underlying
- `kalshiEventId` (long, optional)

### Product

- `name` (string, required)
- `currencyId` (long, required)
- `productType` (enum, required) — CommonStock, Continuous, Cryptocurrency, Futures, MarketInternals, Options, Spread, Swap
  - Allowed values: `CommonStock`, `Continuous`, `Cryptocurrency`, `Futures`, `MarketInternals`, `Options`, `Spread`, `Swap`
- `description` (string, required)
- `exchangeId` (long, required)
- `contractGroupId` (long, required)
- `status` (enum, required) — Inactive, Locked, ReadyForContracts, ReadyToTrade, Verified
  - Allowed values: `Inactive`, `Locked`, `ReadyForContracts`, `ReadyToTrade`, `Verified`
- `valuePerPoint` (double, required)
- `priceFormatType` (enum, required) — Decimal, Fractional
  - Allowed values: `Decimal`, `Fractional`
- `priceFormat` (integer, required)
- `tickSize` (double, required) — Product Tick Size
- `id` (long, optional)
- `riskDiscountContractGroupId` (long, optional)
- `months` (string, optional)
- `isSecured` (boolean, optional)
- `postTradeCategoryId` (long, optional)

### Exchange

- `name` (string, required)
- `id` (long, optional)
- `micCode` (string, optional)

### SpreadDefinition

- `timestamp` (datetime, required)
- `spreadType` (enum, required) — Bundle, BundleSpread, Butterfly, CalendarSpread, Condor, Crack, DoubleButterfly, General, IntercommoditySpread, LaggedIntercommoditySpread, Pack, PackButterfly, PackSpread, ReducedTickCalendarSpread, ReverseIntercommoditySpread, ReverseSpread, Strip, TreasuryIntercommoditySpread
  - Allowed values: `Bundle`, `BundleSpread`, `Butterfly`, `CalendarSpread`, `Condor`, `Crack`, `DoubleButterfly`, `General`, `IntercommoditySpread`, `LaggedIntercommoditySpread`, `Pack`, `PackButterfly`, `PackSpread`, `ReducedTickCalendarSpread`, `ReverseIntercommoditySpread`, `ReverseSpread`, `Strip`, `TreasuryIntercommoditySpread`
- `uds` (boolean, required)
- `id` (long, optional)

### Command

- `orderId` (long, required)
- `timestamp` (datetime, required)
- `commandType` (enum, required) — Cancel, Modify, New
  - Allowed values: `Cancel`, `Modify`, `New`
- `commandStatus` (enum, required) — AtExecution, ExecutionRejected, ExecutionStopped, ExecutionSuspended, OnHold, Pending, PendingExecution, Replaced, RiskPassed, RiskRejected
  - Allowed values: `AtExecution`, `ExecutionRejected`, `ExecutionStopped`, `ExecutionSuspended`, `OnHold`, `Pending`, `PendingExecution`, `Replaced`, `RiskPassed`, `RiskRejected`
- `id` (long, optional)
- `clOrdId` (string, optional)
- `senderId` (long, optional)
- `userSessionId` (long, optional)
- `activationTime` (datetime, optional)
- `customTag50` (string, optional)
- `isAutomated` (boolean, optional)

### CommandReport

- `commandId` (long, required)
- `timestamp` (datetime, required)
- `commandStatus` (enum, required) — AtExecution, ExecutionRejected, ExecutionStopped, ExecutionSuspended, OnHold, Pending, PendingExecution, Replaced, RiskPassed, RiskRejected
  - Allowed values: `AtExecution`, `ExecutionRejected`, `ExecutionStopped`, `ExecutionSuspended`, `OnHold`, `Pending`, `PendingExecution`, `Replaced`, `RiskPassed`, `RiskRejected`
- `id` (long, optional)
- `rejectReason` (enum, optional) — AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, HomeStateRestricted, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MinTradeDurationNotElapsed, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported
  - Allowed values: `AccountClosed`, `AdvancedTrailingStopUnsupported`, `AnotherCommandPending`, `BackMonthProhibited`, `ExecutionProviderNotConfigured`, `ExecutionProviderUnavailable`, `HomeStateRestricted`, `InvalidContract`, `InvalidPrice`, `KeyInformationDocumentRequired`, `LiquidationOnly`, `LiquidationOnlyBeforeExpiration`, `MaxOrderQtyIsNotSpecified`, `MaxOrderQtyLimitReached`, `MaxPosLimitMisconfigured`, `MaxPosLimitReached`, `MaxTotalPosLimitReached`, `MinTradeDurationNotElapsed`, `MultipleAccountPlanRequired`, `NoQuote`, `NotEnoughLiquidity`, `OtherExecutionRelated`, `ParentRejected`, `RiskCheckTimeout`, `SSFNFAComplianceRequired`, `SSFNFAComplianceRequiredJointOnly`, `SSFRiskDisclosureAcknowledgmentRequired`, `SessionClosed`, `Success`, `TooLate`, `TradingLocked`, `TrailingStopNonOrderQtyModify`, `Unauthorized`, `UnknownReason`, `Unsupported`
- `text` (string, optional)
- `ordStatus` (enum, optional) — Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working
  - Allowed values: `Canceled`, `Completed`, `Expired`, `Filled`, `PendingCancel`, `PendingNew`, `PendingReplace`, `Rejected`, `Suspended`, `Unknown`, `Working`

### ExecutionReport

- `commandId` (long, required)
- `name` (string, required)
- `accountId` (long, required)
- `contractId` (long, required)
- `timestamp` (datetime, required)
- `orderId` (long, required)
- `execType` (enum, required) — Canceled, Completed, DoneForDay, Expired, New, OrderStatus, PendingCancel, PendingNew, PendingReplace, Rejected, Replaced, Stopped, Suspended, Trade, TradeCancel, TradeCorrect
  - Allowed values: `Canceled`, `Completed`, `DoneForDay`, `Expired`, `New`, `OrderStatus`, `PendingCancel`, `PendingNew`, `PendingReplace`, `Rejected`, `Replaced`, `Stopped`, `Suspended`, `Trade`, `TradeCancel`, `TradeCorrect`
- `action` (enum, required) — Buy, Sell
  - Allowed values: `Buy`, `Sell`
- `id` (long, optional)
- `tradeDate` (TradeDate, optional)
- `execRefId` (string, optional)
- `ordStatus` (enum, optional) — Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working
  - Allowed values: `Canceled`, `Completed`, `Expired`, `Filled`, `PendingCancel`, `PendingNew`, `PendingReplace`, `Rejected`, `Suspended`, `Unknown`, `Working`
- `cumQty` (integer, optional)
- `avgPx` (double, optional)
- `lastQty` (integer, optional)
- `lastPx` (double, optional)
- `rejectReason` (enum, optional) — AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, HomeStateRestricted, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MinTradeDurationNotElapsed, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported
  - Allowed values: `AccountClosed`, `AdvancedTrailingStopUnsupported`, `AnotherCommandPending`, `BackMonthProhibited`, `ExecutionProviderNotConfigured`, `ExecutionProviderUnavailable`, `HomeStateRestricted`, `InvalidContract`, `InvalidPrice`, `KeyInformationDocumentRequired`, `LiquidationOnly`, `LiquidationOnlyBeforeExpiration`, `MaxOrderQtyIsNotSpecified`, `MaxOrderQtyLimitReached`, `MaxPosLimitMisconfigured`, `MaxPosLimitReached`, `MaxTotalPosLimitReached`, `MinTradeDurationNotElapsed`, `MultipleAccountPlanRequired`, `NoQuote`, `NotEnoughLiquidity`, `OtherExecutionRelated`, `ParentRejected`, `RiskCheckTimeout`, `SSFNFAComplianceRequired`, `SSFNFAComplianceRequiredJointOnly`, `SSFRiskDisclosureAcknowledgmentRequired`, `SessionClosed`, `Success`, `TooLate`, `TradingLocked`, `TrailingStopNonOrderQtyModify`, `Unauthorized`, `UnknownReason`, `Unsupported`
- `text` (string, optional)
- `exchangeOrderId` (string, optional)

### OrderVersion

- `orderId` (long, required)
- `orderQty` (integer, required)
- `orderType` (enum, required) — Limit, LimitIfTouched, MIT, Market, MarketLimit, MarketStopWithProtection, MarketWithProtection, QTS, Stop, StopLimit, TrailingStop, TrailingStopLimit
  - Allowed values: `Limit`, `LimitIfTouched`, `MIT`, `Market`, `MarketLimit`, `MarketStopWithProtection`, `MarketWithProtection`, `QTS`, `Stop`, `StopLimit`, `TrailingStop`, `TrailingStopLimit`
- `id` (long, optional)
- `price` (double, optional)
- `stopPrice` (double, optional)
- `limitIfTouchedPrice` (double, optional)
- `maxShow` (integer, optional)
- `pegDifference` (double, optional)
- `timeInForce` (enum, optional) — Day, FOK, GTC, GTD, IOC
  - Allowed values: `Day`, `FOK`, `GTC`, `GTD`, `IOC`
- `expireTime` (datetime, optional)
- `text` (string, optional)

### Fill

- `orderId` (long, required)
- `contractId` (long, required)
- `timestamp` (datetime, required)
- `tradeDate` (TradeDate, required)
- `action` (enum, required) — Buy, Sell
  - Allowed values: `Buy`, `Sell`
- `qty` (integer, required)
- `price` (double, required)
- `active` (boolean, required)
- `finallyPaired` (integer, required)
- `id` (long, optional)

### FillFee

- `id` (long, optional)
- `clearingFee` (double, optional)
- `clearingCurrencyId` (long, optional)
- `exchangeFee` (double, optional)
- `exchangeCurrencyId` (long, optional)
- `nfaFee` (double, optional)
- `nfaCurrencyId` (long, optional)
- `brokerageFee` (double, optional)
- `brokerageCurrencyId` (long, optional)
- `ipFee` (double, optional) — IP/TT Fee
- `ipCurrencyId` (long, optional)
- `commission` (double, optional)
- `commissionCurrencyId` (long, optional)
- `orderRoutingFee` (double, optional)
- `orderRoutingCurrencyId` (long, optional)

### UserAccountPositionExit

- `accountId` (long, required)
- `contractId` (long, required)
- `id` (long, optional)
- `flattenTimestamp` (datetime, optional) — Flatten &amp; Cancel
- `repeatInterval` (integer, optional)

### Rfq

- `accountId` (long, required)
- `timestamp` (datetime, required)
- `quoteReqId` (string, required)
- `status` (enum, required) — AcceptQuoteAccepted, AcceptQuoteSent, Canceled, Expired, Filled, QuoteRequestAcked, QuoteRequestRejected, QuoteRequestSent
  - Allowed values: `AcceptQuoteAccepted`, `AcceptQuoteSent`, `Canceled`, `Expired`, `Filled`, `QuoteRequestAcked`, `QuoteRequestRejected`, `QuoteRequestSent`
- `id` (long, optional)
- `exchangeRfqId` (string, optional)
- `marketTicker` (string, optional)
- `collectionTicker` (string, optional)
- `legs` (string, optional)
- `contractId` (long, optional)
- `orderQty` (integer, optional)
- `cashOrderQty` (double, optional)
- `replaceExisting` (boolean, optional)
- `autoAcceptAction` (enum, optional) — Buy, Sell
  - Allowed values: `Buy`, `Sell`
- `autoAcceptReferencePrice` (double, optional)
- `autoAcceptThresholdDollars` (double, optional)
- `autoAcceptOrderQty` (integer, optional)
- `autoAcceptPreferBetterQuote` (boolean, optional)
- `cancelRequestedAt` (datetime, optional)

### RfqEvent

- `rfqId` (long, required)
- `accountId` (long, required)
- `timestamp` (datetime, required)
- `eventType` (enum, required) — AcceptQuoteAccepted, AcceptQuoteRejected, AcceptQuoteSent, CancelRejected, Canceled, ConfirmFailed, Expired, Quote, QuoteRequestAcked, QuoteRequestRejected
  - Allowed values: `AcceptQuoteAccepted`, `AcceptQuoteRejected`, `AcceptQuoteSent`, `CancelRejected`, `Canceled`, `ConfirmFailed`, `Expired`, `Quote`, `QuoteRequestAcked`, `QuoteRequestRejected`
- `id` (long, optional)
- `quoteId` (string, optional)
- `requestedQuoteId` (string, optional)
- `quoterId` (string, optional)
- `bidPx` (double, optional)
- `bidSize` (integer, optional)
- `offerPx` (double, optional)
- `offerSize` (integer, optional)
- `orderId` (long, optional)
- `preferBetterQuote` (boolean, optional)
- `reason` (string, optional)

### OrderStrategy

- `accountId` (long, required)
- `timestamp` (datetime, required)
- `contractId` (long, required)
- `orderStrategyTypeId` (long, required)
- `action` (enum, required) — Buy, Sell
  - Allowed values: `Buy`, `Sell`
- `status` (enum, required) — ActiveStrategy, ExecutionFailed, ExecutionFinished, ExecutionInterrupted, InactiveStrategy, NotEnoughLiquidity, StoppedByUser
  - Allowed values: `ActiveStrategy`, `ExecutionFailed`, `ExecutionFinished`, `ExecutionInterrupted`, `InactiveStrategy`, `NotEnoughLiquidity`, `StoppedByUser`
- `id` (long, optional)
- `initiatorId` (long, optional)
- `params` (string, optional)
- `uuid` (string, optional)
- `failureMessage` (string, optional)
- `senderId` (long, optional)
- `customTag50` (string, optional)
- `userSessionId` (long, optional)

### OrderStrategyLink

- `orderStrategyId` (long, required)
- `orderId` (long, required)
- `label` (string, required)
- `id` (long, optional)

### UserPlugin

- `userId` (long, required)
- `timestamp` (datetime, required)
- `planPrice` (double, required)
- `pluginName` (string, required)
- `approval` (boolean, required)
- `startDate` (TradeDate, required)
- `paidAmount` (double, required)
- `id` (long, optional)
- `cashBalanceLogId` (long, optional)
- `accountId` (long, optional)
- `entitlementId` (long, optional)
- `expirationDate` (TradeDate, optional)
- `autorenewal` (boolean, optional)
- `planCategories` (string, optional)
- `rebate` (double, optional)

### AnnualReview

- `userId` (long, required)
- `riskDisclosureNeeded` (boolean, required)
- `archived` (boolean, required)
- `status` (enum, required) — Closed, Open, Processed
  - Allowed values: `Closed`, `Open`, `Processed`
- `id` (long, optional)
- `firstEmail` (string, optional)
- `secondEmail` (string, optional)
- `jointFirstEmail` (string, optional)
- `jointSecondEmail` (string, optional)
- `firstEmailSent` (datetime, optional)
- `secondEmailSent` (datetime, optional)
- `finished` (datetime, optional)
- `jointFinished` (datetime, optional)
- `identityCheckResult` (enum, optional) — Fail, Pass, ReviewNeeded
  - Allowed values: `Fail`, `Pass`, `ReviewNeeded`
- `jointIdentityCheckResult` (enum, optional) — Fail, Pass, ReviewNeeded
  - Allowed values: `Fail`, `Pass`, `ReviewNeeded`
- `contactInfoId` (long, optional)

### UserReadStatus

- `id` (long, optional)
- `newsStoryId` (long, optional)

### UserPromoCode

- `userId` (long, required)
- `promoCodeId` (long, required)
- `source` (enum, required) — Admin, Input, URL
  - Allowed values: `Admin`, `Input`, `URL`
- `id` (long, optional)
- `accountId` (long, optional)
- `comments` (string, optional)

### OrderStrategyType

- `name` (string, required)
- `enabled` (boolean, required)
- `id` (long, optional)

### SteppedCooldownConfig

- `steps` (list of CooldownStep, required)
- `terminalStep` (CooldownTerminalStep, optional)

### TradeDate

- `year` (integer, required)
- `month` (integer, required)
- `day` (integer, required)

### CooldownStep

- `stepNumber` (integer, required)
- `stepDistance` (double, required)
- `cooldownMinutes` (integer, required)

### CooldownTerminalStep

- `stepNumber` (integer, required)
- `stepDistance` (double, required)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "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
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://live.tradovateapi.com/v1/user/syncrequest"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://live.tradovateapi.com/v1/user/syncrequest';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://live.tradovateapi.com/v1/user/syncrequest"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://live.tradovateapi.com/v1/user/syncrequest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://live.tradovateapi.com/v1/user/syncrequest")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://live.tradovateapi.com/v1/user/syncrequest', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://live.tradovateapi.com/v1/user/syncrequest");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/user/syncrequest")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```