> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://partner.ninjatrader.com/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 ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: eval version: 1.0.0 paths: /user/syncrequest: post: operationId: sync-request summary: Sync Request description: >- ### 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. ``` tags: - subpackage_users parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: SyncMessage content: application/json: schema: $ref: '#/components/schemas/SyncMessage' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyncRequest' servers: - url: https://live.tradovateapi.com/v1 description: https://live.tradovateapi.com/v1 components: schemas: ShardingExpression: type: object properties: expressionType: type: string divisor: type: integer remainder: type: integer required: - expressionType - divisor - remainder title: ShardingExpression SyncRequest: type: object properties: users: type: array items: type: integer format: int64 accounts: type: array items: type: integer format: int64 splitResponses: type: boolean cutoffTimestamp: type: string format: date-time entityTypes: type: array items: type: string shardingExpression: $ref: '#/components/schemas/ShardingExpression' fullOrgSnapshot: type: boolean title: SyncRequest UserStatus: type: string enum: - Active - Closed - Initiated - TemporaryLocked - UnconfirmedEmail description: Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail title: UserStatus User: type: object properties: id: type: integer format: int64 name: type: string timestamp: type: string format: date-time email: type: string status: $ref: '#/components/schemas/UserStatus' description: Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail professional: type: boolean organizationId: type: integer format: int64 introducingPartnerId: type: integer format: int64 required: - name - timestamp - email - status - professional title: User UserProperty: type: object properties: id: type: integer format: int64 userId: type: integer format: int64 propertyId: type: integer format: int64 value: type: string required: - userId - propertyId title: UserProperty PropertyPropertyType: type: string enum: - Boolean - Enum - Integer - String description: Boolean, Enum, Integer, String title: PropertyPropertyType Property: type: object properties: id: type: integer format: int64 name: type: string propertyType: $ref: '#/components/schemas/PropertyPropertyType' description: Boolean, Enum, Integer, String enumOptions: type: string defaultValue: type: string required: - name - propertyType title: Property AccountAccountType: type: string enum: - Customer - Employee - Giveup - House - Omnibus - Wash description: Customer, Employee, Giveup, House, Omnibus, Wash title: AccountAccountType AccountMarginAccountType: type: string enum: - Hedger - Speculator description: Hedger, Speculator title: AccountMarginAccountType AccountLegalStatus: type: string enum: - Corporation - GP - IRA - Individual - Joint - LLC - LLP - LP - PTR - Trust description: Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust title: AccountLegalStatus Account: type: object properties: id: type: integer format: int64 name: type: string userId: type: integer format: int64 accountType: $ref: '#/components/schemas/AccountAccountType' description: Customer, Employee, Giveup, House, Omnibus, Wash restricted: type: boolean closed: type: boolean clearingHouseId: type: integer format: int64 riskCategoryId: type: integer format: int64 autoLiqProfileId: type: integer format: int64 marginAccountType: $ref: '#/components/schemas/AccountMarginAccountType' description: Hedger, Speculator legalStatus: $ref: '#/components/schemas/AccountLegalStatus' description: Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust timestamp: type: string format: date-time evaluationSize: type: number format: double readonly: type: boolean ccEmail: type: string futuresDisabled: type: boolean swapEnabled: type: boolean ssfRiskDisclosureAcknowledgment: type: string format: date-time spotMarginEnabled: type: boolean required: - name - userId - accountType - clearingHouseId - riskCategoryId - autoLiqProfileId - marginAccountType - legalStatus - timestamp title: Account AccountRiskStatusAdminAction: type: string enum: - AgreedOnLiqOnlyModeByAutoLiq - AgreedOnLiquidationByAutoLiq - DisableAutoLiq - LiquidateImmediately - LiquidateOnlyModeImmediately - LockTradingImmediately - Normal - PlaceAutoLiqOnHold description: >- AgreedOnLiqOnlyModeByAutoLiq, AgreedOnLiquidationByAutoLiq, DisableAutoLiq, LiquidateImmediately, LiquidateOnlyModeImmediately, LockTradingImmediately, Normal, PlaceAutoLiqOnHold title: AccountRiskStatusAdminAction AccountRiskStatus: type: object properties: id: type: integer format: int64 adminAction: $ref: '#/components/schemas/AccountRiskStatusAdminAction' description: >- AgreedOnLiqOnlyModeByAutoLiq, AgreedOnLiquidationByAutoLiq, DisableAutoLiq, LiquidateImmediately, LiquidateOnlyModeImmediately, LockTradingImmediately, Normal, PlaceAutoLiqOnHold adminTimestamp: type: string format: date-time liquidateOnly: type: string format: date-time userTriggeredLiqOnly: type: boolean maxNetLiq: type: number format: double description: $ Max Net Liq minNetLiq: type: number format: double description: $ Min Net Liq title: AccountRiskStatus MarginSnapshot: type: object properties: id: type: integer format: int64 timestamp: type: string format: date-time riskTimePeriodId: type: integer format: int64 initialMargin: type: number format: double maintenanceMargin: type: number format: double autoLiqLevel: type: number format: double liqOnlyLevel: type: number format: double totalUsedMargin: type: number format: double fullInitialMargin: type: number format: double positionMargin: type: number format: double totalUsedFullMargin: type: number format: double openCollateralReq: type: number format: double required: - timestamp - riskTimePeriodId - initialMargin - maintenanceMargin - totalUsedMargin - fullInitialMargin - positionMargin - totalUsedFullMargin title: MarginSnapshot UserAccountAutoLiqTrailingMaxDrawdownMode: type: string enum: - EOD - RealTime description: EOD, RealTime title: UserAccountAutoLiqTrailingMaxDrawdownMode CooldownStep: type: object properties: stepNumber: type: integer stepDistance: type: number format: double cooldownMinutes: type: integer required: - stepNumber - stepDistance - cooldownMinutes title: CooldownStep SteppedCooldownConfig: type: object properties: steps: type: array items: $ref: '#/components/schemas/CooldownStep' required: - steps title: SteppedCooldownConfig UserAccountAutoLiq: type: object properties: id: type: integer format: int64 changesLocked: type: boolean description: Changes Locked marginPercentageAlert: type: number format: double description: Margin % for an Alert dailyLossPercentageAlert: type: number format: double description: Daily Loss % for an Alert dailyLossAlert: type: number format: double description: $ Daily Loss for an Alert marginPercentageLiqOnly: type: number format: double description: Margin % for an Liq Only dailyLossPercentageLiqOnly: type: number format: double description: Daily Loss % for an Liq Only dailyLossLiqOnly: type: number format: double description: $ Daily Loss for an Liq Only marginPercentageAutoLiq: type: number format: double description: Margin % for an Auto-Liq dailyLossPercentageAutoLiq: type: number format: double description: Daily Loss % for an AutoLiq dailyLossAutoLiq: type: number format: double description: $ Daily Loss for an Auto-Liq weeklyLossAutoLiq: type: number format: double description: $ Weekly Loss for an Auto-Liq flattenTimestamp: type: string format: date-time description: Flatten & Cancel trailingMaxDrawdown: type: number format: double description: $ Trailing Max Drawdown trailingMaxDrawdownLimit: type: number format: double description: $ Trailing Max Drawdown Limit trailingMaxDrawdownMode: $ref: '#/components/schemas/UserAccountAutoLiqTrailingMaxDrawdownMode' description: EOD, RealTime dailyProfitAutoLiq: type: number format: double description: $ Daily Profit for an Auto-Liq weeklyProfitAutoLiq: type: number format: double description: $ Weekly Profit for an Auto-Liq doNotUnlock: type: boolean description: Do not automatically unlock account if triggered steppedCooldown: $ref: '#/components/schemas/SteppedCooldownConfig' steppedUnlimited: type: boolean title: UserAccountAutoLiq TradeDate: type: object properties: year: type: integer month: type: integer day: type: integer required: - year - month - day title: TradeDate CashBalance: type: object properties: id: type: integer format: int64 accountId: type: integer format: int64 timestamp: type: string format: date-time tradeDate: $ref: '#/components/schemas/TradeDate' currencyId: type: integer format: int64 amount: type: number format: double realizedPnL: type: number format: double weekRealizedPnL: type: number format: double amountSOD: type: number format: double required: - accountId - timestamp - tradeDate - currencyId - amount title: CashBalance Currency: type: object properties: id: type: integer format: int64 name: type: string symbol: type: string required: - name title: Currency PositionSettlementStatus: type: string enum: - PendingSettlement - SettlementBooked description: PendingSettlement, SettlementBooked title: PositionSettlementStatus Position: type: object properties: id: type: integer format: int64 accountId: type: integer format: int64 contractId: type: integer format: int64 timestamp: type: string format: date-time tradeDate: $ref: '#/components/schemas/TradeDate' netPos: type: integer netPrice: type: number format: double bought: type: integer boughtValue: type: number format: double sold: type: integer soldValue: type: number format: double prevPos: type: integer prevPrice: type: number format: double settlementStatus: $ref: '#/components/schemas/PositionSettlementStatus' description: PendingSettlement, SettlementBooked pendingSince: type: string format: date-time required: - accountId - contractId - timestamp - tradeDate - netPos - bought - boughtValue - sold - soldValue - prevPos title: Position FillPair: type: object properties: id: type: integer format: int64 positionId: type: integer format: int64 buyFillId: type: integer format: int64 sellFillId: type: integer format: int64 qty: type: integer buyPrice: type: number format: double sellPrice: type: number format: double active: type: boolean required: - positionId - buyFillId - sellFillId - qty - buyPrice - sellPrice - active title: FillPair OrderAction: type: string enum: - Buy - Sell description: Buy, Sell title: OrderAction OrderOrdStatus: type: string enum: - Canceled - Completed - Expired - Filled - PendingCancel - PendingNew - PendingReplace - Rejected - Suspended - Unknown - Working description: >- Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working title: OrderOrdStatus Order: type: object properties: id: type: integer format: int64 accountId: type: integer format: int64 contractId: type: integer format: int64 spreadDefinitionId: type: integer format: int64 timestamp: type: string format: date-time description: Create Time action: $ref: '#/components/schemas/OrderAction' description: Buy, Sell ordStatus: $ref: '#/components/schemas/OrderOrdStatus' description: >- Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working executionProviderId: type: integer format: int64 ocoId: type: integer format: int64 parentId: type: integer format: int64 linkedId: type: integer format: int64 admin: type: boolean required: - accountId - timestamp - action - ordStatus - admin title: Order Contract: type: object properties: id: type: integer format: int64 name: type: string contractMaturityId: type: integer format: int64 timestamp: type: string format: date-time required: - name - contractMaturityId - timestamp title: Contract ContractMaturity: type: object properties: id: type: integer format: int64 productId: type: integer format: int64 expirationMonth: type: integer expirationDate: type: string format: date-time firstIntentDate: type: string format: date-time underlyingId: type: integer format: int64 description: Underlying isFront: type: boolean kalshiEventId: type: integer format: int64 required: - productId - expirationMonth - expirationDate - isFront title: ContractMaturity ProductProductType: type: string enum: - CommonStock - Continuous - Cryptocurrency - Futures - MarketInternals - Options - Spread - Swap description: >- CommonStock, Continuous, Cryptocurrency, Futures, MarketInternals, Options, Spread, Swap title: ProductProductType ProductStatus: type: string enum: - Inactive - Locked - ReadyForContracts - ReadyToTrade - Verified description: Inactive, Locked, ReadyForContracts, ReadyToTrade, Verified title: ProductStatus ProductPriceFormatType: type: string enum: - Decimal - Fractional description: Decimal, Fractional title: ProductPriceFormatType Product: type: object properties: id: type: integer format: int64 name: type: string currencyId: type: integer format: int64 productType: $ref: '#/components/schemas/ProductProductType' description: >- CommonStock, Continuous, Cryptocurrency, Futures, MarketInternals, Options, Spread, Swap description: type: string exchangeId: type: integer format: int64 contractGroupId: type: integer format: int64 riskDiscountContractGroupId: type: integer format: int64 status: $ref: '#/components/schemas/ProductStatus' description: Inactive, Locked, ReadyForContracts, ReadyToTrade, Verified months: type: string isSecured: type: boolean valuePerPoint: type: number format: double priceFormatType: $ref: '#/components/schemas/ProductPriceFormatType' description: Decimal, Fractional priceFormat: type: integer tickSize: type: number format: double description: Product Tick Size postTradeCategoryId: type: integer format: int64 required: - name - currencyId - productType - description - exchangeId - contractGroupId - status - valuePerPoint - priceFormatType - priceFormat - tickSize title: Product Exchange: type: object properties: id: type: integer format: int64 name: type: string micCode: type: string required: - name title: Exchange SpreadDefinitionSpreadType: type: string enum: - Bundle - BundleSpread - Butterfly - CalendarSpread - Condor - Crack - DoubleButterfly - General - IntercommoditySpread - LaggedIntercommoditySpread - Pack - PackButterfly - PackSpread - ReducedTickCalendarSpread - ReverseIntercommoditySpread - ReverseSpread - Strip - TreasuryIntercommoditySpread description: >- Bundle, BundleSpread, Butterfly, CalendarSpread, Condor, Crack, DoubleButterfly, General, IntercommoditySpread, LaggedIntercommoditySpread, Pack, PackButterfly, PackSpread, ReducedTickCalendarSpread, ReverseIntercommoditySpread, ReverseSpread, Strip, TreasuryIntercommoditySpread title: SpreadDefinitionSpreadType SpreadDefinition: type: object properties: id: type: integer format: int64 timestamp: type: string format: date-time spreadType: $ref: '#/components/schemas/SpreadDefinitionSpreadType' description: >- Bundle, BundleSpread, Butterfly, CalendarSpread, Condor, Crack, DoubleButterfly, General, IntercommoditySpread, LaggedIntercommoditySpread, Pack, PackButterfly, PackSpread, ReducedTickCalendarSpread, ReverseIntercommoditySpread, ReverseSpread, Strip, TreasuryIntercommoditySpread uds: type: boolean required: - timestamp - spreadType - uds title: SpreadDefinition CommandCommandType: type: string enum: - Cancel - Modify - New description: Cancel, Modify, New title: CommandCommandType CommandCommandStatus: type: string enum: - AtExecution - ExecutionRejected - ExecutionStopped - ExecutionSuspended - OnHold - Pending - PendingExecution - Replaced - RiskPassed - RiskRejected description: >- AtExecution, ExecutionRejected, ExecutionStopped, ExecutionSuspended, OnHold, Pending, PendingExecution, Replaced, RiskPassed, RiskRejected title: CommandCommandStatus Command: type: object properties: id: type: integer format: int64 orderId: type: integer format: int64 timestamp: type: string format: date-time clOrdId: type: string commandType: $ref: '#/components/schemas/CommandCommandType' description: Cancel, Modify, New commandStatus: $ref: '#/components/schemas/CommandCommandStatus' description: >- AtExecution, ExecutionRejected, ExecutionStopped, ExecutionSuspended, OnHold, Pending, PendingExecution, Replaced, RiskPassed, RiskRejected senderId: type: integer format: int64 userSessionId: type: integer format: int64 activationTime: type: string format: date-time customTag50: type: string isAutomated: type: boolean required: - orderId - timestamp - commandType - commandStatus title: Command CommandReportCommandStatus: type: string enum: - AtExecution - ExecutionRejected - ExecutionStopped - ExecutionSuspended - OnHold - Pending - PendingExecution - Replaced - RiskPassed - RiskRejected description: >- AtExecution, ExecutionRejected, ExecutionStopped, ExecutionSuspended, OnHold, Pending, PendingExecution, Replaced, RiskPassed, RiskRejected title: CommandReportCommandStatus CommandReportRejectReason: type: string enum: - AccountClosed - AdvancedTrailingStopUnsupported - AnotherCommandPending - BackMonthProhibited - ExecutionProviderNotConfigured - ExecutionProviderUnavailable - InvalidContract - InvalidPrice - KeyInformationDocumentRequired - LiquidationOnly - LiquidationOnlyBeforeExpiration - MaxOrderQtyIsNotSpecified - MaxOrderQtyLimitReached - MaxPosLimitMisconfigured - MaxPosLimitReached - MaxTotalPosLimitReached - MultipleAccountPlanRequired - NoQuote - NotEnoughLiquidity - OtherExecutionRelated - ParentRejected - RiskCheckTimeout - SSFNFAComplianceRequired - SSFNFAComplianceRequiredJointOnly - SSFRiskDisclosureAcknowledgmentRequired - SessionClosed - Success - TooLate - TradingLocked - TrailingStopNonOrderQtyModify - Unauthorized - UnknownReason - Unsupported description: >- AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported title: CommandReportRejectReason CommandReportOrdStatus: type: string enum: - Canceled - Completed - Expired - Filled - PendingCancel - PendingNew - PendingReplace - Rejected - Suspended - Unknown - Working description: >- Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working title: CommandReportOrdStatus CommandReport: type: object properties: id: type: integer format: int64 commandId: type: integer format: int64 timestamp: type: string format: date-time commandStatus: $ref: '#/components/schemas/CommandReportCommandStatus' description: >- AtExecution, ExecutionRejected, ExecutionStopped, ExecutionSuspended, OnHold, Pending, PendingExecution, Replaced, RiskPassed, RiskRejected rejectReason: $ref: '#/components/schemas/CommandReportRejectReason' description: >- AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported text: type: string ordStatus: $ref: '#/components/schemas/CommandReportOrdStatus' description: >- Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working required: - commandId - timestamp - commandStatus title: CommandReport ExecutionReportExecType: type: string enum: - Canceled - Completed - DoneForDay - Expired - New - OrderStatus - PendingCancel - PendingNew - PendingReplace - Rejected - Replaced - Stopped - Suspended - Trade - TradeCancel - TradeCorrect description: >- Canceled, Completed, DoneForDay, Expired, New, OrderStatus, PendingCancel, PendingNew, PendingReplace, Rejected, Replaced, Stopped, Suspended, Trade, TradeCancel, TradeCorrect title: ExecutionReportExecType ExecutionReportOrdStatus: type: string enum: - Canceled - Completed - Expired - Filled - PendingCancel - PendingNew - PendingReplace - Rejected - Suspended - Unknown - Working description: >- Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working title: ExecutionReportOrdStatus ExecutionReportAction: type: string enum: - Buy - Sell description: Buy, Sell title: ExecutionReportAction ExecutionReportRejectReason: type: string enum: - AccountClosed - AdvancedTrailingStopUnsupported - AnotherCommandPending - BackMonthProhibited - ExecutionProviderNotConfigured - ExecutionProviderUnavailable - InvalidContract - InvalidPrice - KeyInformationDocumentRequired - LiquidationOnly - LiquidationOnlyBeforeExpiration - MaxOrderQtyIsNotSpecified - MaxOrderQtyLimitReached - MaxPosLimitMisconfigured - MaxPosLimitReached - MaxTotalPosLimitReached - MultipleAccountPlanRequired - NoQuote - NotEnoughLiquidity - OtherExecutionRelated - ParentRejected - RiskCheckTimeout - SSFNFAComplianceRequired - SSFNFAComplianceRequiredJointOnly - SSFRiskDisclosureAcknowledgmentRequired - SessionClosed - Success - TooLate - TradingLocked - TrailingStopNonOrderQtyModify - Unauthorized - UnknownReason - Unsupported description: >- AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported title: ExecutionReportRejectReason ExecutionReport: type: object properties: id: type: integer format: int64 commandId: type: integer format: int64 name: type: string accountId: type: integer format: int64 contractId: type: integer format: int64 timestamp: type: string format: date-time tradeDate: $ref: '#/components/schemas/TradeDate' orderId: type: integer format: int64 execType: $ref: '#/components/schemas/ExecutionReportExecType' description: >- Canceled, Completed, DoneForDay, Expired, New, OrderStatus, PendingCancel, PendingNew, PendingReplace, Rejected, Replaced, Stopped, Suspended, Trade, TradeCancel, TradeCorrect execRefId: type: string ordStatus: $ref: '#/components/schemas/ExecutionReportOrdStatus' description: >- Canceled, Completed, Expired, Filled, PendingCancel, PendingNew, PendingReplace, Rejected, Suspended, Unknown, Working action: $ref: '#/components/schemas/ExecutionReportAction' description: Buy, Sell cumQty: type: integer avgPx: type: number format: double lastQty: type: integer lastPx: type: number format: double rejectReason: $ref: '#/components/schemas/ExecutionReportRejectReason' description: >- AccountClosed, AdvancedTrailingStopUnsupported, AnotherCommandPending, BackMonthProhibited, ExecutionProviderNotConfigured, ExecutionProviderUnavailable, InvalidContract, InvalidPrice, KeyInformationDocumentRequired, LiquidationOnly, LiquidationOnlyBeforeExpiration, MaxOrderQtyIsNotSpecified, MaxOrderQtyLimitReached, MaxPosLimitMisconfigured, MaxPosLimitReached, MaxTotalPosLimitReached, MultipleAccountPlanRequired, NoQuote, NotEnoughLiquidity, OtherExecutionRelated, ParentRejected, RiskCheckTimeout, SSFNFAComplianceRequired, SSFNFAComplianceRequiredJointOnly, SSFRiskDisclosureAcknowledgmentRequired, SessionClosed, Success, TooLate, TradingLocked, TrailingStopNonOrderQtyModify, Unauthorized, UnknownReason, Unsupported text: type: string exchangeOrderId: type: string required: - commandId - name - accountId - contractId - timestamp - orderId - execType - action title: ExecutionReport OrderVersionOrderType: type: string enum: - Limit - LimitIfTouched - MIT - Market - MarketLimit - MarketStopWithProtection - MarketWithProtection - QTS - Stop - StopLimit - TrailingStop - TrailingStopLimit description: >- Limit, LimitIfTouched, MIT, Market, MarketLimit, MarketStopWithProtection, MarketWithProtection, QTS, Stop, StopLimit, TrailingStop, TrailingStopLimit title: OrderVersionOrderType OrderVersionTimeInForce: type: string enum: - Day - FOK - GTC - GTD - IOC description: Day, FOK, GTC, GTD, IOC title: OrderVersionTimeInForce OrderVersion: type: object properties: id: type: integer format: int64 orderId: type: integer format: int64 orderQty: type: integer orderType: $ref: '#/components/schemas/OrderVersionOrderType' description: >- Limit, LimitIfTouched, MIT, Market, MarketLimit, MarketStopWithProtection, MarketWithProtection, QTS, Stop, StopLimit, TrailingStop, TrailingStopLimit price: type: number format: double stopPrice: type: number format: double limitIfTouchedPrice: type: number format: double maxShow: type: integer pegDifference: type: number format: double timeInForce: $ref: '#/components/schemas/OrderVersionTimeInForce' description: Day, FOK, GTC, GTD, IOC expireTime: type: string format: date-time text: type: string required: - orderId - orderQty - orderType title: OrderVersion FillAction: type: string enum: - Buy - Sell description: Buy, Sell title: FillAction Fill: type: object properties: id: type: integer format: int64 orderId: type: integer format: int64 contractId: type: integer format: int64 timestamp: type: string format: date-time tradeDate: $ref: '#/components/schemas/TradeDate' action: $ref: '#/components/schemas/FillAction' description: Buy, Sell qty: type: integer price: type: number format: double active: type: boolean finallyPaired: type: integer required: - orderId - contractId - timestamp - tradeDate - action - qty - price - active - finallyPaired title: Fill FillFee: type: object properties: id: type: integer format: int64 clearingFee: type: number format: double clearingCurrencyId: type: integer format: int64 exchangeFee: type: number format: double exchangeCurrencyId: type: integer format: int64 nfaFee: type: number format: double nfaCurrencyId: type: integer format: int64 brokerageFee: type: number format: double brokerageCurrencyId: type: integer format: int64 ipFee: type: number format: double description: IP/TT Fee ipCurrencyId: type: integer format: int64 commission: type: number format: double commissionCurrencyId: type: integer format: int64 orderRoutingFee: type: number format: double orderRoutingCurrencyId: type: integer format: int64 title: FillFee OrderStrategyAction: type: string enum: - Buy - Sell description: Buy, Sell title: OrderStrategyAction OrderStrategyStatus: type: string enum: - ActiveStrategy - ExecutionFailed - ExecutionFinished - ExecutionInterrupted - InactiveStrategy - NotEnoughLiquidity - StoppedByUser description: >- ActiveStrategy, ExecutionFailed, ExecutionFinished, ExecutionInterrupted, InactiveStrategy, NotEnoughLiquidity, StoppedByUser title: OrderStrategyStatus OrderStrategy: type: object properties: id: type: integer format: int64 accountId: type: integer format: int64 timestamp: type: string format: date-time contractId: type: integer format: int64 orderStrategyTypeId: type: integer format: int64 initiatorId: type: integer format: int64 action: $ref: '#/components/schemas/OrderStrategyAction' description: Buy, Sell params: type: string uuid: type: string status: $ref: '#/components/schemas/OrderStrategyStatus' description: >- ActiveStrategy, ExecutionFailed, ExecutionFinished, ExecutionInterrupted, InactiveStrategy, NotEnoughLiquidity, StoppedByUser failureMessage: type: string senderId: type: integer format: int64 customTag50: type: string userSessionId: type: integer format: int64 required: - accountId - timestamp - contractId - orderStrategyTypeId - action - status title: OrderStrategy OrderStrategyLink: type: object properties: id: type: integer format: int64 orderStrategyId: type: integer format: int64 orderId: type: integer format: int64 label: type: string required: - orderStrategyId - orderId - label title: OrderStrategyLink UserPlugin: type: object properties: id: type: integer format: int64 userId: type: integer format: int64 timestamp: type: string format: date-time planPrice: type: number format: double cashBalanceLogId: type: integer format: int64 accountId: type: integer format: int64 pluginName: type: string approval: type: boolean entitlementId: type: integer format: int64 startDate: $ref: '#/components/schemas/TradeDate' expirationDate: $ref: '#/components/schemas/TradeDate' paidAmount: type: number format: double autorenewal: type: boolean planCategories: type: string rebate: type: number format: double required: - userId - timestamp - planPrice - pluginName - approval - startDate - paidAmount title: UserPlugin AnnualReviewIdentityCheckResult: type: string enum: - Fail - Pass - ReviewNeeded description: Fail, Pass, ReviewNeeded title: AnnualReviewIdentityCheckResult AnnualReviewJointIdentityCheckResult: type: string enum: - Fail - Pass - ReviewNeeded description: Fail, Pass, ReviewNeeded title: AnnualReviewJointIdentityCheckResult AnnualReviewStatus: type: string enum: - Closed - Open - Processed description: Closed, Open, Processed title: AnnualReviewStatus AnnualReview: type: object properties: id: type: integer format: int64 userId: type: integer format: int64 firstEmail: type: string secondEmail: type: string jointFirstEmail: type: string jointSecondEmail: type: string firstEmailSent: type: string format: date-time secondEmailSent: type: string format: date-time finished: type: string format: date-time jointFinished: type: string format: date-time riskDisclosureNeeded: type: boolean identityCheckResult: $ref: '#/components/schemas/AnnualReviewIdentityCheckResult' description: Fail, Pass, ReviewNeeded jointIdentityCheckResult: $ref: '#/components/schemas/AnnualReviewJointIdentityCheckResult' description: Fail, Pass, ReviewNeeded archived: type: boolean contactInfoId: type: integer format: int64 status: $ref: '#/components/schemas/AnnualReviewStatus' description: Closed, Open, Processed required: - userId - riskDisclosureNeeded - archived - status title: AnnualReview UserReadStatus: type: object properties: id: type: integer format: int64 newsStoryId: type: integer format: int64 title: UserReadStatus UserPromoCodeSource: type: string enum: - Admin - Input - URL description: Admin, Input, URL title: UserPromoCodeSource UserPromoCode: type: object properties: id: type: integer format: int64 userId: type: integer format: int64 promoCodeId: type: integer format: int64 accountId: type: integer format: int64 source: $ref: '#/components/schemas/UserPromoCodeSource' description: Admin, Input, URL comments: type: string required: - userId - promoCodeId - source title: UserPromoCode ContractGroup: type: object properties: id: type: integer format: int64 name: type: string required: - name title: ContractGroup OrderStrategyType: type: object properties: id: type: integer format: int64 name: type: string enabled: type: boolean required: - name - enabled title: OrderStrategyType SyncMessage: type: object properties: users: type: array items: $ref: '#/components/schemas/User' userProperties: type: array items: $ref: '#/components/schemas/UserProperty' properties: type: array items: $ref: '#/components/schemas/Property' accounts: type: array items: $ref: '#/components/schemas/Account' accountRiskStatuses: type: array items: $ref: '#/components/schemas/AccountRiskStatus' marginSnapshots: type: array items: $ref: '#/components/schemas/MarginSnapshot' userAccountAutoLiqs: type: array items: $ref: '#/components/schemas/UserAccountAutoLiq' cashBalances: type: array items: $ref: '#/components/schemas/CashBalance' currencies: type: array items: $ref: '#/components/schemas/Currency' positions: type: array items: $ref: '#/components/schemas/Position' fillPairs: type: array items: $ref: '#/components/schemas/FillPair' orders: type: array items: $ref: '#/components/schemas/Order' contracts: type: array items: $ref: '#/components/schemas/Contract' contractMaturities: type: array items: $ref: '#/components/schemas/ContractMaturity' products: type: array items: $ref: '#/components/schemas/Product' exchanges: type: array items: $ref: '#/components/schemas/Exchange' spreadDefinitions: type: array items: $ref: '#/components/schemas/SpreadDefinition' commands: type: array items: $ref: '#/components/schemas/Command' commandReports: type: array items: $ref: '#/components/schemas/CommandReport' executionReports: type: array items: $ref: '#/components/schemas/ExecutionReport' orderVersions: type: array items: $ref: '#/components/schemas/OrderVersion' fills: type: array items: $ref: '#/components/schemas/Fill' fillFees: type: array items: $ref: '#/components/schemas/FillFee' orderStrategies: type: array items: $ref: '#/components/schemas/OrderStrategy' orderStrategyLinks: type: array items: $ref: '#/components/schemas/OrderStrategyLink' userPlugins: type: array items: $ref: '#/components/schemas/UserPlugin' annualReviews: type: array items: $ref: '#/components/schemas/AnnualReview' userReadStatuses: type: array items: $ref: '#/components/schemas/UserReadStatus' userPromoCodes: type: array items: $ref: '#/components/schemas/UserPromoCode' contractGroups: type: array items: $ref: '#/components/schemas/ContractGroup' orderStrategyTypes: type: array items: $ref: '#/components/schemas/OrderStrategyType' required: - users - contractGroups title: SyncMessage securitySchemes: bearer_access_token: type: http scheme: bearer ``` ## 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 } ], "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 } ] }, "steppedUnlimited": true } ], "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" } ], "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 } ], "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 } ], "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 ", "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 ', '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 ") 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 ' 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 response = Unirest.post("https://live.tradovateapi.com/v1/user/syncrequest") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://live.tradovateapi.com/v1/user/syncrequest', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', '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 "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "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() ```