{ "openapi": "3.0.4", "info": { "title": "SS&C Eze EMS XAPI", "version": "v2026.5.0" }, "paths": { "/api/v1/security/daily-weekly-monthly-bars": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Interim.BarIntervalOption", "in": "query", "schema": { "$ref": "#/components/schemas/IntervalTypesOptions" } }, { "name": "StopDate", "in": "query", "schema": { "type": "string" } }, { "name": "DaysBack", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "RequestId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailyWeeklyMonthlyBarsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/intraday-bars": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "BarInterval", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DaysBack", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "StartAtMidnight", "in": "query", "schema": { "type": "boolean" } }, { "name": "Date", "in": "query", "schema": { "type": "string" } }, { "name": "StartTime", "in": "query", "schema": { "type": "string" } }, { "name": "StopTime", "in": "query", "schema": { "type": "string" } }, { "name": "requestId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ShowPrePostMarket", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntradayBarsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/option-chain-for-underlier": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "SymbolRoot", "in": "query", "schema": { "type": "string" } }, { "name": "RequestId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionChainResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/symbol-reference-data": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SymbolReferenceDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/tick-data": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Date", "in": "query", "schema": { "type": "string" } }, { "name": "StartTime", "in": "query", "schema": { "type": "string" } }, { "name": "StopTime", "in": "query", "schema": { "type": "string" } }, { "name": "RequestId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TickDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/options-and-greek-data": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsAndGreekDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/security-data": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/option-symbol-from-description": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Root", "in": "query", "schema": { "type": "string" } }, { "name": "Expiration", "in": "query", "schema": { "type": "string" } }, { "name": "OptionType.CallOrPut", "in": "query", "schema": { "$ref": "#/components/schemas/OptionTypesTypesOptions" } }, { "name": "StrikePrice", "in": "query", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSymbolFromDescriptionResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/description-from-option-symbol": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptionFromOptionSymbolResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/subscribe-symbols": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RegionalExchangeIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Request", "in": "query", "schema": { "type": "boolean" } }, { "name": "Advise", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Level1MarketDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeLevel1DataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/subscribe-symbols-level2": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RequestId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MarketSource", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Request", "in": "query", "schema": { "type": "boolean" } }, { "name": "Advise", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Level2MarketDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeLevel2DataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/symbols": { "post": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MarketDataLevel", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSymbolsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MarketDataLevel", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveSymbolsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/security/symbols": { "post": { "tags": [ "MarketDataService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSymbolsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSymbolsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/symbols-from-company-name": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "CompanyName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SymbolsFromCompanyNameResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/symbol-from-alternate-symbology": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "SymbolInfo.SymbolOption", "in": "query", "schema": { "$ref": "#/components/schemas/AlternateSymbologyTypesSymbology" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SymbolFromAlternateSymbologyResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/level1-market-data": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RegionalExchangeIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "FieldSelection.RequestedFields", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Level1FieldOptionsTypesFields" } } }, { "name": "FieldSelection.RequestedExtendedFields", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Level1MarketDataRecordResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/subscribe-tick-data": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Request", "in": "query", "schema": { "type": "boolean" } }, { "name": "Date", "in": "query", "schema": { "type": "string" } }, { "name": "StartTime", "in": "query", "schema": { "type": "string" } }, { "name": "StopTime", "in": "query", "schema": { "type": "string" } }, { "name": "RequestId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeTickDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeTickDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/security/subscribe-intraday-bars": { "get": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "Symbols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "BarInterval", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "StartAtMidnight", "in": "query", "schema": { "type": "boolean" } }, { "name": "ShowPrePostMarket", "in": "query", "schema": { "type": "boolean" } }, { "name": "DaysBack", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "RequestId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "EmitPartialBars", "in": "query", "schema": { "type": "boolean" } }, { "name": "PartialIntervalSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SinceTimestamp", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeIntradayBarsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "MarketDataService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeIntradayBarsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Side", "in": "query", "schema": { "type": "string" } }, { "name": "Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Route", "in": "query", "schema": { "type": "string" } }, { "name": "Account", "in": "query", "schema": { "type": "string" } }, { "name": "OrderTag", "in": "query", "schema": { "type": "string" } }, { "name": "TicketId", "in": "query", "schema": { "type": "string" } }, { "name": "Staged", "in": "query", "schema": { "type": "boolean" } }, { "name": "ClaimRequire", "in": "query", "schema": { "type": "boolean" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "GoodFrom", "in": "query", "schema": { "type": "string" } }, { "name": "TimeInForce.Expiration", "in": "query", "schema": { "$ref": "#/components/schemas/ExpirationTypeTypesExpirationTypes" } }, { "name": "PriceType.PriceType", "in": "query", "schema": { "$ref": "#/components/schemas/PriceTypeEnumTypesPriceTypesEnum" } }, { "name": "Price", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "StopPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "UserMessage", "in": "query", "schema": { "type": "string" } }, { "name": "ExpirationDate", "in": "query", "schema": { "type": "string" } }, { "name": "ReturnResult", "in": "query", "schema": { "type": "boolean" } }, { "name": "ReturnResultTimeOutInMs", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSingleOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "put": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "GoodFrom", "in": "query", "schema": { "type": "string" } }, { "name": "TimeInForce.Expiration", "in": "query", "schema": { "$ref": "#/components/schemas/ExpirationTypeTypesExpirationTypes" } }, { "name": "PriceType.PriceType", "in": "query", "schema": { "$ref": "#/components/schemas/PriceTypeEnumTypesPriceTypesEnum" } }, { "name": "Price", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "StopPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "UserMessage", "in": "query", "schema": { "type": "string" } }, { "name": "ExpirationDate", "in": "query", "schema": { "type": "string" } }, { "name": "OrderTag", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeSingleOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSingleOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/order": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSingleOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSingleOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "put": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeSingleOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeSingleOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/book-trade": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "SourceAccount", "in": "query", "schema": { "type": "string" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "OrderTag", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitBookTradeResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/order/book-trade": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitBookTradeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitBookTradeResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/pair-order": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "Leg1Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Leg1Side", "in": "query", "schema": { "type": "string" } }, { "name": "Leg1Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Route", "in": "query", "schema": { "type": "string" } }, { "name": "Leg2Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Leg2Side", "in": "query", "schema": { "type": "string" } }, { "name": "Leg2Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Staged", "in": "query", "schema": { "type": "boolean" } }, { "name": "ClaimRequire", "in": "query", "schema": { "type": "boolean" } }, { "name": "Account", "in": "query", "schema": { "type": "string" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "OrderTag", "in": "query", "schema": { "type": "string" } }, { "name": "TicketId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPairOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "put": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "PairOrderId", "in": "query", "schema": { "type": "string" } }, { "name": "Leg1OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "Leg2OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "Leg1Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Leg2Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePairOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPairOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/order/pair-order": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPairOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitPairOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "put": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePairOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePairOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/seed-data": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "Account", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSeedDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/order/seed-data": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSeedDataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSeedDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/user-accounts": { "get": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccountsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/orders": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/orders": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/subscribe": { "get": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "Level", "in": "query", "schema": { "$ref": "#/components/schemas/SubscribeOrderInfoRequestTypesSubscriptionLevel" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeUserSubmitOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitStagedOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitCompoundOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeForeignExecution", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitChange", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitCancel", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeExchangeAcceptOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeExchangeTradeOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitTradeReport", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitAllocation", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitAllocationEx", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeClerkReject", "in": "query", "schema": { "type": "boolean" } }, { "name": "ExcludeHistory", "in": "query", "schema": { "type": "boolean" } }, { "name": "FieldSelection.RequestedFields", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribeOrderFieldOptionsTypesFields" } } }, { "name": "FieldSelection.RequestedExtendedFields", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeOrderInfoResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/allocation-order": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "OrderId", "in": "query", "schema": { "type": "string" } }, { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Exchange", "in": "query", "schema": { "type": "string" } }, { "name": "SourceAccount", "in": "query", "schema": { "type": "string" } }, { "name": "TargetAccount", "in": "query", "schema": { "type": "string" } }, { "name": "TargetQuantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "TargetPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TypeOfAllocation.AllocationOrAllocationEx", "in": "query", "schema": { "$ref": "#/components/schemas/AllocationTypeTypesAllocation" } }, { "name": "OrderTypes.TypeOfOrder", "in": "query", "schema": { "$ref": "#/components/schemas/OrderTypeTypesType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAllocationOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/order/allocation-order": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAllocationOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAllocationOrderResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/trade-report": { "post": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "Symbol", "in": "query", "schema": { "type": "string" } }, { "name": "Side", "in": "query", "schema": { "type": "string" } }, { "name": "Quantity", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Account", "in": "query", "schema": { "type": "string" } }, { "name": "OrderType.OrderTypes", "in": "query", "schema": { "$ref": "#/components/schemas/TradeTypeTypesTypeofOrder" } }, { "name": "Route", "in": "query", "schema": { "type": "string" } }, { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTradeReportResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v2/order/trade-report": { "post": { "tags": [ "SubmitOrderService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTradeReportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTradeReportResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/get-order-detail-by-date-range": { "get": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "schema": { "type": "string" } }, { "name": "StartTime", "in": "query", "schema": { "type": "string" } }, { "name": "EndDate", "in": "query", "schema": { "type": "string" } }, { "name": "EndTime", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Account", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailByDateRangeResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/order-detail-by-order-id": { "get": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "OrderId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailByOrderIdResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/order/order-detail-by-order-tag": { "get": { "tags": [ "SubmitOrderService" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "OrderTags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "OrderEventType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailByOrderTagResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/user/user-permissions": { "get": { "tags": [ "UserServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserPermissionsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/todays-balances": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodaysBalancesResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/todays-activity": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeUserSubmitOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitStagedOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitCompoundOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeForeignExecution", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitChange", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitCancel", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeExchangeAcceptOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeExchangeTradeOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitTradeReport", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitAllocation", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUserSubmitAllocationEx", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeClerkReject", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeOnlyCompleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "UserSubmitStagedOrderFullInfo", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodaysActivityResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/todays-breakdown-positions": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "BBCDFilter", "in": "query", "schema": { "type": "string" } }, { "name": "TickerFilter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodaysBrokenDownPositionsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/todays-net-positions": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodaysNetPositionsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/todays-net-positions/subscribe": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeNetPositionsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } }, "delete": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeNetPositionsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/connect": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "Password", "in": "query", "schema": { "type": "string" } }, { "name": "Locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/heartbeat-subscribe": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeHeartBeatResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/disconnect": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "TimeoutInSeconds", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisconnectResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/start-login-srp": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartLoginSrpResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/complete-login-srp": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "Identity", "in": "query", "schema": { "type": "string" } }, { "name": "srpTransactId", "in": "query", "schema": { "type": "string" } }, { "name": "strEphA", "in": "query", "schema": { "type": "string" } }, { "name": "strMc", "in": "query", "schema": { "type": "string" } }, { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "Locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteLoginSrpResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/multi-factor-authentication": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "VerificationCode", "in": "query", "schema": { "type": "string" } }, { "name": "MFASecurityCode", "in": "query", "schema": { "type": "string" } }, { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "Locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiFactorAuthenticationResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/change-password-srp": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "TransactId", "in": "query", "schema": { "type": "string" } }, { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "OldPassword", "in": "query", "schema": { "type": "string" } }, { "name": "NewPassword", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordSRPResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/authentication/change-password": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "OldPassword", "in": "query", "schema": { "type": "string" } }, { "name": "NewPassword", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/strategy-list": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "FirmName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StrategyListResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/firm-name": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFirmNameResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/user-exists": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "FirmName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExistsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/strategy-data": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "FirmName", "in": "query", "schema": { "type": "string" } }, { "name": "AlgoName", "in": "query", "schema": { "type": "string" } }, { "name": "StrategyName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStrategyDataResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/create-strategy": { "post": { "tags": [ "UtilityServices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStrategyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStrategyResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/update-strategy": { "put": { "tags": [ "UtilityServices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStrategyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStrategyResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/user-routes": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "AccountList", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserRoutesResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/api/v1/utility/user-route-props": { "get": { "tags": [ "UtilityServices" ], "parameters": [ { "name": "UserToken", "in": "query", "schema": { "type": "string" } }, { "name": "FilterRoutesList", "in": "query", "schema": { "type": "string" } }, { "name": "FilterRoutePropsList", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserRoutePropsResponse" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Google.Rpc.Status" } } } } } } }, "/health": { "get": { "tags": [ "XAPIServer" ], "responses": { "200": { "description": "OK" } } } }, "/ready": { "get": { "tags": [ "XAPIServer" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AddSymbolsRequest": { "type": "object", "properties": { "UserToken": { "type": "string" }, "Symbols": { "type": "array", "items": { "type": "string" } }, "MarketDataLevel": { "type": "string" } }, "additionalProperties": false }, "AddSymbolsResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "AggregatePositionRecord": { "type": "object", "properties": { "SoldShortQty": { "type": "number", "format": "double" }, "SoldQty": { "type": "number", "format": "double" }, "BoughtAvgPrc": { "type": "number", "format": "double" }, "BoughtQty": { "type": "number", "format": "double" }, "IntradayShortAvgPrc": { "type": "number", "format": "double" }, "IntradayShortPos": { "type": "number", "format": "double" }, "ShortAvgPrc": { "type": "number", "format": "double" }, "ShortPos": { "type": "number", "format": "double" }, "IntradayLongAvgPrc": { "type": "number", "format": "double" }, "IntradayLongPos": { "type": "number", "format": "double" }, "LongAvgPrc": { "type": "number", "format": "double" }, "LongPos": { "type": "number", "format": "double" }, "IntradayAvgPrc": { "type": "number", "format": "double" }, "IntradayPos": { "type": "number", "format": "double" }, "TotalAvgPrc": { "type": "number", "format": "double" }, "TotalPos": { "type": "number", "format": "double" }, "SoldAvgPrc": { "type": "number", "format": "double" }, "SoldShortAvgPrc": { "type": "number", "format": "double" }, "DispName": { "type": "string" }, "Deposit": { "type": "string" }, "Customer": { "type": "string" }, "Branch": { "type": "string" }, "Bank": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "AllocationDetails": { "type": "object", "properties": { "TargetAccount": { "type": "string" }, "TargetQuantity": { "type": "integer", "format": "int32" }, "TargetPrice": { "type": "number", "format": "double" }, "AllocationDestinationRoute": { "type": "string" }, "CommissionRate": { "type": "number", "format": "double" }, "CommissionRateType": { "type": "integer", "format": "int32" }, "NetPrice": { "type": "number", "format": "double" }, "GeneralMessage": { "type": "string" } }, "additionalProperties": false }, "AllocationType": { "type": "object", "properties": { "AllocationOrAllocationEx": { "$ref": "#/components/schemas/AllocationTypeTypesAllocation" } }, "additionalProperties": false }, "AllocationTypeTypesAllocation": { "enum": [ "UserSubmitAllocation", "UserSubmitAllocationEx" ], "type": "string" }, "AlternateSymbologyTypesSymbology": { "enum": [ "ISIN", "SEDOL", "RIC", "CUSIP", "BBG" ], "type": "string" }, "BarUpdateKind": { "enum": [ "BAR_KIND_UNSPECIFIED", "BAR_KIND_HISTORICAL", "BAR_KIND_PARTIAL", "BAR_KIND_CLOSED" ], "type": "string" }, "BasketOrderRequest": { "type": "object", "properties": { "UserToken": { "type": "string" }, "Orders": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRow" } } }, "additionalProperties": false }, "BasketOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "CancelPairOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "CancelSingleOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "ChangePairOrderRequest": { "type": "object", "properties": { "PairOrderId": { "type": "string" }, "Leg1OrderId": { "type": "string" }, "Leg2OrderId": { "type": "string" }, "Leg1Quantity": { "type": "integer", "format": "int32" }, "Leg2Quantity": { "type": "integer", "format": "int32" }, "Leg1ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Leg2ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "UserToken": { "type": "string" } }, "additionalProperties": false }, "ChangePairOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "ChangePasswordResponse": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "ChangePasswordSRPResponse": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "ChangeSingleOrderRequest": { "type": "object", "properties": { "OrderId": { "type": "string" }, "Quantity": { "type": "integer", "format": "int32" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "UserToken": { "type": "string" }, "GoodFrom": { "type": "string" }, "TimeInForce": { "$ref": "#/components/schemas/ExpirationType" }, "PriceType": { "$ref": "#/components/schemas/PriceTypeEnum" }, "Price": { "type": "number", "format": "double" }, "StopPrice": { "type": "number", "format": "double" }, "UserMessage": { "type": "string" }, "ExpirationDate": { "type": "string" }, "OrderTag": { "type": "string" } }, "additionalProperties": false }, "ChangeSingleOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "CommonBarsFields": { "type": "object", "properties": { "AcVol1": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "Count": { "type": "integer", "format": "int32" }, "High1": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "Low1": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "OpenPrc": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "Settle": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "TrdDate": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CompleteLoginSrpResponse": { "type": "object", "properties": { "UserToken": { "type": "string" }, "Response": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "ConnectResponse": { "type": "object", "properties": { "UserToken": { "type": "string" }, "Response": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "DPermStatusCode": { "type": "string" }, "MFASecurityCode": { "type": "string" }, "MFAtotpPreference": { "type": "string" }, "MFAtotpValue": { "type": "string" } }, "additionalProperties": false }, "CreateStrategyRequest": { "type": "object", "properties": { "UserToken": { "type": "string" }, "FirmName": { "type": "string" }, "AlgoName": { "type": "string" }, "StrategyName": { "type": "string" }, "StratParams": { "type": "string" } }, "additionalProperties": false }, "CreateStrategyResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "DailyWeeklyMonthlyBarsResponse": { "type": "object", "properties": { "BarFields": { "$ref": "#/components/schemas/CommonBarsFields" }, "DispName": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "DepositRow": { "type": "object", "properties": { "Mmr0Adj": { "type": "number", "format": "double" }, "Sma0": { "type": "number", "format": "double" }, "Sma0Adj": { "type": "number", "format": "double" }, "HouseExcess0": { "type": "number", "format": "double" }, "Orq0": { "type": "number", "format": "double" }, "Cost": { "type": "number", "format": "double" }, "Mmr0NonDaytradeAdj": { "type": "number", "format": "double" }, "SrvPendingMargin": { "type": "number", "format": "double" }, "Commission": { "type": "number", "format": "double" }, "NetFees": { "type": "number", "format": "double" }, "HistScalpedProfit": { "type": "number", "format": "double" }, "CashBalanceAdj": { "type": "number", "format": "double" }, "ScalpedProfit": { "type": "number", "format": "double" }, "Mmr": { "type": "number", "format": "double" }, "Mmr0": { "type": "number", "format": "double" }, "Marketvalue0": { "type": "number", "format": "double" }, "CashBalance": { "type": "number", "format": "double" }, "EquityBalance": { "type": "number", "format": "double" }, "ExtraCbp": { "type": "number", "format": "double" }, "MinBalance": { "type": "number", "format": "double" }, "MaxOrderSize": { "type": "number", "format": "double" }, "ExcessEq0": { "type": "number", "format": "double" }, "ExcessEq": { "type": "number", "format": "double" }, "PendingMargin": { "type": "number", "format": "double" }, "CbpRemaining": { "type": "number", "format": "double" }, "CalcTime": { "type": "string" }, "Table": { "type": "string" }, "Bank": { "type": "string" }, "Branch": { "type": "string" }, "Customer": { "type": "string" }, "Deposit": { "type": "string" }, "Currency": { "type": "string" }, "TboAccountId": { "type": "integer", "format": "int32" }, "DaysBack": { "type": "integer", "format": "int32" }, "Rank": { "type": "integer", "format": "int32" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "DescriptionFromOptionSymbolResponse": { "type": "object", "properties": { "Root": { "type": "string" }, "Expiration": { "type": "string" }, "OptionType": { "$ref": "#/components/schemas/OptionTypes" }, "StrikePrice": { "type": "number", "format": "double" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "DisconnectResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "ExpirationType": { "type": "object", "properties": { "Expiration": { "$ref": "#/components/schemas/ExpirationTypeTypesExpirationTypes" } }, "additionalProperties": false }, "ExpirationTypeTypesExpirationTypes": { "enum": [ "DAY", "GTC", "GTX", "CLO", "OPG", "IOC", "GTD", "OTHER" ], "type": "string" }, "GetFirmNameResponse": { "type": "object", "properties": { "FirmName": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "GetStrategyDataResponse": { "type": "object", "properties": { "StrategyData": { "$ref": "#/components/schemas/StrategyDataRow" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "GetUserPermissionsResponse": { "type": "object", "properties": { "Permissions": { "type": "array", "items": { "$ref": "#/components/schemas/UserPermissionRecord" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "GetUserRoutePropsResponse": { "type": "object", "properties": { "UserRouteProps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RoutePropsMap" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "GetUserRoutesResponse": { "type": "object", "properties": { "UserRoutes": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Any": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" } }, "Google.Protobuf.WellKnownTypes.ListValue": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.NullValue": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "Google.Protobuf.WellKnownTypes.Struct": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Value" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.Value": { "type": "object", "properties": { "nullValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.NullValue" }, "hasNullValue": { "type": "boolean", "readOnly": true }, "numberValue": { "type": "number", "format": "double" }, "hasNumberValue": { "type": "boolean", "readOnly": true }, "stringValue": { "type": "string", "nullable": true }, "hasStringValue": { "type": "boolean", "readOnly": true }, "boolValue": { "type": "boolean" }, "hasBoolValue": { "type": "boolean", "readOnly": true }, "structValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Struct" }, "listValue": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.ListValue" }, "kindCase": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.ValueKindOneofCase" } }, "additionalProperties": false }, "Google.Protobuf.WellKnownTypes.ValueKindOneofCase": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Google.Rpc.Status": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Google.Protobuf.WellKnownTypes.Any" } } }, "additionalProperties": false }, "IntervalTypesOptions": { "enum": [ "DAILY", "WEEKLY", "MONTHLY" ], "type": "string" }, "IntradayBarUpdate": { "type": "object", "properties": { "OpenTime": { "type": "string" }, "TrdTim1": { "type": "string" }, "OpenPrc": { "$ref": "#/components/schemas/Price" }, "High1": { "$ref": "#/components/schemas/Price" }, "Low1": { "$ref": "#/components/schemas/Price" }, "Settle": { "$ref": "#/components/schemas/Price" }, "AcVol1": { "type": "integer", "format": "int32" }, "TickCount": { "type": "integer", "format": "int32" }, "Vwap": { "type": "number", "format": "double" }, "Kind": { "$ref": "#/components/schemas/BarUpdateKind" }, "Symbol": { "type": "string" } }, "additionalProperties": false }, "IntradayBarsResponse": { "type": "object", "properties": { "Bars": { "$ref": "#/components/schemas/CommonBarsFields" }, "TrdTim1": { "type": "array", "items": { "type": "string" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "Level1FieldOptionsTypesFields": { "enum": [ "DISP_NAME", "TRDPRC1", "TRDTIM1", "SYMBOL_DESC", "COMPANY_NAME", "ARCA_IMBALANCE_VOLUME", "ARCA_MATCH_VOLUME", "SALE_CONDITION_VOLUME", "INTRADAY_HIGH_COUNT", "VWAP_VOL", "VWAP", "BID", "ASK", "CHANGE_LAST", "HIGH1", "HIGH52", "LOW1", "LOW52", "EXTENDED_FIELDS" ], "type": "string" }, "Level1MarketDataRecord": { "type": "object", "properties": { "DispName": { "type": "string" }, "Trdprc1": { "$ref": "#/components/schemas/Price" }, "Trdtim1": { "type": "string" }, "SymbolDesc": { "type": "string" }, "CompanyName": { "type": "string" }, "ArcaImbalanceVolume": { "type": "integer", "format": "int32" }, "ArcaMatchVolume": { "type": "integer", "format": "int32" }, "SaleConditionVolume": { "type": "integer", "format": "int32" }, "IntradayHighCount": { "type": "integer", "format": "int32" }, "VwapVol": { "type": "integer", "format": "int32" }, "Vwap": { "type": "number", "format": "double" }, "Bid": { "$ref": "#/components/schemas/Price" }, "Ask": { "$ref": "#/components/schemas/Price" }, "ChangeLast": { "$ref": "#/components/schemas/Price" }, "High1": { "$ref": "#/components/schemas/Price" }, "High52": { "$ref": "#/components/schemas/Price" }, "Low1": { "$ref": "#/components/schemas/Price" }, "Low52": { "$ref": "#/components/schemas/Price" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "Level1MarketDataRecordResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "DataRecord": { "type": "array", "items": { "$ref": "#/components/schemas/Level1MarketDataRecord" } } }, "additionalProperties": false }, "Level1MarketDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "DispName": { "type": "string" }, "Trdprc1": { "$ref": "#/components/schemas/Price" }, "Trdtim1": { "type": "string" }, "SymbolDesc": { "type": "string" }, "CompanyName": { "type": "string" }, "ArcaImbalanceVolume": { "type": "integer", "format": "int32" }, "ArcaMatchVolume": { "type": "integer", "format": "int32" }, "SaleConditionVolume": { "type": "integer", "format": "int32" }, "IntradayHighCount": { "type": "integer", "format": "int32" }, "VwapVol": { "type": "integer", "format": "int32" }, "Vwap": { "type": "number", "format": "double" }, "Bid": { "$ref": "#/components/schemas/Price" }, "Ask": { "$ref": "#/components/schemas/Price" }, "ChangeLast": { "$ref": "#/components/schemas/Price" }, "High1": { "$ref": "#/components/schemas/Price" }, "High52": { "$ref": "#/components/schemas/Price" }, "Low1": { "$ref": "#/components/schemas/Price" }, "Low52": { "$ref": "#/components/schemas/Price" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "Level2MarketDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "MktSource": { "type": "string" }, "MktMkrId": { "type": "string" }, "DispName": { "type": "string" }, "MktMkrStatus": { "type": "string" }, "ExchName": { "type": "string" }, "MktMkrDisplay": { "type": "string" }, "MktMkrBidsize": { "type": "integer", "format": "int32" }, "MktMkrAsksize": { "type": "integer", "format": "int32" }, "SymbolId": { "type": "integer", "format": "int32" }, "SymbolError": { "type": "integer", "format": "int32" }, "TableId": { "type": "integer", "format": "int32" }, "Styp": { "type": "integer", "format": "int32" }, "QuoteUpdateType": { "type": "integer", "format": "int32" }, "MktMkrDate": { "type": "string" }, "MktMkrBidTime": { "type": "string" }, "MktMkrAskTime": { "type": "string" }, "MktMkrBid": { "$ref": "#/components/schemas/Price" }, "MktMkrChangeLastAsk": { "$ref": "#/components/schemas/Price" }, "MktMkrAsk": { "$ref": "#/components/schemas/Price" } }, "additionalProperties": false }, "MultiFactorAuthenticationResponse": { "type": "object", "properties": { "UserToken": { "type": "string" }, "Response": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "OptionCalculationResponse": { "type": "object", "properties": { "Model": { "type": "integer", "format": "int32" }, "Theta": { "type": "number", "format": "double" }, "Gamma": { "type": "number", "format": "double" }, "Vega": { "type": "number", "format": "double" }, "Delta": { "type": "number", "format": "double" }, "Premium": { "type": "number", "format": "double" }, "ImpliedVol": { "type": "number", "format": "double" }, "DividendAmout6": { "type": "number", "format": "double" }, "DividendAmout5": { "type": "number", "format": "double" }, "DividendAmout4": { "type": "number", "format": "double" }, "DividendAmout3": { "type": "number", "format": "double" }, "DividendAmout2": { "type": "number", "format": "double" }, "DividendAmout1": { "type": "number", "format": "double" }, "Rate": { "type": "number", "format": "double" }, "TimeToExpire": { "type": "number", "format": "double" }, "UnderlierPrice": { "$ref": "#/components/schemas/Price" }, "OriginalPrice": { "$ref": "#/components/schemas/Price" }, "StrikePrice": { "$ref": "#/components/schemas/Price" }, "DividendDate6": { "type": "string" }, "DividendDate5": { "type": "string" }, "DividendDate4": { "type": "string" }, "DividendDate3": { "type": "string" }, "DividendDate2": { "type": "string" }, "DividendDate1": { "type": "string" }, "PutCallId": { "type": "string" }, "DispName": { "type": "string" }, "UnderSym": { "type": "string" }, "OptionRoot": { "type": "string" } }, "additionalProperties": false }, "OptionChainResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "Derivative": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteChainResponse" } } }, "additionalProperties": false }, "OptionSymbolFromDescriptionResponse": { "type": "object", "properties": { "Symbol": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "OptionTypes": { "type": "object", "properties": { "CallOrPut": { "$ref": "#/components/schemas/OptionTypesTypesOptions" } }, "additionalProperties": false }, "OptionTypesTypesOptions": { "enum": [ "CALL", "PUT" ], "type": "string" }, "OptionsAndGreekDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "OptionsList": { "type": "array", "items": { "$ref": "#/components/schemas/OptionCalculationResponse" } } }, "additionalProperties": false }, "OrderDetailByDateRangeResponse": { "type": "object", "properties": { "OrderDetail": { "$ref": "#/components/schemas/OrderDetailsResponse" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "OrderDetailByOrderIdResponse": { "type": "object", "properties": { "OrderDetails": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDetailsResponse" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "OrderDetailByOrderTagResponse": { "type": "object", "properties": { "OrderDetails": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDetailsResponse" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "OrderDetailsResponse": { "type": "object", "properties": { "OrderId": { "type": "string" }, "RefersToId": { "type": "string" }, "Symbol": { "type": "string" }, "Type": { "type": "string" }, "CurrentStatus": { "type": "string" }, "Volume": { "type": "integer", "format": "int32" }, "Price": { "type": "number", "format": "double" }, "PriceType": { "$ref": "#/components/schemas/PriceTypeEnum" }, "Buyorsell": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "OrderTag": { "type": "string" }, "VolumeTraded": { "type": "integer", "format": "int32" }, "OriginalOrderId": { "type": "string" }, "submitTime": { "type": "string" }, "LinkedOrderId": { "type": "string" }, "TicketId": { "type": "string" }, "TraderId": { "type": "string" }, "ClaimedByClerk": { "type": "string" }, "PairSpreadType": { "type": "string" }, "Reason": { "type": "string" }, "TimeStamp": { "type": "string" }, "GoodFrom": { "type": "string" }, "TimeInForce": { "$ref": "#/components/schemas/ExpirationType" }, "StopPrice": { "type": "number", "format": "double" }, "UserMessage": { "type": "string" }, "ExpirationDate": { "type": "string" }, "Side": { "type": "string" }, "Route": { "type": "string" }, "Account": { "type": "string" } }, "additionalProperties": false }, "OrderResponse": { "type": "object", "properties": { "submitTime": { "type": "string" }, "OrderId": { "type": "string" }, "LinkedOrderId": { "type": "string" }, "RefersToId": { "type": "string" }, "TicketId": { "type": "string" }, "OriginalOrderId": { "type": "string" }, "Symbol": { "type": "string" }, "Type": { "type": "string" }, "CurrentStatus": { "type": "string" }, "TraderId": { "type": "string" }, "ClaimedByClerk": { "type": "string" }, "Volume": { "type": "integer", "format": "int32" }, "Price": { "type": "number", "format": "double" }, "PriceType": { "$ref": "#/components/schemas/PriceTypeEnum" }, "Buyorsell": { "type": "string" }, "PairSpreadType": { "type": "string" }, "Reason": { "type": "string" }, "TimeStamp": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "GoodFrom": { "type": "string" }, "TimeInForce": { "$ref": "#/components/schemas/ExpirationType" }, "StopPrice": { "type": "number", "format": "double" }, "UserMessage": { "type": "string" }, "ExpirationDate": { "type": "string" }, "Side": { "type": "string" }, "Route": { "type": "string" }, "Account": { "type": "string" }, "OrderTag": { "type": "string" }, "VolumeTraded": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OrderRow": { "type": "object", "properties": { "ExpirDate": { "type": "string" }, "NewsDate": { "type": "string" }, "AllocatedValue": { "type": "number", "format": "double" }, "AvgPrice": { "type": "number", "format": "double" }, "Basisvalue": { "type": "number", "format": "double" }, "Commission": { "type": "number", "format": "double" }, "CommissionRate": { "type": "number", "format": "double" }, "EcnFee": { "type": "number", "format": "double" }, "Latency3": { "type": "number", "format": "double" }, "Latency6": { "type": "number", "format": "double" }, "PairCash": { "type": "number", "format": "double" }, "PairImbalanceLimit": { "type": "number", "format": "double" }, "PairLeg1Benchmark": { "type": "number", "format": "double" }, "PairLeg2Benchmark": { "type": "number", "format": "double" }, "PairRatio": { "type": "number", "format": "double" }, "PairSpread": { "type": "number", "format": "double" }, "PairTarget": { "type": "number", "format": "double" }, "SpreadClip": { "type": "number", "format": "double" }, "AcctType": { "type": "integer", "format": "int32" }, "BookId": { "type": "integer", "format": "int32" }, "CommissionRateType": { "type": "integer", "format": "int32" }, "CrossFlag": { "type": "integer", "format": "int32" }, "DateIndex": { "type": "integer", "format": "int32" }, "ExecutionState": { "type": "integer", "format": "int32" }, "ExtendedStateFlags": { "type": "integer", "format": "int32" }, "ExtendedStateFlags2": { "type": "integer", "format": "int32" }, "ExternalAcceptanceFlag": { "type": "integer", "format": "int32" }, "FornexSourceFlags": { "type": "integer", "format": "int32" }, "GwBookSeqNo": { "type": "integer", "format": "int32" }, "LinkedOrderCancellation": { "type": "integer", "format": "int32" }, "LinkedOrderRelationship": { "type": "integer", "format": "int32" }, "Minmove": { "type": "integer", "format": "int32" }, "OmsClientType": { "type": "integer", "format": "int32" }, "OrderFlags": { "type": "integer", "format": "int32" }, "OrderFlags2": { "type": "integer", "format": "int32" }, "OrderResidual": { "type": "integer", "format": "int32" }, "OriginalVolume": { "type": "integer", "format": "int32" }, "PairImbalanceLimitType": { "type": "integer", "format": "int32" }, "PairLeg1BenchmarkType": { "type": "integer", "format": "int32" }, "PairLeg2BenchmarkType": { "type": "integer", "format": "int32" }, "PairSpreadType": { "type": "integer", "format": "int32" }, "Rank": { "type": "integer", "format": "int32" }, "RemainingVolume": { "type": "integer", "format": "int32" }, "SharesAllocated": { "type": "integer", "format": "int32" }, "SpreadClipType": { "type": "integer", "format": "int32" }, "SpreadLegCount": { "type": "integer", "format": "int32" }, "SpreadLegLeanPriority": { "type": "integer", "format": "int32" }, "SpreadLegNumber": { "type": "integer", "format": "int32" }, "SpreadLegPriceType": { "type": "integer", "format": "int32" }, "SpreadNumLegs": { "type": "integer", "format": "int32" }, "Styp": { "type": "integer", "format": "int32" }, "TboAccountId": { "type": "integer", "format": "int32" }, "UtcOffset": { "type": "integer", "format": "int32" }, "Volume": { "type": "integer", "format": "int32" }, "VolumeTraded": { "type": "integer", "format": "int32" }, "WorkingQty": { "type": "integer", "format": "int32" }, "Ask": { "type": "string" }, "Bid": { "type": "string" }, "OriginalPrice": { "type": "string" }, "Price": { "type": "string" }, "StopPrice": { "type": "string" }, "StrikePrc": { "type": "string" }, "Bank": { "type": "string" }, "Branch": { "type": "string" }, "Buyorsell": { "type": "string" }, "ClaimedByClerk": { "type": "string" }, "ClientOrderId": { "type": "string" }, "CommissionCode": { "type": "string" }, "Currency": { "type": "string" }, "CurrentStatus": { "type": "string" }, "Customer": { "type": "string" }, "Deposit": { "type": "string" }, "DispName": { "type": "string" }, "Exchange": { "type": "string" }, "Route": { "type": "string" }, "FixTraderId": { "type": "string" }, "GoodFrom": { "type": "string" }, "GoodUntil": { "type": "string" }, "LinkedOrderId": { "type": "string" }, "NewRemoteId": { "type": "string" }, "OppositeParty": { "type": "string" }, "OrderId": { "type": "string" }, "OrderTag": { "type": "string" }, "OriginalOrderId": { "type": "string" }, "OriginalTraderId": { "type": "string" }, "PriceType": { "type": "string" }, "Putcallind": { "type": "string" }, "Reason": { "type": "string" }, "RefersToId": { "type": "string" }, "RemoteId": { "type": "string" }, "ShortLocateId": { "type": "string" }, "Table": { "type": "string" }, "TicketId": { "type": "string" }, "TimeStamp": { "type": "string" }, "TraderCapacity": { "type": "string" }, "TraderId": { "type": "string" }, "Type": { "type": "string" }, "Undersym": { "type": "string" }, "UserMessage": { "type": "string" }, "VolumeType": { "type": "string" }, "NewsTime": { "type": "string" }, "TrdTime": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "OrderType": { "type": "object", "properties": { "TypeOfOrder": { "$ref": "#/components/schemas/OrderTypeTypesType" } }, "additionalProperties": false }, "OrderTypeTypesType": { "enum": [ "UserSubmitOrder", "ForeignExecution" ], "type": "string" }, "Position": { "type": "object", "properties": { "AverageShort0": { "type": "number", "format": "double" }, "HistShortPrc0": { "type": "number", "format": "double" }, "Shortpos0": { "type": "number", "format": "double" }, "OrigShortpos0": { "type": "number", "format": "double" }, "ScalpedProfit": { "type": "number", "format": "double" }, "Mmr": { "type": "number", "format": "double" }, "BoughtQty": { "type": "number", "format": "double" }, "SoldQty": { "type": "number", "format": "double" }, "SoldShortQty": { "type": "number", "format": "double" }, "BoughtAvgPrc": { "type": "number", "format": "double" }, "SoldAvgPrc": { "type": "number", "format": "double" }, "SoldShortAvgPrc": { "type": "number", "format": "double" }, "Commission": { "type": "number", "format": "double" }, "Shortpos": { "type": "number", "format": "double" }, "AverageShort": { "type": "number", "format": "double" }, "OrigLongpos0": { "type": "number", "format": "double" }, "Longpos0": { "type": "number", "format": "double" }, "AverageLong": { "type": "number", "format": "double" }, "Longpos": { "type": "number", "format": "double" }, "AverageLong0": { "type": "number", "format": "double" }, "HistLongPrc0": { "type": "number", "format": "double" }, "NetFees": { "type": "number", "format": "double" }, "HistScalpedProfit": { "type": "number", "format": "double" }, "Table": { "type": "string" }, "Bank": { "type": "string" }, "Branch": { "type": "string" }, "Customer": { "type": "string" }, "Deposit": { "type": "string" }, "Currency": { "type": "string" }, "DispName": { "type": "string" }, "Undersym": { "type": "string" }, "AcctType": { "type": "integer", "format": "int32" }, "TboAccountId": { "type": "integer", "format": "int32" }, "Rank": { "type": "integer", "format": "int32" }, "Styp": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Price": { "type": "object", "properties": { "DecimalValue": { "type": "number", "format": "double" }, "Denominator": { "type": "integer", "format": "int32" }, "Numerator": { "type": "integer", "format": "int32" }, "Base": { "type": "integer", "format": "int32" }, "Int": { "type": "integer", "format": "int32" }, "BaseCode": { "type": "integer", "format": "int32" }, "IntegerValue": { "type": "integer", "format": "int32" }, "Isnull": { "type": "boolean" } }, "additionalProperties": false }, "PriceTypeEnum": { "type": "object", "properties": { "PriceType": { "$ref": "#/components/schemas/PriceTypeEnumTypesPriceTypesEnum" } }, "additionalProperties": false }, "PriceTypeEnumTypesPriceTypesEnum": { "enum": [ "Market", "Limit", "StopMarket", "StopLimit", "Other" ], "type": "string" }, "QuoteChainResponse": { "type": "object", "properties": { "DispName": { "type": "string" }, "ExchName": { "type": "string" }, "SymbolDesc": { "type": "string" }, "TrdUnits": { "type": "string" }, "CommodityName": { "type": "string" }, "Styp": { "type": "integer", "format": "int32" }, "Session": { "type": "integer", "format": "int32" }, "Minmove": { "type": "integer", "format": "int32" }, "Basisvalue": { "type": "number", "format": "double" }, "ExpirDate": { "type": "string" }, "StrikePrice": { "$ref": "#/components/schemas/Price" }, "PutCallInd": { "type": "string" } }, "additionalProperties": false }, "RemoveSymbolsResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "RoutePropsMap": { "type": "object", "properties": { "Properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "SecurityData": { "type": "object", "properties": { "Divpaydate": { "type": "string" }, "Exdivdate": { "type": "string" }, "High52Date": { "type": "string" }, "Low52Date": { "type": "string" }, "ProcDate": { "type": "string" }, "SplitDate1": { "type": "string" }, "Adx14d1d": { "type": "number", "format": "double" }, "BollingerLower21d1d": { "type": "number", "format": "double" }, "BollingerUpper21d1d": { "type": "number", "format": "double" }, "Close10davg1d": { "type": "number", "format": "double" }, "Close200davg1d": { "type": "number", "format": "double" }, "Close20davg1d": { "type": "number", "format": "double" }, "Close50davg1d": { "type": "number", "format": "double" }, "Close5davg1d": { "type": "number", "format": "double" }, "High15dmax1d": { "type": "number", "format": "double" }, "Hlvolatility10d1d": { "type": "number", "format": "double" }, "Low15dmin1d": { "type": "number", "format": "double" }, "Minusdi14d1d": { "type": "number", "format": "double" }, "Plusdi14d1d": { "type": "number", "format": "double" }, "Rsi14d1d": { "type": "number", "format": "double" }, "Rsi25d1d": { "type": "number", "format": "double" }, "Rsi9d1d": { "type": "number", "format": "double" }, "SplitFactor1": { "type": "number", "format": "double" }, "Volume10davg1d": { "type": "number", "format": "double" }, "Volume200davg1d": { "type": "number", "format": "double" }, "Volume20davg1d": { "type": "number", "format": "double" }, "Volume50davg1d": { "type": "number", "format": "double" }, "Volume5davg1d": { "type": "number", "format": "double" }, "DividendFreqN": { "type": "integer", "format": "int32" }, "SecurityCategory": { "type": "integer", "format": "int32" }, "SharesOut": { "type": "integer", "format": "int32" }, "Beta": { "$ref": "#/components/schemas/Price" }, "Dividend": { "$ref": "#/components/schemas/Price" }, "DividendRate": { "$ref": "#/components/schemas/Price" }, "DividendYield": { "$ref": "#/components/schemas/Price" }, "Earnings": { "$ref": "#/components/schemas/Price" }, "High52": { "$ref": "#/components/schemas/Price" }, "Low52": { "$ref": "#/components/schemas/Price" }, "MgSicm": { "$ref": "#/components/schemas/Price" }, "MktCap": { "$ref": "#/components/schemas/Price" }, "Peratio": { "$ref": "#/components/schemas/Price" }, "BloombergCode": { "type": "string" }, "BloombergCodeComposite": { "type": "string" }, "CompanyName": { "type": "string" }, "Country": { "type": "string" }, "Cusip": { "type": "string" }, "DispName": { "type": "string" }, "GicsIndustry": { "type": "string" }, "GicsSector": { "type": "string" }, "GicsSubindustry": { "type": "string" }, "IsinNo": { "type": "string" }, "IssuersSectorStr": { "type": "string" }, "PrimaryExchange": { "type": "string" }, "RicCode": { "type": "string" }, "Sedol": { "type": "string" }, "MIC": { "type": "string" } }, "additionalProperties": false }, "SecurityDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "SecurityInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityData" } } }, "additionalProperties": false }, "ServerAcknowledgement": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Message": { "type": "string" }, "ResponseCode": { "$ref": "#/components/schemas/ServerAcknowledgementTypesResponseCodesEnum" } }, "additionalProperties": false }, "ServerAcknowledgementTypesResponseCodesEnum": { "enum": [ "SUCCESS", "WARNING", "FAILED", "ERROR", "TIMED_OUT", "SESSION_NOT_FOUND" ], "type": "string" }, "StartLoginSrpResponse": { "type": "object", "properties": { "Status": { "type": "string" }, "srpTransactId": { "type": "string" }, "srpSalt": { "type": "string" }, "srpN": { "type": "string" }, "srpg": { "type": "string" }, "srpb": { "type": "string" }, "Response": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "StrategyDataRow": { "type": "object", "properties": { "FirmName": { "type": "string" }, "UserName": { "type": "string" }, "AlgoName": { "type": "string" }, "StrategyName": { "type": "string" }, "Version": { "type": "integer", "format": "int32" }, "StratParams": { "type": "string" }, "StratCreateDate": { "type": "string" }, "StratUpdateDate": { "type": "string" } }, "additionalProperties": false }, "StrategyListResponse": { "type": "object", "properties": { "StrategyList": { "type": "array", "items": { "$ref": "#/components/schemas/StrategyListRow" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "StrategyListRow": { "type": "object", "properties": { "FirmName": { "type": "string" }, "UserName": { "type": "string" }, "AlgoName": { "type": "string" }, "StrategyName": { "type": "string" }, "StratCreateDate": { "type": "string" } }, "additionalProperties": false }, "SubmitAllocationOrderRequest": { "type": "object", "properties": { "OrderId": { "type": "string" }, "Symbol": { "type": "string" }, "Exchange": { "type": "string" }, "SourceAccount": { "type": "string" }, "TargetAccount": { "type": "string" }, "TargetQuantity": { "type": "integer", "format": "int32" }, "TargetPrice": { "type": "number", "format": "double" }, "UserToken": { "type": "string" }, "TypeOfAllocation": { "$ref": "#/components/schemas/AllocationType" }, "OrderTypes": { "$ref": "#/components/schemas/OrderType" } }, "additionalProperties": false }, "SubmitAllocationOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubmitBookTradeRequest": { "type": "object", "properties": { "OrderId": { "type": "string" }, "SourceAccount": { "type": "string" }, "UserToken": { "type": "string" }, "OrderTag": { "type": "string" }, "AllocDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationDetails" } } }, "additionalProperties": false }, "SubmitBookTradeResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubmitPairOrderRequest": { "type": "object", "properties": { "Leg1Symbol": { "type": "string" }, "Leg1Side": { "type": "string" }, "Leg1Quantity": { "type": "integer", "format": "int32" }, "Route": { "type": "string" }, "Leg1ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Leg2Symbol": { "type": "string" }, "Leg2Side": { "type": "string" }, "Leg2Quantity": { "type": "integer", "format": "int32" }, "Leg2ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Staged": { "type": "boolean" }, "ClaimRequire": { "type": "boolean" }, "Account": { "type": "string" }, "UserToken": { "type": "string" }, "OrderTag": { "type": "string" }, "TicketId": { "type": "string" } }, "additionalProperties": false }, "SubmitPairOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubmitSeedDataRequest": { "type": "object", "properties": { "Account": { "type": "string" }, "Symbol": { "type": "string" }, "UserToken": { "type": "string" } }, "additionalProperties": false }, "SubmitSeedDataResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubmitSingleOrderRequest": { "type": "object", "properties": { "Symbol": { "type": "string" }, "Side": { "type": "string" }, "Quantity": { "type": "integer", "format": "int32" }, "Route": { "type": "string" }, "Account": { "type": "string" }, "OrderTag": { "type": "string" }, "TicketId": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Staged": { "type": "boolean" }, "ClaimRequire": { "type": "boolean" }, "UserToken": { "type": "string" }, "GoodFrom": { "type": "string" }, "TimeInForce": { "$ref": "#/components/schemas/ExpirationType" }, "PriceType": { "$ref": "#/components/schemas/PriceTypeEnum" }, "Price": { "type": "number", "format": "double" }, "StopPrice": { "type": "number", "format": "double" }, "UserMessage": { "type": "string" }, "ExpirationDate": { "type": "string" }, "ReturnResult": { "type": "boolean" }, "ReturnResultTimeOutInMs": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SubmitSingleOrderResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OrderDetails": { "$ref": "#/components/schemas/OrderDetailsResponse" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubmitTradeReportRequest": { "type": "object", "properties": { "Symbol": { "type": "string" }, "Side": { "type": "string" }, "Quantity": { "type": "integer", "format": "int32" }, "Account": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "OrderType": { "$ref": "#/components/schemas/TradeType" }, "Route": { "type": "string" }, "UserToken": { "type": "string" } }, "additionalProperties": false }, "SubmitTradeReportResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubscribeHeartBeatResponse": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/SubscribeHeartBeatResponseTypesHeartBeatStatus" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubscribeHeartBeatResponseTypesHeartBeatStatus": { "enum": [ "LIVE", "DEAD", "UNKNOWN" ], "type": "string" }, "SubscribeIntradayBarsResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "DispName": { "type": "string" }, "BarInterval": { "type": "integer", "format": "int32" }, "Bars": { "type": "array", "items": { "$ref": "#/components/schemas/IntradayBarUpdate" } } }, "additionalProperties": false }, "SubscribeNetPositionsResponse": { "type": "object", "properties": { "AggregatePositions": { "$ref": "#/components/schemas/AggregatePositionRecord" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubscribeOrderFieldOptionsTypesFields": { "enum": [ "SUBMIT_TIME", "ORDER_ID", "LINKED_ORDER_ID", "REFERS_TO_ID", "TICKET_ID", "ORIGINAL_ORDER_ID", "SYMBOL", "TYPE", "CURRENT_STATUS", "TRADER_ID", "CLAIMED_BY_CLERK", "VOLUME", "PRICE", "PRICE_TYPE", "BUYORSELL", "PAIR_SPREAD_TYPE", "REASON", "TIME_STAMP", "EXTENDED_FIELDS", "GOOD_FROM", "TIME_IN_FORCE", "STOP_PRICE", "USER_MESSAGE", "EXPIRATION_DATE", "SIDE", "ROUTE", "ACCOUNT", "ORDER_TAG", "VOLUME_TRADED" ], "type": "string" }, "SubscribeOrderInfoRequestTypesSubscriptionLevel": { "enum": [ "FILL", "STATUS" ], "type": "string" }, "SubscribeOrderInfoResponse": { "type": "object", "properties": { "submitTime": { "type": "string" }, "OrderId": { "type": "string" }, "LinkedOrderId": { "type": "string" }, "RefersToId": { "type": "string" }, "TicketId": { "type": "string" }, "OriginalOrderId": { "type": "string" }, "Symbol": { "type": "string" }, "Type": { "type": "string" }, "CurrentStatus": { "type": "string" }, "TraderId": { "type": "string" }, "ClaimedByClerk": { "type": "string" }, "Volume": { "type": "integer", "format": "int32" }, "Price": { "type": "number", "format": "double" }, "PriceType": { "$ref": "#/components/schemas/PriceTypeEnum" }, "Buyorsell": { "type": "string" }, "PairSpreadType": { "type": "string" }, "Reason": { "type": "string" }, "TimeStamp": { "type": "string" }, "ExtendedFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "GoodFrom": { "type": "string" }, "TimeInForce": { "$ref": "#/components/schemas/ExpirationType" }, "StopPrice": { "type": "number", "format": "double" }, "UserMessage": { "type": "string" }, "ExpirationDate": { "type": "string" }, "Side": { "type": "string" }, "Route": { "type": "string" }, "Account": { "type": "string" }, "OrderTag": { "type": "string" }, "VolumeTraded": { "type": "integer", "format": "int32" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "SubscribeTickDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "TrdPrc1": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "TrdDate": { "type": "array", "items": { "type": "string" } }, "TickType": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "TrdXid1": { "type": "array", "items": { "type": "string" } }, "TrdVol1": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "TrdTim1": { "type": "array", "items": { "type": "string" } }, "DispName": { "type": "array", "items": { "type": "string" } }, "Count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SymInfoResponse": { "type": "object", "properties": { "Styp": { "type": "integer", "format": "int32" }, "DispName": { "type": "string" }, "BloombergCode": { "type": "string" }, "BloombergCodeFull": { "type": "string" }, "BloombergCodeComposite": { "type": "string" }, "ExchName": { "type": "string" }, "SymbolDesc": { "type": "string" } }, "additionalProperties": false }, "SymbolData": { "type": "object", "properties": { "DispName": { "type": "string" }, "ExchName": { "type": "string" }, "Styp": { "type": "integer", "format": "int32" }, "SymbolDesc": { "type": "string" }, "IsinNo": { "type": "string" }, "Country": { "type": "string" }, "CommodityName": { "type": "string" }, "BloombergCode": { "type": "string" }, "BloombergCodeFull": { "type": "string" }, "BloombergCodeComposite": { "type": "string" }, "RicCode": { "type": "string" }, "Sedol": { "type": "string" }, "GicsSector": { "type": "string" }, "GicsIndustry": { "type": "string" }, "GicsSubindustry": { "type": "string" }, "Cusip": { "type": "string" } }, "additionalProperties": false }, "SymbolFromAlternateSymbologyResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "SymbolInfolist": { "type": "array", "items": { "$ref": "#/components/schemas/SymbolData" } }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/SymbolLookupResult" } }, "SuccessCount": { "type": "integer", "format": "int32" }, "FailureCount": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SymbolLookupResult": { "type": "object", "properties": { "RequestedSymbol": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "SymbolInfolist": { "type": "array", "items": { "$ref": "#/components/schemas/SymbolData" } } }, "additionalProperties": false }, "SymbolReferenceDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "SymInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/SymInfoResponse" } } }, "additionalProperties": false }, "SymbolsFromCompanyNameResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "SymbolDatalist": { "type": "array", "items": { "$ref": "#/components/schemas/SymbolData" } } }, "additionalProperties": false }, "TickDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" }, "TickInfo": { "type": "array", "items": { "$ref": "#/components/schemas/TicksResponse" } } }, "additionalProperties": false }, "TicksResponse": { "type": "object", "properties": { "TrdPrc1": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "TrdDate": { "type": "array", "items": { "type": "string" } }, "TickType": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "TrdXid1": { "type": "array", "items": { "type": "string" } }, "TrdVol1": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "TrdTim1": { "type": "array", "items": { "type": "string" } }, "DispName": { "type": "array", "items": { "type": "string" } }, "Count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TodaysActivityResponse": { "type": "object", "properties": { "OrderRecordList": { "type": "array", "items": { "$ref": "#/components/schemas/OrderResponse" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "TodaysBalancesResponse": { "type": "object", "properties": { "DepositList": { "type": "array", "items": { "$ref": "#/components/schemas/DepositRow" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "TodaysBrokenDownPositionsResponse": { "type": "object", "properties": { "PositionRecords": { "type": "array", "items": { "$ref": "#/components/schemas/Position" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "TodaysNetPositionsResponse": { "type": "object", "properties": { "AggregatePositionsList": { "type": "array", "items": { "$ref": "#/components/schemas/AggregatePositionRecord" } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "TradeType": { "type": "object", "properties": { "OrderTypes": { "$ref": "#/components/schemas/TradeTypeTypesTypeofOrder" } }, "additionalProperties": false }, "TradeTypeTypesTypeofOrder": { "enum": [ "UserSubmitTradeReport", "ForeignExecution" ], "type": "string" }, "UnSubscribeIntradayBarsResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UnSubscribeLevel1DataResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UnSubscribeLevel2DataResponse": { "type": "object", "properties": { "ServerResponse": { "type": "string" }, "OptionalFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UnSubscribeNetPositionsResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UnSubscribeTickDataResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UpdateStrategyRequest": { "type": "object", "properties": { "UserToken": { "type": "string" }, "FirmName": { "type": "string" }, "AlgoName": { "type": "string" }, "StrategyName": { "type": "string" }, "Version": { "type": "integer", "format": "int32" }, "StratParams": { "type": "string" } }, "additionalProperties": false }, "UpdateStrategyResponse": { "type": "object", "properties": { "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UserAccountsResponse": { "type": "object", "properties": { "Accounts": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UserExistsResponse": { "type": "object", "properties": { "UserExists": { "type": "boolean" }, "FirmName": { "type": "string" }, "Acknowledgement": { "$ref": "#/components/schemas/ServerAcknowledgement" } }, "additionalProperties": false }, "UserPermissionRecord": { "type": "object", "properties": { "Bank": { "type": "string" }, "Branch": { "type": "string" }, "Customer": { "type": "string" }, "Deposit": { "type": "string" }, "AcctType": { "type": "integer", "format": "int32" }, "MarginSource": { "type": "integer", "format": "int32" }, "MarginRulesetId": { "type": "integer", "format": "int32" }, "MarginRulesetName": { "type": "string" }, "AcctDesc": { "type": "string" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Please enter a valid token : ", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ] }