# Models ## The DepositTicket object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"DepositTicket":{"type":"object","properties":{"assetManagerId":{"type":"integer"},"accountId":{"type":"integer"},"assetId":{"type":"integer"},"assetName":{"type":"string","nullable":true},"amount":{"type":"number"},"omsId":{"type":"integer"},"requestCode":{"type":"string","nullable":true},"requestIP":{"type":"string","nullable":true},"requestUser":{"type":"integer"},"requestUserName":{"type":"string","nullable":true},"operatorId":{"type":"integer"},"Status":{"type":"integer"},"feeAmt":{"type":"number"},"updatedByUser":{"type":"integer"},"updatedByUserName":{"type":"string","nullable":true},"ticketNumber":{"type":"integer"},"depositInfo":{"type":"object","nullable":true},"createdTimestamp":{"type":"string","format":"date-time"},"lastUpdateTimeStamp":{"type":"string","format":"date-time"},"comments":{"type":"object","nullable":true},"attachments":{"type":"object","nullable":true}}}}}} ``` ## The WithdrawTicket object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"WithdrawTicket":{"type":"object","properties":{"assetManagerId":{"type":"integer"},"accountId":{"type":"integer"},"assetId":{"type":"integer"},"assetName":{"type":"string"},"amount":{"type":"number"},"templateForm":{"type":"string"},"templateFormType":{"type":"string"},"omsId":{"type":"integer"},"requestCode":{"type":"string"},"requestIP":{"type":"string"},"requestUserId":{"type":"integer"},"requestUserName":{"type":"string"},"operatorId":{"type":"integer"},"Status":{"type":"integer"},"feeAmt":{"type":"number"},"updatedByUser":{"type":"integer"},"updatedByUserName":{"type":"string"},"ticketNumber":{"type":"integer"},"createdTimestamp":{"type":"string","format":"date-time"},"lastUpdateTimestamp":{"type":"string","format":"date-time"},"Comments":{"type":"array","items":{"type":"object","properties":{"commentId":{"type":"integer"},"enteredBy":{"type":"integer"},"enteredDateTime":{"type":"string","format":"date-time"},"comment":{"type":"string"},"operatorId":{"type":"integer"},"omsId":{"type":"integer"},"ticketCode":{"type":"string"},"ticketId":{"type":"integer"}}}},"Attachments":{"type":"array","items":{"type":"object","properties":{"attachmentId":{"type":"integer"},"submittedByUserId":{"type":"integer"},"submittedByUserName":{"type":"string"},"uploadDate":{"type":"string","format":"date-time"},"uploadIP":{"type":"string"},"ticketNumber":{"type":"integer"}}}},"AuditLog":{"type":"array","items":{"type":"object"}}}}}}} ``` ## The ApiResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"ApiResponse":{"type":"object","properties":{"success":{"type":"boolean"},"requestcode":{"type":"string"}}}}}} ``` ## The AuthenticationResult object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"AuthenticationResult":{"type":"object","properties":{"user":{"type":"object","properties":{"userId":{"type":"integer"},"userName":{"type":"string"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"accountId":{"type":"integer"},"omsId":{"type":"integer"},"use2FA":{"type":"boolean"}}},"authenticated":{"type":"boolean"},"locked":{"type":"boolean"},"requires2FA":{"type":"boolean"},"twoFAType":{"type":"string"},"twoFAToken":{"type":"string"}}}}}} ``` ## The OMSOrderData object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"OMSOrderData":{"type":"object","properties":{"Side":{"type":"string"},"OrderId":{"type":"integer"},"Price":{"type":"number"},"Quantity":{"type":"number"},"DisplayQuantity":{"type":"number"},"Instrument":{"type":"integer"},"Account":{"type":"integer"},"OrderType":{"type":"string"},"ClientOrderId":{"type":"integer"},"OrderState":{"type":"string"},"ReceiveTime":{"type":"integer"},"ReceiveTimeTicks":{"type":"integer"},"OrigQuantity":{"type":"number"},"QuantityExecuted":{"type":"number"},"AvgPrice":{"type":"number"},"CounterPartyId":{"type":"integer"},"ChangeReason":{"type":"string"},"OrigOrderId":{"type":"integer"},"OrigClOrdId":{"type":"integer"},"EnteredBy":{"type":"integer"},"IsQuote":{"type":"boolean"},"InsideAsk":{"type":"number"},"InsideAskSize":{"type":"number"},"InsideBid":{"type":"number"},"InsideBidSize":{"type":"number"},"LastTradePrice":{"type":"number"},"RejectReason":{"type":"string"},"IsLockedIn":{"type":"boolean"},"CancelReason":{"type":"string"},"OMSId":{"type":"integer"}}}}}} ``` ## The TicketComment object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"TicketComment":{"type":"object","properties":{"commentId":{"type":"integer"},"enteredBy":{"type":"integer"},"enteredDateTime":{"type":"string","format":"date-time"},"comment":{"type":"string"},"operatorId":{"type":"integer"},"omsId":{"type":"integer"},"ticketCode":{"type":"string"},"ticketId":{"type":"integer"}}}}}} ``` ## The TicketAttachment object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"TicketAttachment":{"type":"object","properties":{"attachmentId":{"type":"integer"},"submittedByUserId":{"type":"integer"},"submittedByUserName":{"type":"string"},"uploadDate":{"type":"string","format":"date-time"},"uploadIP":{"type":"string"},"ticketNumber":{"type":"integer"}}}}}} ``` ## The SendOrderRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"SendOrderRequest":{"type":"object","properties":{"InstrumentId":{"type":"integer"},"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"TimeInForce":{"type":"integer"},"ClientOrderId":{"type":"integer"},"OrderIdOCO":{"type":"integer"},"UseDisplayQuantity":{"type":"boolean"},"Side":{"type":"integer"},"quantity":{"type":"number"},"OrderType":{"type":"integer"},"PegPriceType":{"type":"integer"},"LimitPrice":{"type":"number"},"PostOnly":{"type":"boolean"}},"required":["InstrumentId","OMSId","AccountId","TimeInForce","ClientOrderId","Side","quantity","OrderType"]}}}} ``` ## The SendOrderResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"SendOrderResponse":{"type":"object","properties":{"status":{"type":"string"},"errormsg":{"type":"string"},"OrderId":{"type":"integer"}}}}}} ``` ## The CancelReplaceRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"CancelReplaceRequest":{"type":"object","properties":{"omsId":{"type":"integer"},"orderIdToReplace":{"type":"integer"},"clientOrdId":{"type":"integer"},"orderType":{"type":"integer"},"side":{"type":"integer"},"accountId":{"type":"integer"},"instrumentId":{"type":"integer"},"useDisplayQuantity":{"type":"boolean"},"displayQuantity":{"type":"number"},"limitPrice":{"type":"number"},"stopPrice":{"type":"number"},"referencePrice":{"type":"number"},"pegPriceType":{"type":"integer"},"timeInForce":{"type":"integer"},"orderIdOCO":{"type":"integer"},"quantity":{"type":"number"}},"required":["omsId","orderIdToReplace","clientOrdId","accountId","instrumentId","side","quantity"]}}}} ``` ## The CancelReplaceResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"CancelReplaceResponse":{"type":"object","properties":{"replacementOrderId":{"type":"integer"},"replacementClOrdId":{"type":"integer"},"origOrderId":{"type":"integer"},"origClOrdId":{"type":"integer"}}}}}} ``` ## The ModifyOrderRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"ModifyOrderRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"OrderId":{"type":"integer"},"InstrumentId":{"type":"integer"},"PreviousOrderRevision":{"type":"integer"},"Quantity":{"type":"number"},"AccountId":{"type":"integer"}},"required":["OMSId","OrderId","InstrumentId","PreviousOrderRevision","Quantity","AccountId"]}}}} ``` ## The CancelOrderRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"CancelOrderRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"OrderId":{"type":"integer"},"ClorderId":{"type":"integer"}},"required":["OMSId","AccountId"]}}}} ``` ## The CancelAllOrdersRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"CancelAllOrdersRequest":{"type":"object","properties":{"AccountId":{"type":"integer"},"OMSId":{"type":"integer"}},"required":["AccountId","OMSId"]}}}} ``` ## The GetOrderFeeRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetOrderFeeRequest":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"instrumentId":{"type":"integer"},"productId":{"type":"integer"},"amount":{"type":"number"},"price":{"type":"number"},"orderType":{"type":"integer"},"makerTaker":{"type":"integer"},"side":{"type":"integer"}},"required":["omsId","accountId","instrumentId","productId","amount","price","orderType","makerTaker","side"]}}}} ``` ## The GetOrderFeeResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetOrderFeeResponse":{"type":"object","properties":{"OrderFee":{"type":"number"},"ProductId":{"type":"integer"}},"required":["OrderFee","ProductId"]}}}} ``` ## The GetOrderStatusRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetOrderStatusRequest":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"orderId":{"type":"integer"}},"required":["omsId","accountId","orderId"]}}}} ``` ## The GetOrdersHistoryRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetOrdersHistoryRequest":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"OrderId":{"type":"integer"},"clientOrderId":{"type":"integer"},"originalOrderId":{"type":"integer"},"originalClientOrderId":{"type":"integer"},"userId":{"type":"integer"},"instrumentId":{"type":"integer"},"startTimestamp":{"type":"integer"},"endTimestamp":{"type":"integer"},"depth":{"type":"integer"},"startIndex":{"type":"integer"}},"required":["omsId","accountId","startTimestamp","endTimestamp"]}}}} ``` ## The GetTradesHistoryRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetTradesHistoryRequest":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"instrumentId":{"type":"integer"},"tradeId":{"type":"integer"},"orderId":{"type":"integer"},"userId":{"type":"integer"},"startTimestamp":{"type":"integer","format":"int64"},"endTimestamp":{"type":"integer","format":"int64"},"depth":{"type":"integer","default":100},"startIndex":{"type":"integer"},"executionId":{"type":"integer"}}}}}} ``` ## The Trade object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"Trade":{"type":"object","properties":{"omsId":{"type":"integer"},"executionId":{"type":"integer"},"tradeId":{"type":"integer"},"orderId":{"type":"integer"},"accountId":{"type":"integer"},"subAccountId":{"type":"integer"},"clientOrderId":{"type":"integer"},"instrumentId":{"type":"integer"},"side":{"type":"integer"},"quantity":{"type":"number"},"remainingQuantity":{"type":"number"},"price":{"type":"number"},"value":{"type":"number"},"tradeTime":{"type":"integer"},"counterParty":{"type":"string","nullable":true},"orderTradeRevision":{"type":"integer"},"direction":{"type":"integer"},"isBlockTrade":{"type":"boolean"},"tradeTimeMS":{"type":"integer"},"fee":{"type":"number"},"feeProductId":{"type":"integer"},"orderOriginator":{"type":"integer"}}}}}} ``` ## The GetPriceHistoryRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetPriceHistoryRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"InstrumentId":{"type":"integer"},"FromDate":{"type":"string","format":"date","description":"Optional. Start date (YYYY-MM-DD)"},"ToDate":{"type":"string","format":"date","description":"Optional. End date (YYYY-MM-DD)"}},"required":["OMSId","InstrumentId"]}}}} ``` ## The GetLastPricesRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetLastPricesRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"InstrumentId":{"type":"integer"},"Interval":{"type":"string","enum":["60000","3600000","86400000","604800000","2592000000","31536000000"],"description":"Interval in milliseconds"}},"required":["OMSId","InstrumentId","Interval"]}}}} ``` ## The GetLastTradesRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetLastTradesRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"InstrumentId":{"type":"integer"},"Count":{"type":"integer"}},"required":["OMSId","InstrumentId","Count"]}}}} ``` ## The GetTransferRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetTransferRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"TransferId":{"type":"integer"}},"required":["OMSId","AccountId","TransferId"]}}}} ``` ## The Transfer object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"Transfer":{"type":"object","properties":{"transferId":{"type":"integer"},"senderAccountId":{"type":"integer"},"senderUserName":{"type":"string","nullable":true},"receiverAccountId":{"type":"integer"},"receiverUserName":{"type":"string","nullable":true},"productId":{"type":"integer"},"amount":{"type":"number"},"notes":{"type":"string","nullable":true},"omsId":{"type":"integer"}}}}}} ``` ## The GetTransfersReceivedRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetTransfersReceivedRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"Limit":{"type":"integer"},"StartIndex":{"type":"integer"}},"required":["OMSId","AccountId"]}}}} ``` ## The GetTransfersHistoryRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetTransfersHistoryRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"ProductId":{"type":"integer"},"TransferState":{"type":"string","nullable":true},"Limit":{"type":"integer"},"StartIndex":{"type":"integer"}},"required":["OMSId","AccountId"]}}}} ``` ## The TransferFundsRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"TransferFundsRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"SenderAccountId":{"type":"integer"},"ReceiverAccountId":{"type":"integer"},"ProductId":{"type":"integer"},"Amount":{"type":"number"},"Notes":{"type":"string"},"ReceiverUserName":{"type":"string"},"UniqueClientTransactionId":{"type":"string"}},"required":["OMSId","SenderAccountId","ReceiverAccountId","ProductId","Amount"]}}}} ``` ## The TransferFundsResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"TransferFundsResponse":{"type":"object","properties":{"result":{"type":"boolean"},"errormsg":{"type":"string"},"errorcode":{"type":"integer"},"detail":{"type":"string"}}}}}} ``` ## The GetWithdrawFeeRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetWithdrawFeeRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"ProductId":{"type":"integer"},"Amount":{"type":"number","format":"float"},"AccountProviderId":{"type":"integer","required":["OMSId","AccountId","ProductId","Amount","AccountProviderId"]}}}}}} ``` ## The GetWithdrawFeeResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetWithdrawFeeResponse":{"type":"object","properties":{"FeeAmount":{"type":"number","format":"float"},"TicketAmount":{"type":"number","format":"float"}}}}}} ``` ## The GenerateTradeActivityRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GenerateTradeActivityRequest":{"$ref":"#/components/schemas/OnDemandCannedReportRequest"},"OnDemandCannedReportRequest":{"type":"object","properties":{"accountIdList":{"type":"array","items":{"type":"integer"}},"omsId":{"type":"integer"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}},"required":["accountIdList","omsId","startTime","endTime"]}}}} ``` ## The GenerateTradeActivityResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GenerateTradeActivityResponse":{"$ref":"#/components/schemas/UserReportTicket"},"UserReportTicket":{"type":"object","properties":{"RequestingUser":{"type":"integer"},"OMSId":{"type":"integer"},"reportFlavor":{"type":"string"},"createTime":{"type":"string","format":"date-time"},"initialRunTime":{"type":"string","format":"date-time"},"intervalStartTime":{"type":"string","format":"date-time"},"intervalEndTime":{"type":"string","format":"date-time"},"RequestStatus":{"type":"string"},"ReportFrequency":{"type":"string"},"intervalDuration":{"type":"integer"},"RequestId":{"type":"string"},"lastInstanceId":{"type":"string"},"accountIds":{"type":"array"},"items":{"type":"integer"}}}}}} ``` ## The GetOrdersRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetOrdersRequest":{"$ref":"#/components/schemas/GetOrdersHistoryRequest"},"GetOrdersHistoryRequest":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"OrderId":{"type":"integer"},"clientOrderId":{"type":"integer"},"originalOrderId":{"type":"integer"},"originalClientOrderId":{"type":"integer"},"userId":{"type":"integer"},"instrumentId":{"type":"integer"},"startTimestamp":{"type":"integer"},"endTimestamp":{"type":"integer"},"depth":{"type":"integer"},"startIndex":{"type":"integer"}},"required":["omsId","accountId","startTimestamp","endTimestamp"]}}}} ``` ## The GetTransfersRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetTransfersRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"Limit":{"type":"integer"},"StartIndex":{"type":"integer"}},"required":["OMSId","AccountId"]}}}} ``` ## The CancelTransferFundsRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"CancelTransferFundsRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"TransferId":{"type":"integer"}},"required":["OMSId","AccountId","TransferId"]}}}} ``` ## The RequestTransferFundsRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"RequestTransferFundsRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"ProductId":{"type":"integer"},"ReceiverAccountId":{"type":"integer"},"Amount":{"type":"number"},"Notes":{"type":"string"},"ReceiverUserName":{"type":"string"},"SenderUserName":{"type":"string"}},"required":["OMSId","ProductId","ReceiverAccountId","Amount"]}}}} ``` ## The RequestTransferFundsResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"RequestTransferFundsResponse":{"type":"object","properties":{"result":{"type":"boolean"},"requestcode":{"type":"string"}}}}}} ``` ## The GetLevel1SummaryRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetLevel1SummaryRequest":{"type":"object","properties":{"OMSId":{"type":"integer","required":["OMSId"]}}}}}} ``` ## The Level1MarketData object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"Level1MarketData":{"type":"object","properties":{"exchangeId":{"type":"integer"},"productPairCode":{"type":"string"},"bestBid":{"type":"number","format":"float"},"bestOffer":{"type":"number","format":"float"},"volume":{"type":"number","format":"float"},"lastTradedPx":{"type":"number","format":"float"},"lastTradedVolume":{"type":"number","format":"float"},"lastTradeTime":{"type":"integer"},"timeStamp":{"type":"integer"},"bidQty":{"type":"number","format":"float"},"askQty":{"type":"number","format":"float"},"bidOrderCt":{"type":"integer"},"askOrderCt":{"type":"integer"},"sessionOpen":{"type":"number","format":"float"},"sessionHigh":{"type":"number","format":"float"},"sessionLow":{"type":"number","format":"float"},"sessionClose":{"type":"number","format":"float"},"currentDayVolume":{"type":"number","format":"float"},"currentDayNumTrades":{"type":"number","format":"float"},"currentDayPxChange":{"type":"number","format":"float"},"rolling24HrVolume":{"type":"number","format":"float"},"rolling24NumTrades":{"type":"number","format":"float"},"rolling24HrPxChange":{"type":"number","format":"float"},"rolling24HrPxChangePercent":{"type":"number","format":"float"}}}}}} ``` ## The GetLevel1SummaryMinRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetLevel1SummaryMinRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"BaseCurrency":{"type":"string"},"QuoteCurrency":{"type":"string"},"InstrumentIds":{"type":"array","items":{"type":"integer"},"required":["OMSId"]}}}}}} ``` ## The GetOrdersRequest-2 object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetOrdersRequest-2":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"clientOrderId":{"type":"integer"},"originalOrderId":{"type":"integer"},"originalClientOrderId":{"type":"integer"},"userId":{"type":"integer"},"instrumentId":{"type":"integer"},"startTimestamp":{"type":"integer","description":"POSIX timestamp in milliseconds"},"endTimestamp":{"type":"integer","description":"POSIX timestamp in milliseconds"},"depth":{"type":"integer","default":100},"startIndex":{"type":"integer"}},"required":["omsId","accountId","startTimestamp","endTimestamp","depth","startIndex"]}}}} ``` ## The GetAccountDepositTransactionsRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetAccountDepositTransactionsRequest":{"type":"object","properties":{"OMSId":{"type":"integer"},"AccountId":{"type":"integer"},"Depth":{"type":"integer"}},"required":["OMSId","AccountId"]}}}} ``` ## The GetAccountDepositTransactionsResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetAccountDepositTransactionsResponse":{"type":"object","properties":{"transactionId":{"type":"integer"},"omsId":{"type":"integer"},"accountId":{"type":"integer"},"cr":{"type":"number"},"dr":{"type":"number"},"counterparty":{"type":"integer"},"transactionType":{"type":"integer"},"referenceId":{"type":"integer"},"referenceType":{"type":"integer"},"productId":{"type":"integer"},"balance":{"type":"number"},"timeStamp":{"type":"integer"}}}}}} ``` ## The GetAccountTransactionsRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetAccountTransactionsRequest":{"type":"object","properties":{"startIndex":{"type":"integer"},"depth":{"type":"integer"},"transactionId":{"type":"integer"},"referenceId":{"type":"integer"},"omsId":{"type":"integer"},"accountId":{"type":"integer"},"counterParty":{"type":"integer"},"productId":{"type":"integer"},"userId":{"type":"integer"},"startTimestamp":{"type":"integer"},"endTimestamp":{"type":"integer"},"transactionTypes":{"type":"array","items":{"type":"integer"}},"transactionReferenceTypes":{"type":"array","items":{"type":"integer"}}},"required":["omsId","accountId"]}}}} ``` ## The GetAccountTransactionsResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetAccountTransactionsResponse":{"type":"object","properties":{"transactionId":{"type":"integer"},"omsId":{"type":"integer"},"accountId":{"type":"integer"},"cr":{"type":"number"},"dr":{"type":"number"},"counterparty":{"type":"integer"},"transactionType":{"type":"integer"},"referenceId":{"type":"integer"},"referenceType":{"type":"integer"},"productId":{"type":"integer"},"balance":{"type":"number"},"timeStamp":{"type":"integer"}},"required":["transactionId","omsId","accountId","cr","dr","counterparty","transactionType","productId","balance","timeStamp"]}}}} ``` ## The GetAccountPositionsResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetAccountPositionsResponse":{"type":"object","properties":{"omsId":{"type":"integer"},"accountId":{"type":"integer"},"productSymbol":{"type":"string"},"productId":{"type":"integer"},"amount":{"type":"number","format":"float"},"hold":{"type":"number","format":"float"},"pendingDeposits":{"type":"number","format":"float"},"pendingWithdraws":{"type":"number","format":"float"},"totalDayDeposits":{"type":"number","format":"float"},"totalMonthDeposits":{"type":"number","format":"float"},"totalYearDeposits":{"type":"number","format":"float"},"totalYearDepositNotional":{"type":"number","format":"float"},"totalDayWithdraws":{"type":"number","format":"float"},"totalMonthWithdraws":{"type":"number","format":"float"},"totalYearWithdraws":{"type":"number","format":"float"},"totalYearWithdrawNotional":{"type":"number","format":"float"}},"required":["omsId","accountId","productId","productSymbol"]}}}} ``` ## The GetAccountTradesResponse object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"GetAccountTradesResponse":{"type":"object","properties":{"omsId":{"type":"integer"},"executionId":{"type":"integer"},"tradeId":{"type":"integer"},"orderId":{"type":"integer"},"accountId":{"type":"integer"},"subAccountId":{"type":"integer"},"clientOrderId":{"type":"integer"},"instrumentId":{"type":"integer"},"side":{"type":"integer"},"quantity":{"type":"number","format":"float"},"remainingQuantity":{"type":"number","format":"float"},"price":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"tradeTime":{"type":"integer","description":"POSIX timestamp in milliseconds"},"counterParty":{"type":"string","nullable":true},"orderTradeRevision":{"type":"integer"},"direction":{"type":"integer"},"isBlockTrade":{"type":"boolean"},"tradeTimeMS":{"type":"integer"},"fee":{"type":"number","format":"float"},"feeProductId":{"type":"integer"},"orderOriginator":{"type":"integer"}},"required":["omsId","executionId","tradeId","orderId","accountId","instrumentId"]}}}} ``` ## The OnDemandCannedReportRequest object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"OnDemandCannedReportRequest":{"type":"object","properties":{"accountIdList":{"type":"array","items":{"type":"integer"}},"omsId":{"type":"integer"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}},"required":["accountIdList","omsId","startTime","endTime"]}}}} ``` ## The UserReportTicket object ```json {"openapi":"3.0.3","info":{"title":"Trading API","version":"1.0.0"},"components":{"schemas":{"UserReportTicket":{"type":"object","properties":{"RequestingUser":{"type":"integer"},"OMSId":{"type":"integer"},"reportFlavor":{"type":"string"},"createTime":{"type":"string","format":"date-time"},"initialRunTime":{"type":"string","format":"date-time"},"intervalStartTime":{"type":"string","format":"date-time"},"intervalEndTime":{"type":"string","format":"date-time"},"RequestStatus":{"type":"string"},"ReportFrequency":{"type":"string"},"intervalDuration":{"type":"integer"},"RequestId":{"type":"string"},"lastInstanceId":{"type":"string"},"accountIds":{"type":"array"},"items":{"type":"integer"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.kiiglobal.io/docs/connect-to-kiiex/kiiex-apis/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.