openapi: 3.0.1 info: title: Services.Portfolio description: 'The Portfolio service group provides services and end points that serves information about the clients current portfolio, such as account balance, open positions etc.' version: 2.4.82+77577352f2 x-framework-version: 41.0.17+46f32c3eb1 x-machine: SIMOAWEB8-DK1 servers: - url: https://gateway.saxobank.com/sim/openapi paths: '/port/v1/closedpositions/subscriptions/{ContextId}': delete: tags: - ClosedPositions summary: Remove multiple subscriptions description: 'Removes multiple all subscriptions for the current session on this resource, and frees all resources on the server.' operationId: ClosedPositionsV1DeleteSubscriptions parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: Tag in: query description: Optional. Remove only subscriptions that are marked with specified tag. schema: type: string example: '2345223' responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/closedpositions/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - ClosedPositions summary: Remove subscription description: Removes subscription for the current session identified by subscription id.. operationId: ClosedPositionsV1DeleteSubscription parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique id of the subscription required: true schema: type: string example: 0f8fad5b-d9cb-469f-a165-70867728950e responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe patch: tags: - ClosedPositions summary: Change the closed positions subscription page size description: 'Extends or reduces the page size, number of positions shown, on a running closed positions subscription. When expanding the page size, the subsequent closed positions are streamed so to avoid race conditions.' operationId: ClosedPositionsV1UpdateClosedPositionSubscriptionPagesize parameters: - name: ContextId in: path description: The context id part of the streaming session. required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique ID of the subscription required: true schema: type: string example: P54123 requestBody: content: application/json: schema: $ref: '#/components/schemas/PositionPagingSubscriptionUpdateRequest' example: NewPageSize: 99 responses: '204': description: No Content '202': description: Subscription change will be processed and respose will be streamed. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/closedpositions/subscriptions: post: tags: - ClosedPositions summary: Create a subscription on a list of closed positions and make it active description: Sets up a subscription and returns an initial snapshot of list of closed positions specified by the parameters in the request. operationId: ClosedPositionsV1AddActiveSubscription parameters: - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClosedPositionsSubscriptionRequest' example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ClosedPositionId: 139597294-139694249 FieldGroups: - ClosedPosition ContextId: '20221030064907102' Format: application/json ReferenceId: CP35618 RefreshRate: 1000 Tag: PAGE1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ClosedPositionsSubscriptionResponse' example: Format: application/json InactivityTimeout: 120 ReferenceId: CP50382 RefreshRate: 1000 Snapshot: Data: - ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot State: Active '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - SubscriptionExceedesPositionsLimit - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. NoValidInput: No valid input values passed. SubscriptionExceedesPositionsLimit: Too many positions requested. Streaming updates are only allowed on a limited number of positions. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/ClosedPositionResponseArray' '/port/v1/closedpositions/{ClosedPositionId}/details': get: tags: - ClosedPositions summary: Get detailed information for a single position description: "Obsolete Gets detailed information about a single position as specified by the query parameters.\n NOTE: This endpoint will be deprecated by November 2022. All functionality has been migrated to /port/v1/closedpositions/{ClosedPositionId}." operationId: ClosedPositionsV1GetPositionDetails parameters: - name: AccountGroupKey in: query description: The key of the account group to which the closed positions belongs. schema: title: The key of the account group to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the closed positions belongs. schema: title: The key of the account to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the closesd positions belongs. required: true schema: title: The key of the client to which the closesd positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: ClosedPositionId in: path description: Unique id of the position. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClosedPositionDetailedResponse' example: ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionDetails: CurrencyConversionRateInstrumentToBaseClosing: 1 CurrencyConversionRateInstrumentToBaseOpening: 1 ValueDateClose: '2017-05-04T00:00:00Z' ValueDateOpen: '2017-05-04T00:00:00Z' ClosedPositionUniqueId: 139597294-139694249 DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD Exchange: Description: Inter Bank ExchangeId: SBFX IsOpen: true NetPositionId: EURUSD_FxSpot '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - PositionIdNotSpecified type: string example: None x-enum-descriptions: PositionIdNotSpecified: Position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' deprecated: true security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/closedpositions/{ClosedPositionId}': get: tags: - ClosedPositions summary: Get a single position description: Get a single position. operationId: ClosedPositionsV1GetClosedPosition parameters: - name: AccountGroupKey in: query description: The key of the account group to which the closed positions belongs. schema: title: The key of the account group to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the closed positions belongs. schema: title: The key of the account to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the closesd positions belongs. required: true schema: title: The key of the client to which the closesd positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: ClosedPositionId in: path description: Unique id of the position. required: true schema: type: string - name: FieldGroups in: query description: 'Specifies which data to return. Default is [ClosedPosition]' schema: title: 'Specifies which data to return. Default is [ClosedPosition]' type: array items: $ref: '#/components/schemas/ClosedPositionFieldGroup' example: - DisplayAndFormat responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClosedPositionResponse' example: ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - PositionIdNotSpecified type: string example: None x-enum-descriptions: PositionIdNotSpecified: Position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/closedpositions/me: get: tags: - ClosedPositions summary: 'Get closed positions for a client, to which the logged in user belongs' description: Returns a list of closed positions fulfilling the criteria specified by the query string parameters. operationId: GET_ClosedPositionsV1GetClosedPositions parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: FieldGroups in: query description: 'Specifies which data to return. Default is [ClosedPosition].' required: true schema: type: array items: $ref: '#/components/schemas/ClosedPositionFieldGroup' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClosedPositionResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/closedpositions: get: tags: - ClosedPositions summary: 'Get closed positions for a client, accountGroup or account' description: Returns a list of closed positions fulfilling the criteria specified by the query string parameters. operationId: ClosedPositionsV1GetClosedPositions parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: AccountGroupKey in: query description: The key of the account group to which the closed positions belongs. schema: title: The key of the account group to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the closed positions belongs. schema: title: The key of the account to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the closesd positions belongs. required: true schema: title: The key of the client to which the closesd positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: ClosedPositionId in: query description: The id of the closed position to which the closedposition belongs schema: title: The id of the closed position to which the closedposition belongs type: string example: stringValue - name: FieldGroups in: query description: 'Specifies which data to return. Default is [ClosedPosition]' schema: title: 'Specifies which data to return. Default is [ClosedPosition]' type: array items: $ref: '#/components/schemas/ClosedPositionFieldGroup' example: - DisplayAndFormat responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClosedPositionResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - ClosedPositionNotAccessibleInEndOfDayNettingMode - InvalidClientId - InvalidExchangeId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. InvalidExchangeId: The provided exchange id is invalid. ClosedPositionNotAccessibleInEndOfDayNettingMode: ClosedPosition is not accessible in EndOfDay netting mode of the client Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/netpositions/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - NetPositions summary: Remove subscription description: Removes subscription for the current session identified by subscription id. operationId: NetPositionsV1DeleteSubscription parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique ID of the subscription required: true schema: type: string example: NP6783 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/netpositions/subscriptions/{ContextId}': delete: tags: - NetPositions summary: Remove multiple subscriptions description: 'Removes multiple all subscriptions for the current session on this resource, and frees all resources on the server.' operationId: NetPositionsV1DeleteSubscriptions parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: Tag in: query description: Optional. Remove only subscriptions that are marked with specified tag. schema: type: string example: PAGE2 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/netpositions/subscriptions: post: tags: - NetPositions summary: Create a subscription on a list of net positions and make it active description: Sets up a subscription and returns an initial snapshot of list of net positions specified by the parameters in the request. operationId: NetPositionsV1AddActiveSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/NetPositionsSubscriptionRequest' example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== FieldGroups: - NetPositionView - NetPositionBase NetPositionId: EURUSD 41761NY 1.3765 C PriceMode: RegularTradingHours ContextId: '20221030064904217' Format: application/json ReferenceId: NP12768 RefreshRate: 1000 Tag: PAGE1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/NetPositionsSubscriptionResponse' example: ContextId: stringValue Format: stringValue InactivityTimeout: 99 ReferenceId: stringValue RefreshRate: 99 Snapshot: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 State: Active Tag: stringValue '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. NoValidInput: No valid input values passed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/NetPositionResponseArray' /port/v1/netpositions: get: tags: - NetPositions summary: 'Get net positions for a client, account group or account' description: "Returns a list of net positions fulfilling the criteria specified by the query string parameters.\n Each net position may include all related sub positions if fieldGroups includes SubPositions." operationId: GET_NetPositionsV1GetNetPositions parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: AccountGroupKey in: query description: The key of the account group to which the positions belong. schema: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the positions belong. schema: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: AssetType in: query description: Optional. The AssetType. schema: title: Optional. The AssetType. allOf: - $ref: '#/components/schemas/AssetType' example: StockIndexOption - name: ClientKey in: query description: The key of the client to which the positions belong. required: true schema: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: ExpiryDate in: query description: Optional. The expiry date. Only used to distinguish FxOptions. schema: title: Optional. The expiry date. Only used to distinguish FxOptions. type: string format: date-time x-type-name: UtcDateTime example: '9999-12-31T23:59:59.9999990+00:00' - name: FieldGroups in: query description: 'Specifies which data to return. Default is [NetPositionBase,NetPositionView]' schema: title: 'Specifies which data to return. Default is [NetPositionBase,NetPositionView]' type: array items: $ref: '#/components/schemas/NetPositionFieldGroup' example: - NetPositionView - name: LowerBarrier in: query description: Optional. The Lower Barrier. Only used to distinguish Fx Barrier Options. schema: title: Optional. The Lower Barrier. Only used to distinguish Fx Barrier Options. type: number example: 2.55 - name: NetPositionId in: query description: Optional. The id of the netposition schema: title: Optional. The id of the netposition type: string example: stringValue - name: PutCall in: query description: Optional. Put or Call. Only used to distinguish FxOptions. schema: title: Optional. Put or Call. Only used to distinguish FxOptions. allOf: - $ref: '#/components/schemas/PutCall' example: Put - name: Strike in: query description: Optional. The strike price of the option. Only used to distinguish FxOptions. schema: title: Optional. The strike price of the option. Only used to distinguish FxOptions. type: number example: 2.55 - name: Uic in: query description: Optional. Unique id of the instrument. schema: title: Optional. Unique id of the instrument. type: integer format: int32 example: 99 - name: UpperBarrier in: query description: Optional. The Upper Barrier. Only used to distinguish Fx Barrier Options. schema: title: Optional. The Upper Barrier. Only used to distinguish Fx Barrier Options. type: number example: 2.55 - name: ValueDate in: query description: Optional. The value date. Only used to distinguish FxForwards. schema: title: Optional. The value date. Only used to distinguish FxForwards. type: string format: date-time x-type-name: UtcDateTime example: '9999-12-31T23:59:59.9999990+00:00' - name: WatchlistId in: query description: Optional. Watchlist Id.Filter on watchlist instruments schema: title: Optional. Watchlist Id.Filter on watchlist instruments type: string example: stringValue responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetPositionResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidExchangeId - NetPositionIdNotSpecified - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. NetPositionIdNotSpecified: Net position not specified. InvalidClientId: Indicates that the requested client id was invalid. InvalidExchangeId: The provided exchange id is invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/netpositions/me: get: tags: - NetPositions summary: Get net positions for the current user's client description: "Returns a list of net positions fulfilling the criteria specified by the query string parameters.\n Each net position may include all related sub positions if fieldGroups includes SubPositions." operationId: NetPositionsV1GetNetPositions parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: FieldGroups in: query description: 'Specifies which data to return. Default is [NetPositionBase, NetPositionView].' required: true schema: type: array items: $ref: '#/components/schemas/NetPositionFieldGroup' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetPositionResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/netpositions/{NetPositionId}/details': get: tags: - NetPositions summary: Get detailed information for a single net position description: "Obsolete Gets detailed information about a single net position as specified by the query parameters.\n NOTE: This endpoint will be deprecated by November 2022. All functionality has been migrated to /port/v1/netpositions/{NetpositionId}." operationId: NetPositionsV1GetNetPositionDetails parameters: - name: AccountGroupKey in: query description: The key of the account group to which the positions belong. schema: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the positions belong. schema: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the positions belong. required: true schema: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: NetPositionId in: path description: Unique id of the net position. required: true schema: type: string example: 247__Share responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetPositionDetailedResponse' example: NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionDetails: MarketValue: -2958 MarketValueInBaseCurrency: -2958 NonTradableReason: None NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - NetPositionIdNotSpecified - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. NetPositionIdNotSpecified: Net position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' deprecated: true security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/netpositions/{NetPositionId}': get: tags: - NetPositions summary: Get a single net position description: "Gets a single net position calculated as specified by the query parameters. \n The net position may include all related sub positions if fieldGroups includes SubPositions.\n Note: the net position is fully identified by the supplied netPositionId, but accountId and clientId may be specified\n to determine whether the netposition values should be calculated at client or account level." operationId: NetPositionsV1GetNetPosition parameters: - name: AccountGroupKey in: query description: The key of the account group to which the positions belong. schema: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the positions belong. schema: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the positions belong. required: true schema: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: FieldGroups in: query description: 'Specifies which data to return. Default is [NetPositionBase,NetPositionView]' schema: title: 'Specifies which data to return. Default is [NetPositionBase,NetPositionView]' type: array items: $ref: '#/components/schemas/NetPositionFieldGroup' example: - NetPositionView - name: NetPositionId in: path description: Unique id of the net position. required: true schema: type: string example: 247__Share responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetPositionResponse' example: NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - NetPositionIdNotSpecified - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. NetPositionIdNotSpecified: Net position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v2/exposure/currency/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Exposure summary: Remove subscription description: Removes subscription for the current session identified by subscription id.. operationId: ExposureV2DeleteSubscription parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique id of the subscription required: true schema: type: string example: 0f8fad5b-d9cb-469f-a165-70867728950e responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v2/exposure/currency/subscriptions/{ContextId}': delete: tags: - Exposure summary: Remove multiple subscriptions description: 'Removes multiple all subscriptions for the current session on this resource, and frees all resources on the server.' operationId: ExposureV2DeleteSubscriptions parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: Tag in: query description: Optional. Remove only subscriptions that are marked with specified tag. schema: type: string example: '2345223' responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v2/exposure/currency/subscriptions: post: tags: - Exposure summary: Create a subscription on a list of instrument exposure and make it active description: Sets up a subscription and returns an initial snapshot of list of instrument exposure specified by the parameters in the request. operationId: ExposureV2AddActiveSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/CurrencyExposureSubscriptionRequest' example: Arguments: AccountGroupKey: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 ClientKey: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 CurrencyCode: stringValue PriceMode: RegularTradingHours ContextId: '-' Format: stringValue ReferenceId: '-' RefreshRate: 106 ReplaceReferenceId: '-' Tag: stringValue responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CurrencyExposureSubscriptionResponse' example: ContextId: stringValue Format: stringValue InactivityTimeout: 99 ReferenceId: stringValue RefreshRate: 99 Snapshot: CurrencyExposures: - AmountsInCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInEntityCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInRequestCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Currency: stringValue ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 ValueDateCurrencyExposures: Amounts: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Total: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 NetOpenPositionValue: AmountInEntityCurrency: 10 AmountInRequestCurrency: 10 ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 State: Active Tag: stringValue '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. NoValidInput: No valid input values passed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/CurrencyExposureResponse' /port/v1/exposure/fxspot: get: tags: - Exposure summary: 'Get net FxSpot exposures list for a client, accountGroup or account' description: 'Returns a list of currency exposures from FxSpot positions for a requested client, account group or account.' operationId: ExposureV1GetFxSpotNetExposuresForLoggedInUser parameters: - name: AccountGroupKey in: query description: The key of the account group to which the positions belong. schema: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the positions belong. schema: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the positions belong. required: true schema: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CurrencyExposuresResponseListResult' example: Data: - Amount: 10 AmountInCalculationEntityCurrency: 10 Currency: stringValue MaxRows: 99 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidExchangeId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. InvalidExchangeId: The provided exchange id is invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/exposure/fxspot/me: get: tags: - Exposure summary: 'Get net FxSpot exposures for a client, to which the logged in user belongs' description: 'Returns a list of currency exposures from FxSpot positions for the client, to which the logged in user belongs.' operationId: ExposureV1GetFxSpotNetExposures responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CurrencyExposuresResponseListResult' example: Data: - Amount: 10 AmountInCalculationEntityCurrency: 10 Currency: stringValue MaxRows: 99 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/exposure/currency: get: tags: - Exposure summary: 'Get a currency exposures list for a client, accountGroup or account' description: Returns a list of currencies in which there is an exposure. operationId: ExposureV1GetCurrencyExposuresForLoggedInUser parameters: - name: AccountGroupKey in: query description: The key of the account group to which the positions belong. schema: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the positions belong. schema: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the positions belong. required: true schema: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CurrencyExposuresResponseListResult' example: Data: - Amount: 10 AmountInCalculationEntityCurrency: 10 Currency: stringValue MaxRows: 99 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidExchangeId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. InvalidExchangeId: The provided exchange id is invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/exposure/currency/me: get: tags: - Exposure summary: 'Get currency exposures for a client, to which the logged in user belongs' description: Returns a list of currencies and net exposures. operationId: ExposureV1GetCurrencyExposures responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CurrencyExposuresResponseListResult' example: Data: - Amount: 10 AmountInCalculationEntityCurrency: 10 Currency: stringValue MaxRows: 99 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/exposure/instruments/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Exposure summary: Remove subscription description: Removes subscription for the current session identified by subscription id.. operationId: ExposureV1DeleteSubscription parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique id of the subscription required: true schema: type: string example: 0f8fad5b-d9cb-469f-a165-70867728950e responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/exposure/instruments/subscriptions/{ContextId}': delete: tags: - Exposure summary: Remove multiple subscriptions description: 'Removes multiple all subscriptions for the current session on this resource, and frees all resources on the server.' operationId: ExposureV1DeleteSubscriptions parameters: - name: ContextId in: path description: The context id part of the streaming session (used to identify the subscription within a streaming session). required: true schema: type: string example: '29931122' - name: Tag in: query description: Optional. Remove only subscriptions that are marked with specified tag. schema: type: string example: '2345223' responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/exposure/instruments/subscriptions: post: tags: - Exposure summary: Create a subscription on a list of instrument exposure and make it active description: Sets up a subscription and returns an initial snapshot of list of instrument exposure specified by the parameters in the request. operationId: ExposureV1AddActiveSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/InstrumentExposureSubscriptionRequest' example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== AssetType: FxSpot ClientKey: 7m4I|vtYLUnEGg77o9uQhw== PriceMode: RegularTradingHours Uic: 21 ContextId: '-' Format: stringValue ReferenceId: '-' RefreshRate: 104 ReplaceReferenceId: '-' Tag: stringValue responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/InstrumentExposureSubscriptionResponse' example: ContextId: '20221030064906529' Format: application/json InactivityTimeout: 120 ReferenceId: E68752 RefreshRate: 1000 Snapshot: Data: - Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 State: Active '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. NoValidInput: No valid input values passed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/InstrumentExposureResponseArray' /port/v1/exposure/instruments: get: tags: - Exposure summary: 'Get instrument net exposure list for a client, accountGroup or account' description: Returns a list of instruments in which there is an exposure fulfilling the criteria specified by the query string parameters. operationId: ExposureV1GetInstrumentsExposuresForLoggedInUser parameters: - name: AccountGroupKey in: query description: The key of the account group to which the positions belong. schema: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the positions belong. schema: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: AssetType in: query description: The AssetType. schema: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' example: StockIndexOption - name: ClientKey in: query description: The key of the client to which the positions belong. required: true schema: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: ExpiryDate in: query description: The expiry date. Only used to distinguish FxOptions. schema: title: The expiry date. Only used to distinguish FxOptions. type: string format: date-time x-type-name: UtcDateTime example: '9999-12-31T23:59:59.9999990+00:00' - name: LowerBarrier in: query description: The Lower Barrier. Only used to distinguish Fx Barrier Options. schema: title: The Lower Barrier. Only used to distinguish Fx Barrier Options. type: number example: 2.55 - name: PutCall in: query description: Put or Call. Only used to distinguish FxOptions. schema: title: Put or Call. Only used to distinguish FxOptions. allOf: - $ref: '#/components/schemas/PutCall' example: Put - name: Strike in: query description: The strike price of the option. Only used to distinguish FxOptions. schema: title: The strike price of the option. Only used to distinguish FxOptions. type: number example: 2.55 - name: Uic in: query description: Unique id of the instrument. schema: title: Unique id of the instrument. type: integer format: int32 example: 99 - name: UpperBarrier in: query description: The Upper Barrier. Only used to distinguish Fx Barrier Options. schema: title: The Upper Barrier. Only used to distinguish Fx Barrier Options. type: number example: 2.55 - name: ValueDate in: query description: The value date. Only used to distinguish FxForwards. schema: title: The value date. Only used to distinguish FxForwards. type: string format: date-time x-type-name: UtcDateTime example: '9999-12-31T23:59:59.9999990+00:00' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InstrumentExposureResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidExchangeId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. InvalidExchangeId: The provided exchange id is invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '204': description: No Content '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/exposure/instruments/me: get: tags: - Exposure summary: 'Get the net instrument exposure for a client, to which the logged in user belongs' description: Returns a list instruments and net exposures. operationId: ExposureV1GetInstrumentsExposures responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InstrumentExposureResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/balances/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Balances summary: Remove subscription description: Removes subscription for the current session identified by subscription id. operationId: BalancesV1DeleteSubscription parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique ID of the subscription required: true schema: type: string example: B345356 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/balances/subscriptions/{ContextId}': delete: tags: - Balances summary: Remove all subscriptions marked with a specific tag description: Removes multiple subscriptions for the current session on this resource and frees all resources on the server. operationId: BalancesV1DeleteSubscriptions parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: Tag in: query description: Tag that subscriptions are marked with. schema: type: string example: PAGE1 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/balances/subscriptions: post: tags: - Balances summary: Create a subscription on a balance description: Sets up a subscription and returns an initial snapshot of a balance. operationId: BalancesV1AddActiveSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/BalanceSubscriptionRequest' example: Arguments: AccountGroupKey: AccountKey: ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ContextId: '20221030064906306' ReferenceId: B49083 RefreshRate: 500 Tag: MyBalancesRelatedSubscriptions responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BalanceSubscriptionResponse' example: ContextId: '20221030064906306' Format: application/json InactivityTimeout: 1500 ReferenceId: B49083 RefreshRate: 500 Snapshot: CalculationReliability: Ok CashAvailableForTrading: 100573853.73 CashBalance: 100573853.73 CashBlocked: 0 ChangesScheduled: false ClosedPositionsCount: 0 CollateralAvailable: 99839075.64 CorporateActionUnrealizedAmounts: 0 CostToClosePositions: -1677.57 Currency: EUR CurrencyDecimals: 0 InitialMargin: CollateralAvailable: 12254541.55 MarginAvailable: 12254541.55 MarginCollateralNotAvailable: 0 MarginUsedByCurrentPositions: -1225544.66 MarginUtilizationPct: 15.11 NetEquityForMargin: 1222521.77 OtherCollateralDeduction: 0 IntradayMarginDiscount: 0 IsPortfolioMarginModelSimple: true MarginAndCollateralUtilizationPct: 0.38 MarginAvailableForTrading: 99839075.64 MarginCollateralNotAvailable: -468419.84 MarginExposureCoveragePct: 344.35 MarginNetExposure: 29088391.02 MarginUsedByCurrentPositions: -326828.87 MarginUtilizationPct: 0.33 NetEquityForMargin: 85539075.64 NetPositionsCount: 0 NonMarginPositionsValue: 509207.41 OpenIpoOrdersCount: 0 OpenPositionsCount: 0 OptionPremiumsMarketValue: 0 OrdersCount: 0 OtherCollateral: 103798.26 SettlementValue: 0 ShareSpendingPower: 50 SpendingPower: 50 SpendingPowerDetail: Current: 50 Maximum: 50 SrdSpendingPower: 50 TotalValue: 100634324.36 TransactionsNotBooked: -118.71 TriggerOrdersCount: 0 UnrealizedMarginClosedProfitLoss: 0 UnrealizedMarginOpenProfitLoss: 0 UnrealizedMarginProfitLoss: -550738.76 UnrealizedPositionsValue: -43208.92 State: Active Tag: MyBalancesRelatedSubscriptions '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. NoValidInput: No valid input values passed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/BalanceResponse' /port/v1/balances/marginoverview: get: tags: - Balances summary: Get margin overview description: 'Get margin overview for a client, account group or an account' operationId: BalancesV1GetMarginOverview parameters: - name: AccountGroupKey in: query description: The key of the account group for which the margin overview is returned schema: title: The key of the account group for which the margin overview is returned minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account for which the margin overview is returned schema: title: The key of the account for which the margin overview is returned minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client for which the margin overview is returned required: true schema: title: The key of the client for which the margin overview is returned minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MarginOverviewByGroup' example: Groups: - Contributors: - AssetTypes: - FxSpot InstrumentDescription: EURUSD description InstrumentSpecifier: EURUSD Margin: 1235 Uic: 21 - AssetTypes: - FxSpot InstrumentDescription: GBPUSD description InstrumentSpecifier: GBPUSD Margin: 789 Uic: 22 GroupType: FX TotalMargin: 100000 - Contributors: - AssetTypes: - CfdOnIndex InstrumentDescription: SP500 description InstrumentSpecifier: SP500.I Margin: 4321 Uic: 4910 - AssetTypes: - CfdOnIndex InstrumentDescription: CSE20 description InstrumentSpecifier: CSE20.I Margin: 975 Uic: 5768 - AssetTypes: - CfdOnIndex InstrumentDescription: DAX description InstrumentSpecifier: DAX.I Margin: 864 Uic: 27098 GroupType: CFDs TotalMargin: 200000 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/balances: get: tags: - Balances summary: Get balance description: 'Get balance data for a client, account group or an account' operationId: GET_BalancesV1GetBalance parameters: - name: AccountGroupKey in: query description: The key of the account group for which the balance data is returned schema: title: The key of the account group for which the balance data is returned minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account for which the balance data is returned schema: title: The key of the account for which the balance data is returned minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client for which the balance data is returned required: true schema: title: The key of the client for which the balance data is returned minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: FieldGroups in: query description: Specifies which data to return. schema: title: Specifies which data to return. type: array items: $ref: '#/components/schemas/BalanceFieldGroup' example: - MarginOverview responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BalanceResponse' example: CalculationReliability: Ok CashAvailableForTrading: 100573853.73 CashBalance: 100573853.73 CashBlocked: 0 ChangesScheduled: false ClosedPositionsCount: 0 CollateralAvailable: 99839075.64 CorporateActionUnrealizedAmounts: 0 CostToClosePositions: -1677.57 Currency: EUR CurrencyDecimals: 0 InitialMargin: CollateralAvailable: 12254541.55 MarginAvailable: 12254541.55 MarginCollateralNotAvailable: 0 MarginUsedByCurrentPositions: -1225544.66 MarginUtilizationPct: 15.11 NetEquityForMargin: 1222521.77 OtherCollateralDeduction: 0 IntradayMarginDiscount: 0 IsPortfolioMarginModelSimple: true MarginAndCollateralUtilizationPct: 0.38 MarginAvailableForTrading: 99839075.64 MarginCollateralNotAvailable: -468419.84 MarginExposureCoveragePct: 344.35 MarginNetExposure: 29088391.02 MarginUsedByCurrentPositions: -326828.87 MarginUtilizationPct: 0.33 NetEquityForMargin: 85539075.64 NetPositionsCount: 0 NonMarginPositionsValue: 509207.41 OpenIpoOrdersCount: 0 OpenPositionsCount: 0 OptionPremiumsMarketValue: 0 OrdersCount: 0 OtherCollateral: 103798.26 SettlementValue: 0 SpendingPowerDetail: Current: 50 Maximum: 50 TotalValue: 100634324.36 TransactionsNotBooked: -118.71 TriggerOrdersCount: 0 UnrealizedMarginClosedProfitLoss: 0 UnrealizedMarginOpenProfitLoss: 0 UnrealizedMarginProfitLoss: -550738.76 UnrealizedPositionsValue: -43208.92 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/balances/me: get: tags: - Balances summary: Get balance data for logged-in client description: Get balance data for logged-in client. operationId: BalancesV1GetBalance responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BalanceResponse' example: CalculationReliability: Ok CashAvailableForTrading: 100573853.73 CashBalance: 100573853.73 CashBlocked: 0 ChangesScheduled: false ClosedPositionsCount: 0 CollateralAvailable: 99839075.64 CorporateActionUnrealizedAmounts: 0 CostToClosePositions: -1677.57 Currency: EUR CurrencyDecimals: 0 InitialMargin: CollateralAvailable: 12254541.55 MarginAvailable: 12254541.55 MarginCollateralNotAvailable: 0 MarginUsedByCurrentPositions: -1225544.66 MarginUtilizationPct: 15.11 NetEquityForMargin: 1222521.77 OtherCollateralDeduction: 0 IntradayMarginDiscount: 0 IsPortfolioMarginModelSimple: true MarginAndCollateralUtilizationPct: 0.38 MarginAvailableForTrading: 99839075.64 MarginCollateralNotAvailable: -468419.84 MarginExposureCoveragePct: 344.35 MarginNetExposure: 29088391.02 MarginUsedByCurrentPositions: -326828.87 MarginUtilizationPct: 0.33 NetEquityForMargin: 85539075.64 NetPositionsCount: 0 NonMarginPositionsValue: 509207.41 OpenIpoOrdersCount: 0 OpenPositionsCount: 0 OptionPremiumsMarketValue: 0 OrdersCount: 0 OtherCollateral: 103798.26 SettlementValue: 0 SpendingPowerDetail: Current: 50 Maximum: 50 TotalValue: 100634324.36 TransactionsNotBooked: -118.71 TriggerOrdersCount: 0 UnrealizedMarginClosedProfitLoss: 0 UnrealizedMarginOpenProfitLoss: 0 UnrealizedMarginProfitLoss: -550738.76 UnrealizedPositionsValue: -43208.92 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/users/me/entitlements: get: tags: - Users summary: Get all entitlements description: This operation retrieves a list of all client specific entitlements per exchanges for market data. operationId: UsersV1GetAllClientEntitlements responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EntitlementDetailsListResult' example: Data: - Entitlements: - Greeks: - CertificateConstantLeverage RealTimeFullBook: - CertificateBonus RealTimeTopOfBook: - CertificateUncappedOutperformance ExchangeId: stringValue MaxRows: 99 '204': description: Indicates no information about client entitlement is available with the service. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/users: get: tags: - Users summary: Get all users under a particular owner description: Get all users under a particular owner. operationId: UsersV1GetUsers parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 1000 example: 1 - name: ClientKey in: query description: 'Unique key identifying the owner. This is the ClientKey of the client under which the list of users belongs. Default: Logged-in user''s client.' schema: title: 'Unique key identifying the owner. This is the ClientKey of the client under which the list of users belongs. Default: Logged-in user''s client.' minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: IncludeSubUsers in: query description: Set to true if users of all underlying partners should be included in output. schema: title: Set to true if users of all underlying partners should be included in output. type: boolean example: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponseListResult' example: Data: - ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== Culture: en-GB Language: en LastLoginStatus: Successful LastLoginTime: '2022-10-28T03:49:04.265885Z' LegalAssetTypes: - FxSpot - Stock - ContractFutures MarketDataViaOpenApiTermsAccepted: false Name: Mr. Anthony Test TimeZoneId: 28 UserId: '654321' UserKey: V-B8jOk9SM8QdqN1u2Bjtw== MaxRows: 99 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - RequestContainsClientKeyAndEntityRelations type: string example: None x-enum-descriptions: InvalidClientId: Indicates that the requested client id was invalid. RequestContainsClientKeyAndEntityRelations: Request can not contain both ClientKey and EntityRelations. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/users/{UserKey}': get: tags: - Users summary: Get the details about a user description: Get the details about a user operationId: GET_UsersV1GetUser parameters: - name: UserKey in: path description: The unique key for the user's client. required: true schema: minLength: 1 type: string x-type-name: UserKey example: 5DG7K1P5cqYBZ77tl7Af4w== responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' example: ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== Culture: en-GB Language: en LastLoginStatus: Successful LastLoginTime: '2022-10-28T03:49:04.265885Z' LegalAssetTypes: - FxSpot - Stock - ContractFutures MarketDataViaOpenApiTermsAccepted: false Name: Mr. Anthony Test TimeZoneId: 28 UserId: '654321' UserKey: V-B8jOk9SM8QdqN1u2Bjtw== '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidUserId type: string example: None x-enum-descriptions: InvalidUserId: The requested user id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/users/me: get: tags: - Users summary: Get details about the logged in user description: Get details about the logged in user. operationId: UsersV1GetUser responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' example: ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== Culture: en-GB Language: en LastLoginStatus: Successful LastLoginTime: '2022-10-28T03:49:04.265885Z' LegalAssetTypes: - FxSpot - Stock - ContractFutures MarketDataViaOpenApiTermsAccepted: false Name: Mr. Anthony Test TimeZoneId: 28 UserId: '654321' UserKey: V-B8jOk9SM8QdqN1u2Bjtw== '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidUserId type: string example: None x-enum-descriptions: InvalidUserId: The requested user id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read patch: tags: - Users summary: Update user preferences description: 'Enables the user to update preferred language, culture and timezone.' operationId: UsersV1UpdateUserPreferences requestBody: content: application/json: schema: $ref: '#/components/schemas/UserUpdateRequest' responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidInput - InvalidUserId - NoValidInput type: string example: None x-enum-descriptions: InvalidUserId: The requested user id was invalid. NoValidInput: No valid input values passed. InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write '/port/v1/positions/subscriptions/{ContextId}': delete: tags: - Positions summary: 'Remove multiple subscriptions for the given ContextId, optionally marked with a specific tag' description: 'Removes multiple subscriptions for the current session on this resource, and frees all resources on the server.' operationId: PositionsV1DeleteSubscriptions parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: Tag in: query description: Tag that subscriptions are marked with schema: type: string example: TAB15 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/positions/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Positions summary: Remove subscription description: Removes subscription for the current session identified by subscription id. operationId: PositionsV1DeleteSubscription parameters: - name: ContextId in: path description: The context id part of the streaming session. required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique ID of the subscription required: true schema: type: string example: P54123 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe patch: tags: - Positions summary: Change the positions subscription page size description: "Extends or reduces the page size, number of positions shown, on a running positions subscription.\n When expanding the page size, the new positions are streamed so to avoid race conditions." operationId: PositionsV1UpdatePositionSubscriptionPagesize parameters: - name: ContextId in: path description: The context id part of the streaming session. required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique ID of the subscription required: true schema: type: string example: P54123 requestBody: content: application/json: schema: $ref: '#/components/schemas/PositionPagingSubscriptionUpdateRequest' example: NewPageSize: 99 responses: '204': description: No Content '202': description: Subscription change will be processed and respose will be streamed. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/positions/subscriptions: post: tags: - Positions summary: Create a subscription on a list positions and make it active description: Sets up a subscription and returns an initial snapshot of list of positions specified by the parameters in the request. operationId: PositionsV1AddActiveSubscription parameters: - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/PositionsSubscriptionRequest' example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== FieldGroups: - PositionBase - PositionView NetPositionId: GBPUSD_FxSpot PositionId: '1019942425' PriceMode: RegularTradingHours ContextId: '20221030064905734' Format: application/json ReferenceId: P48094 RefreshRate: 1000 Tag: PAGE1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PositionsSubscriptionResponse' example: Format: application/json InactivityTimeout: 120 ReferenceId: P11029 RefreshRate: 1000 Snapshot: Data: - NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 State: Active '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - SubscriptionExceedesPositionsLimit - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. NoValidInput: No valid input values passed. SubscriptionExceedesPositionsLimit: Too many positions requested. Streaming updates are only allowed on a limited number of positions. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/PositionResponseArray' /port/v1/positions: get: tags: - Positions summary: 'Get positions for a client, account group, account or a position' description: Returns a list of positions fulfilling the criteria specified by the query string parameters. operationId: GET_PositionsV1GetPositions parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: AccountGroupKey in: query description: The key of the account group to which the net positions belongs. schema: title: The key of the account group to which the net positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the net positions belongs. schema: title: The key of the account to which the net positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the net positions belongs. required: true schema: title: The key of the client to which the net positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: FieldGroups in: query description: 'Specifies which data to return. Default is [PositionBase,PositionView]' schema: title: 'Specifies which data to return. Default is [PositionBase,PositionView]' type: array items: $ref: '#/components/schemas/PositionFieldGroup' example: - PositionView - name: NetPositionId in: query description: The id of the netposition to which the position belongs schema: title: The id of the netposition to which the position belongs type: string example: stringValue - name: PositionId in: query description: The id of the position. schema: title: The id of the position. type: string example: stringValue - name: WatchlistId in: query description: Selects only positions those instruments belongs to the given watchlist id schema: title: Selects only positions those instruments belongs to the given watchlist id type: string example: stringValue responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PositionResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/positions/me: get: tags: - Positions summary: Get positions for the logged-in client operationId: PositionsV1GetPositions parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: FieldGroups in: query description: 'Optional. Specifies which data to return. Default is [PositionBase, PositionView]' required: true schema: type: array items: $ref: '#/components/schemas/PositionFieldGroup' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PositionResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/positions/{PositionId}/details': get: tags: - Positions summary: Get detailed information for a single position description: "Obsolete Gets detailed information about a single position as specified by the query parameters.\n NOTE: This endpoint will be deprecated by November 2022. All functionality has been migrated to /port/v1/positions/{PositionId}. Fields available in this resource are moved to PositionBase and the new \"Costs\" fieldgroup that has been added to the base route. These fields also support streaming now." operationId: PositionsV1GetPositionDetails parameters: - name: AccountGroupKey in: query description: The key of the account group to which the net positions belongs. schema: title: The key of the account group to which the net positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the net positions belongs. schema: title: The key of the account to which the net positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the net positions belongs. required: true schema: title: The key of the client to which the net positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: PositionId in: path description: Unique id of the position. required: true schema: type: string example: '167968381' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PositionDetailedResponse' example: DisplayAndFormat: Currency: EUR Decimals: 4 Description: British Pound/US Dollar Format: AllowDecimalPips Symbol: GBPUSD NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - PositionIdNotSpecified type: string example: None x-enum-descriptions: PositionIdNotSpecified: Position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' deprecated: true security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-deprecated-date: '2022-11-01' x-required-permissions: personal: Read community: Read '/port/v1/positions/{PositionId}': get: tags: - Positions summary: Get a single position description: Get a single position operationId: PositionsV1GetPosition parameters: - name: AccountGroupKey in: query description: The key of the account group to which the net positions belongs. schema: title: The key of the account group to which the net positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the net positions belongs. schema: title: The key of the account to which the net positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the net positions belongs. required: true schema: title: The key of the client to which the net positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: FieldGroups in: query description: 'Specifies which data to return. Default is [PositionBase,PositionView]' schema: title: 'Specifies which data to return. Default is [PositionBase,PositionView]' type: array items: $ref: '#/components/schemas/PositionFieldGroup' example: - PositionView - name: PositionId in: path description: Unique ID of the position. required: true schema: type: string example: '167968381' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PositionResponse' example: NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - PositionIdNotSpecified type: string example: None x-enum-descriptions: PositionIdNotSpecified: Position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/orders/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Orders summary: Remove subscription description: Removes subscription for the current session identified by subscription id.. operationId: OrdersV1DeleteSubscription parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique reference ID of the subscription. required: true schema: type: string example: O2246 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/orders/subscriptions/{ContextId}': delete: tags: - Orders summary: Remove multiple subscriptions description: Removes multiple subscriptions for the current session on this resource. Optionally maked with with speccified Tag. operationId: OrdersV1DeleteSubscriptions parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: Tag in: query description: Optional. Tag that subscriptions are marked with. schema: type: string example: PAGE2 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/orders/subscriptions: post: tags: - Orders summary: Create a subscription to open orders description: Sets up a subscription and returns an initial snapshot of list of orders specified by the parameters in the request. operationId: OrdersV1AddActiveSubscription parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $skiptoken in: query description: Specifies an entity id to start retrieving entries from. This is normally only used in generated nextlinks. schema: type: string example: B17D8890-3C7A-4A47-A9AA-01B022ED03A5 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderSubscriptionRequest' example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ContextId: '20221030064905457' Format: application/json ReferenceId: O40952 RefreshRate: 5 Tag: PAGE1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/OrderSubscriptionResponse' example: Format: application/json InactivityTimeout: 120 ReferenceId: O03905 RefreshRate: 1000 Snapshot: Data: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsExtendedHoursEnabled: false IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 PriceWithoutSpread: 1.04 Status: Working Uic: 21 State: Active '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - NoValidInput - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. NoValidInput: No valid input values passed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/OrderResponseArray' '/port/v1/orders/{OrderId}/details': get: tags: - Orders summary: Get detailed information for a open order description: "Obsolete Gets detailed information about a single open order as specified by the query parameters.\n NOTE: This endpoint will be deprecated by November 2022. All functionality has been migrated to /port/v1/orders/{OrderId}." operationId: OrdersV1GetOpenOrderDetails parameters: - name: AccountGroupKey in: query description: The key of the account group to which the net positions belongs. schema: title: The key of the account group to which the net positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: The key of the account to which the net positions belongs. schema: title: The key of the account to which the net positions belongs. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: The key of the client to which the net positions belongs. required: true schema: title: The key of the client to which the net positions belongs. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: OrderId in: path description: Unique id of the order. required: true schema: type: string example: '83749234' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderResponse' example: AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 Status: Working Uic: 21 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - PositionIdNotSpecified type: string example: None x-enum-descriptions: PositionIdNotSpecified: Position not specified. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' deprecated: true security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-deprecated-date: '2022-11-01' x-required-permissions: personal: Read community: Read /port/v1/orders: get: tags: - Orders summary: Get all open orders for a client or an account description: You can use this operation to get all the open orders on an account or a client. operationId: GET_OrdersV1GetOpenOrders parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: AccountGroupKey in: query description: The key of the account group to which the order belongs. schema: title: The key of the account group to which the order belongs. minLength: 1 type: string x-type-name: AccountGroupKey example: stringValue - name: AccountKey in: query description: Unique key identifying the account that owns the orders. schema: title: Unique key identifying the account that owns the orders. minLength: 1 type: string x-type-name: AccountKey example: 01b64edf-da03-4145-bf33-ae21527d4c86 - name: ClientKey in: query description: Unique key identifying the client that owns the orders. required: true schema: title: Unique key identifying the client that owns the orders. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: FieldGroups in: query description: 'Specifies which data to return. Default is empty, meaning Display and Formatting information is not included.' schema: title: 'Specifies which data to return. Default is empty, meaning Display and Formatting information is not included.' type: array items: $ref: '#/components/schemas/OrderFieldGroup' example: - ExchangeInfo - name: OrderId in: query description: The id of the order schema: title: The id of the order type: string example: stringValue - name: Status in: query description: Selects only a subset of open orders to be returned. Default is to return working orders only. schema: title: Selects only a subset of open orders to be returned. Default is to return working orders only. allOf: - $ref: '#/components/schemas/OrderStatusFilter' example: All - name: WatchlistId in: query description: Selects only orders those instruments belongs to the given watchlist id schema: title: Selects only orders those instruments belongs to the given watchlist id type: string example: stringValue responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 Status: Working Uic: 21 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidInput: An error was encountered when processing given input parameters. InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/orders/me: get: tags: - Orders summary: Get all open orders for the client to which the logged-in user belongs description: You can use this operation to get all open orders across all accounts for the client to which the logged-in user belongs. operationId: OrdersV1GetOpenOrders parameters: - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 0 example: 1 - name: FieldGroups in: query description: Optional. Specification of FieldGroups to be included in response model. Defaults to "ExchangeInfo" if not provided. required: true schema: type: array items: $ref: '#/components/schemas/OrderFieldGroup' - name: MultiLegOrderId in: query description: Return only multi-leg orders with the given common MultiLegOrderId. schema: type: string - name: Status in: query description: Optional. Selects only a subset of open orders to be returned based on status of the open order. Default is "Working" (i.e. orders related to working orders are excluded). schema: $ref: '#/components/schemas/OrderStatusFilter' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 Status: Working Uic: 21 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/orders/{ClientKey}/{OrderId}': get: tags: - Orders summary: Get a single open order description: Call this operation to get a specific open order of a client. operationId: OrdersV1GetOpenOrder parameters: - name: ClientKey in: path description: Unique id of the client. required: true schema: minLength: 1 type: string x-type-name: ClientKey example: U8SNV3JLdN4gzcQfmThXJA== - name: FieldGroups in: query description: Optional. Specification of FieldGroups to be included in response model. Defaults to "ExchangeInfo" if not provided. required: true schema: type: array items: $ref: '#/components/schemas/OrderFieldGroup' - name: OrderId in: path description: Unique id of the order. required: true schema: type: string example: '5007186409' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 Status: Working Uic: 21 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - OrderIdNotSpecified type: string example: None x-enum-descriptions: OrderIdNotSpecified: Order not specified. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/clients: get: tags: - Clients summary: Get details about clients under a particular owner description: This endpoint will return information for all clients under the specified owner as well as the owner itself. operationId: ClientsV1GetClients parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 1000 example: 1 - name: OwnerKey in: query description: 'Unique key identifying the owner. This is the clientKey of the client under which the list of clients belongs. Default: Logged-in user''s client.' schema: title: 'Unique key identifying the owner. This is the clientKey of the client under which the list of clients belongs. Default: Logged-in user''s client.' minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClientResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AllowedTradingSessions: Regular ClientId: '654321' ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== CurrencyDecimals: 0 DefaultAccountId: 192134INET DefaultAccountKey: uke8gbCUrk6l7TnS5fnIdQ== DefaultCurrency: EUR ForceOpenDefaultValue: false IsMarginTradingAllowed: false IsVariationMarginEligible: false LegalAssetTypes: - Stock - FxSpot - CfdOnStock - Bond - ContractFutures LegalAssetTypesAreIndicative: false MarginCalculationMethod: Default Name: Mr. Anthony Test PositionNettingMethod: FIFO PositionNettingMode: EndOfDay PositionNettingProfile: FifoEndOfDay ReduceExposureOnly: false SupportsAccountValueProtectionLimit: false '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - OwnerKeyMissing - RequestContainsOwnerKeyAndEntityRelations type: string example: None x-enum-descriptions: InvalidClientId: Indicates that the requested client id was invalid. OwnerKeyMissing: No valid input owner key specified. RequestContainsOwnerKeyAndEntityRelations: Request can not contain both OwnerKey and EntityRelations. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read patch: tags: - Clients summary: Enables IB to switch position netting mode(or netting profile) and change AccountValueProtectionLimit description: Enables IB to switch position netting mode(or netting profile) and change account value protection limit on behalf of its clients. operationId: ClientsV1UpdateClientSettingsForPartner parameters: - name: ClientKey in: query description: clientKey of the client that to switch. required: true schema: minLength: 1 type: string x-type-name: ClientKey requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientUpdateRequest' example: AccountValueProtectionLimit: 10 ForceOpenDefaultValue: false NewPositionNettingMode: Intraday NewPositionNettingProfile: FifoEndOfDay responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - ClientPositionNettingModeSwitchNotAllowed - ClientPositionNettingModeSwitchNotAllowedByConfiguration - InvalidInput type: string example: None x-enum-descriptions: InvalidInput: An error was encountered when processing given input parameters. ClientPositionNettingModeSwitchNotAllowed: All orders related to positions must be removed before real-time netting can be enabled. ClientPositionNettingModeSwitchNotAllowedByConfiguration: The partner configuration does not allow changing the Netting Mode. No changes have been made. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write '/port/v1/clients/{ClientKey}': get: tags: - Clients summary: Get client details description: Get details about a client operationId: GET_ClientsV1GetClient parameters: - name: ClientKey in: path description: Unique key identifying the Client. required: true schema: minLength: 1 type: string x-type-name: ClientKey example: 5DG7K1P5cqYBZ77tl7Af4w== responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClientResponse' example: AllowedTradingSessions: Regular ClientId: '654321' ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== CurrencyDecimals: 0 DefaultAccountId: 192134INET DefaultAccountKey: uke8gbCUrk6l7TnS5fnIdQ== DefaultCurrency: EUR ForceOpenDefaultValue: false IsMarginTradingAllowed: false IsVariationMarginEligible: false LegalAssetTypes: - Stock - FxSpot - CfdOnStock - Bond - ContractFutures LegalAssetTypesAreIndicative: false MarginCalculationMethod: Default Name: Mr. Anthony Test PositionNettingMethod: FIFO PositionNettingMode: EndOfDay PositionNettingProfile: FifoEndOfDay ReduceExposureOnly: false SupportsAccountValueProtectionLimit: false '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId type: string example: None x-enum-descriptions: InvalidClientId: Indicates that the requested client id was invalid. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/clients/me: get: tags: - Clients summary: Get logged in client details description: Get details about logged-in user's client operationId: ClientsV1GetClient responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClientResponse' example: AllowedTradingSessions: Regular ClientId: '654321' ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== CurrencyDecimals: 0 DefaultAccountId: 192134INET DefaultAccountKey: uke8gbCUrk6l7TnS5fnIdQ== DefaultCurrency: EUR ForceOpenDefaultValue: false IsMarginTradingAllowed: false IsVariationMarginEligible: false LegalAssetTypes: - Stock - FxSpot - CfdOnStock - Bond - ContractFutures LegalAssetTypesAreIndicative: false MarginCalculationMethod: Default Name: Mr. Anthony Test PositionNettingMethod: FIFO PositionNettingMode: EndOfDay PositionNettingProfile: FifoEndOfDay ReduceExposureOnly: false SupportsAccountValueProtectionLimit: false '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read patch: tags: - Clients summary: Enables user to switch position netting mode or netting profile description: Enables user of the client to switch position netting mode or netting profile of its own. operationId: ClientsV1UpdateClientSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientUpdateRequest' example: AccountValueProtectionLimit: 10 ForceOpenDefaultValue: false NewPositionNettingMode: Intraday NewPositionNettingProfile: FifoEndOfDay responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - ClientPositionNettingModeSwitchNotAllowed - ClientPositionNettingModeSwitchNotAllowedByConfiguration - InvalidInput type: string example: None x-enum-descriptions: InvalidInput: An error was encountered when processing given input parameters. ClientPositionNettingModeSwitchNotAllowed: All orders related to positions must be removed before real-time netting can be enabled. ClientPositionNettingModeSwitchNotAllowedByConfiguration: The partner configuration does not allow changing the Netting Mode. No changes have been made. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write '/port/v1/accounts/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Accounts summary: Remove subscription description: Removes subscription for the current session identified by subscription id. operationId: AccountsV1DeleteSubscription parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session required: true schema: type: string example: '29931122' - name: ReferenceId in: path description: Unique reference ID of the subscription. required: true schema: type: string example: A74231 responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe '/port/v1/accounts/subscriptions/{ContextId}': delete: tags: - Accounts summary: Remove subscriptions by tag description: 'Removes all subscriptions for the current session on this resource marked with a specific tag, and frees all resources on the server.' operationId: AccountsV1DeleteSubscriptions parameters: - name: ContextId in: path description: Unique streaming context ID part of the streaming session. required: true schema: type: string example: '29931122' - name: Tag in: query description: Tag that subscriptions are marked with schema: type: string example: CORE responses: '204': description: No Content '202': description: Subscription delete request will be processed eventually. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe /port/v1/accounts/subscriptions: post: tags: - Accounts summary: Subscribe to accounts description: 'Creates a subscription on a list accounts, makes it active and returns an initial snapshot containing a list of accounts as specified by the parameters in the request.' operationId: AccountsV1AddActiveSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountsSubscriptionRequest' example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ContextId: '20221030064905067' Format: application/json ReferenceId: A21312 RefreshRate: 500 Tag: MyAccountRelatedSubscriptions responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/AccountsSubscriptionResponse' example: ContextId: '20221030064905073' Format: application/json InactivityTimeout: 1500 ReferenceId: A70755 RefreshRate: 500 Snapshot: Data: - AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false State: Active Tag: MyAccountRelatedSubscriptions '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidClientId - InvalidInput - InvalidModelState - UnsupportedSubscriptionFormat type: string example: None x-enum-descriptions: InvalidModelState: Error code returned when model state is invalid. UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested. InvalidClientId: Indicates that the requested client id was invalid. InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '409': description: Conflict content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionLimitExceeded type: string example: None x-enum-descriptions: SubscriptionLimitExceeded: 'Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.' Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Subscribe community: Subscribe x-streaming-type: $ref: '#/components/schemas/AccountResponseArray' '/port/v1/accounts/{AccountKey}/reset': put: tags: - Accounts summary: Reset trial account description: Resets a trial account. Cannot be used in live environment. operationId: AccountsV1ResetAccount parameters: - name: AccountKey in: path description: Required unique key identifying the account. required: true schema: minLength: 1 type: string x-type-name: AccountKey example: LZTc7DdejXODf-WSl2aCyQ== requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountResetRequest' example: NewBalance: 50000000 responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - NoValidInput - ResetAccountBalanceExceedsMaximum - ResetAccountNegativeBalanceNotAllowed type: string example: None x-enum-descriptions: ResetAccountNegativeBalanceNotAllowed: Negative balances are not allowed. ResetAccountBalanceExceedsMaximum: Balance exceeds maximum allowed value. NoValidInput: No valid input values passed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write /port/v1/accounts: get: tags: - Accounts summary: Get accounts of a client description: Returns a list of all accounts owned by the specified client operationId: GET_AccountsV1GetAccounts parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 1000 example: 1 - name: ClientKey in: query description: 'The client to which the accounts belong. Default: Logged-in user''s client.' schema: title: 'The client to which the accounts belong. Default: Logged-in user''s client.' minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 - name: IncludeSubAccounts in: query description: Optionally set true to request that all sub accounts are returned. schema: title: Optionally set true to request that all sub accounts are returned. type: boolean example: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/accounts/me: get: tags: - Accounts summary: Get accounts description: Returns all accounts under a particular client to which the logged in user belongs. operationId: AccountsV1GetAccounts parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 1000 example: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountResponseListResult' example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/accounts/{AccountKey}': get: tags: - Accounts summary: Get account description: Returns the details about a single account operationId: AccountsV1GetAccount parameters: - name: AccountKey in: path description: Unique key for the account. required: true schema: minLength: 1 type: string x-type-name: AccountKey example: LZTc7DdejXODf-WSl2aCyQ== responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountResponse' example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidInput type: string example: None x-enum-descriptions: InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read patch: tags: - Accounts summary: Update account description: 'Updates account details, particularly the user account shield value, the benchmark instrument or the account display name.' operationId: AccountsV1UpdateAccount parameters: - name: AccountKey in: path description: Unique key of the account to share. required: true schema: minLength: 1 type: string x-type-name: AccountKey example: LZTc7DdejXODf-WSl2aCyQ== requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRequest' example: DisplayName: Trading Account responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - DisableUseCashPositionsAsMarginCollateralNotAllowed - InvalidInput - NoValidInput - WouldExceedMargin type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidInput: An error was encountered when processing given input parameters. WouldExceedMargin: 'Disabling UseCashPositionsAsMarginCollateral would cause the account margin limits to be exceeded and is not allowed. To change this setting, please increase account collateral or reduce margin exposure first.' DisableUseCashPositionsAsMarginCollateralNotAllowed: Disabling UseCashPositionsAsMarginCollateral not allowed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write /port/v1/accountgroups: get: tags: - AccountGroups summary: Get a list of all accounts groups used by the specified client description: Get a list of all account groups used by the specified client operationId: AccountGroupsV1GetAccountGroups parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 1000 example: 1 - name: ClientKey in: query description: The client to which the account groups belong. required: true schema: title: The client to which the account groups belong. minLength: 1 type: string x-type-name: ClientKey example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountGroupResponseListResult' example: Data: - AccountGroupKey: stringValue AccountGroupName: stringValue AccountValueProtectionLimit: 10 CollateralMonitoringMode: MaxOfCollateralCreditValueAndCollateralCreditLine MarginCalculationMethod: Default MarginLendingEnabled: No MarginMonitoringMode: Equity PortfolioBasedMarginEnabled: false SupportsAccountValueProtectionLimit: true MaxRows: 99 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read /port/v1/accountgroups/me: get: tags: - AccountGroups summary: Get all accounts groups under a particular client to which the logged in user belongs description: Get all accounts gropus under a particular client to which the logged in user belongs. operationId: AccountGroupsV1GetAccountGroupsForLoggedInUser parameters: - name: $inlinecount in: query description: Specifies that the response to the request should include a count of the number of entries in the collection schema: enum: - AllPages - None type: string x-enum-descriptions: None: The result will not contain an inline count AllPages: The result will contain a total count of items in the queried collection example: AllPages - name: $skip in: query description: The number of entries to skip from the beginning of the collection schema: minimum: 0 type: integer format: int32 example: 1 - name: $top in: query description: The number of entries to return from the beginning of the collection schema: minimum: 0 type: integer format: int32 default: 1000 example: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountGroupResponseListResult' example: Data: - AccountGroupKey: stringValue AccountGroupName: stringValue AccountValueProtectionLimit: 10 CollateralMonitoringMode: MaxOfCollateralCreditValueAndCollateralCreditLine MarginCalculationMethod: Default MarginLendingEnabled: No MarginMonitoringMode: Equity PortfolioBasedMarginEnabled: false SupportsAccountValueProtectionLimit: true MaxRows: 99 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read '/port/v1/accountgroups/{AccountGroupKey}': get: tags: - AccountGroups summary: Get details about a single account group description: Get details about a single account group operationId: AccountGroupsV1GetAccountGroup parameters: - name: AccountGroupKey in: path description: Unique key for the account group. required: true schema: minLength: 1 type: string x-type-name: AccountGroupKey example: LZTc7DdejXODf-WSl2aCyQ== - name: ClientKey in: query description: The key of the client to which the account group belong. required: true schema: minLength: 1 type: string x-type-name: ClientKey example: 5DG7K1P5cqYBZ77tl7Af4w== responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountGroupResponse' example: AccountGroupKey: stringValue AccountGroupName: stringValue AccountValueProtectionLimit: 10 CollateralMonitoringMode: MaxOfCollateralCreditValueAndCollateralCreditLine MarginCalculationMethod: SpanForFuturesAndOptions MarginLendingEnabled: None MarginMonitoringMode: Margin PortfolioBasedMarginEnabled: false SupportsAccountValueProtectionLimit: true '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidInput type: string example: None x-enum-descriptions: InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Read community: Read patch: tags: - AccountGroups summary: Update account group information description: Enables the user to update account group settings. Particularly the account group AccountValueProtectionLimit . operationId: AccountGroupsV1UpdateAccountGroup parameters: - name: AccountGroupKey in: path description: Unique key of the account group to change. required: true schema: minLength: 1 type: string x-type-name: AccountGroupKey example: LZTc7DdejXODf-WSl2aCyQ== - name: ClientKey in: query description: The key of the client to which the account group belong. required: true schema: minLength: 1 type: string x-type-name: ClientKey example: 5DG7K1P5cqYBZ77tl7Af4w== requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountGroupUpdateRequest' example: AccountValueProtectionLimit: 10 responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidInput - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write '/port/v1/extendedaccounts/{AccountKey}/{AccountLevel}': patch: tags: - ExtendedAccounts summary: Update account information description: Update Display Name at Account or AccountGroup Level of an Extended Account operationId: ExtendedAccountsV1UpdateAccount parameters: - name: AccountKey in: path required: true schema: type: string - name: AccountLevel in: path required: true schema: $ref: '#/components/schemas/AccountLevel' requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRequest' example: DisplayName: Trading Account responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidInput - NoValidInput type: string example: None x-enum-descriptions: NoValidInput: No valid input values passed. InvalidInput: An error was encountered when processing given input parameters. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' '429': $ref: '#/components/responses/TooManyRequests' security: - OpenApiOAuthSecurityScheme: [ ] - OpenApiJWTSecurityScheme: [ ] x-required-permissions: personal: Write components: schemas: AccountBenchmarkInstrument: title: Sets the instrument to be used as comparison then evaluating account performance. required: - BenchmarkInstrumentUic type: object properties: BenchmarkInstrumentAssetType: title: The instrument asset type of the benchmark instrument. allOf: - $ref: '#/components/schemas/AssetType' BenchmarkInstrumentUic: title: The instrument identifier of the benchmark instrument. type: integer format: int32 example: 99 additionalProperties: false example: BenchmarkInstrumentAssetType: FxKnockOutOption BenchmarkInstrumentUic: 99 AccountGroupResponse: title: Data contract for an account group. type: object properties: AccountGroupKey: title: Unique ID of the account group used for selection minLength: 1 type: string x-type-name: AccountGroupKey AccountGroupName: title: 'Name of the account group, displayed to the user' type: string example: stringValue AccountValueProtectionLimit: title: "If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded.\n A limit of zero means there is no limit." type: number example: 10 CollateralMonitoringMode: title: "Collateral Monitoring Mode.\n Null when entity is not monitored on collateral." allOf: - $ref: '#/components/schemas/CollateralMonitoringMode' MarginCalculationMethod: title: Calculation method for assessing margin utilization. allOf: - $ref: '#/components/schemas/PortfolioMarginMethod' MarginLendingEnabled: title: Margin Lending Enabled allOf: - $ref: '#/components/schemas/MarginLendingEnabled' MarginMonitoringMode: title: "Margin Monitoring Mode.\n Null when entity is not monitored on margin." allOf: - $ref: '#/components/schemas/MarginMonitoringMode' PortfolioBasedMarginEnabled: title: Portfolio Based Margin (PBM) is a method for mapping the risk of an investment portfolio. True if enabled else false. type: boolean example: true SupportsAccountValueProtectionLimit: title: 'If true, an AccountValueProtectionLimit may be set on this account. If it is false, the AccountValueProtectionLimit can be set on client or account group.' type: boolean example: true additionalProperties: false example: AccountGroupKey: stringValue AccountGroupName: stringValue AccountValueProtectionLimit: 10 CollateralMonitoringMode: MaxOfCollateralCreditValueAndCollateralCreditLine MarginCalculationMethod: SpanForFuturesAndOptions MarginLendingEnabled: None MarginMonitoringMode: Margin PortfolioBasedMarginEnabled: false SupportsAccountValueProtectionLimit: true AccountGroupResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/AccountGroupResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: Data: - AccountGroupKey: stringValue AccountGroupName: stringValue AccountValueProtectionLimit: 10 CollateralMonitoringMode: MaxOfCollateralCreditValueAndCollateralCreditLine MarginCalculationMethod: Default MarginLendingEnabled: No MarginMonitoringMode: Equity PortfolioBasedMarginEnabled: false SupportsAccountValueProtectionLimit: true MaxRows: 99 AccountGroupUpdateRequest: title: A parameter wrapper for account group update operations. type: object properties: AccountValueProtectionLimit: title: "If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded.\n A limit of zero means there is no limit." type: number example: 10 additionalProperties: false example: AccountValueProtectionLimit: 10 AccountLevel: title: "Defines Extended Account Type. \n For a Group Margined Account, it is AccountGroup\n For an Individual Margined Account, it is Account" enum: - Account - AccountGroup type: string example: AccountGroup x-enum-descriptions: Account: Account AccountGroup: AccountGroup AccountResetRequest: title: A parameter wrapper for Account Reset operations. queries required: - NewBalance type: object properties: NewBalance: title: The new balance. 0 is minimum and 10.000.000 is maximum. type: number example: 10 additionalProperties: false example: NewBalance: 50000000 AccountResponse: title: Data contract for an account. required: - AccountId type: object properties: AccountGroupKey: title: Unique ID of the account group used for selection minLength: 1 type: string x-type-name: AccountGroupKey AccountGroupName: title: 'Name of the account group, displayed to the user' type: string example: stringValue AccountId: title: 'Unique ID of the account, displayed to the user' type: string example: stringValue AccountKey: title: Unique ID of the account. minLength: 1 type: string x-type-name: AccountKey AccountSubType: title: Sub type of the account. allOf: - $ref: '#/components/schemas/AccountSubType' AccountType: title: Type of the account. allOf: - $ref: '#/components/schemas/AccountType' AccountValueProtectionLimit: title: "If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded.\n A limit of zero means there is no limit." type: number example: 10 Active: title: Indicates whether the account is active or not. type: boolean example: true AutoTradingInvestmentId: title: 'If the account follows a trade leader on AutoTrading/SaxoSelect, this is the leader identifier.' type: integer format: int32 example: 99 BenchmarkInstrument: title: Contains the instrument to be used as comparison then evaluating account performance. allOf: - $ref: '#/components/schemas/AccountBenchmarkInstrument' CanUseCashPositionsAsMarginCollateral: title: 'If true, the user may enable/disable the use of cash positions as margin trading collateral on the given account.' type: boolean example: true CfdBorrowingCostsActive: title: Indicates if the account is configured for CFD borrowing costs. type: boolean example: true ClientId: title: Unique ID of the client owning the account type: string example: stringValue ClientKey: title: Unique ID of the client - for navigation purposes minLength: 1 type: string x-type-name: ClientKey CreationDate: title: The UTC date and time the account was created. type: string format: date-time x-type-name: UtcDateTime Currency: title: Account currency. type: string example: stringValue CurrencyDecimals: title: Number of decimals used in currency. type: integer format: int32 example: 99 DirectMarketAccess: title: Indicates direct market access for the account. type: boolean example: true DirectMarketExchangesIds: title: Lists exchanges for which the account is direct market access enabled. type: array items: type: string example: stringValue example: - stringValue DisplayName: title: User customizable account name. type: string example: stringValue FractionalOrderEnabled: title: FractionalOrder is enabled or not for the account. type: boolean example: true IndividualMargining: title: 'Indicates that the margin exposure is calculated for this account only, without cross margining to other accounts within the same account group.' type: boolean example: true IsCurrencyConversionAtSettlementTime: title: 'If true, currency conversions between trade and account currency take place at time of trade settlement. Typically end of business day.' type: boolean example: true IsMarginTradingAllowed: title: Indicates whether trading on margin is allowed for the account. type: boolean example: true IsShareable: title: "Indicates whether or not the account can be shared.\n An account can only be shared if it is the only account of its client and it is not a trial account." type: boolean example: true IsTrialAccount: title: IsTrialAccount - Is this a trial account. type: boolean example: true LegalAssetTypes: title: AssetTypes that can be traded on this account. type: array items: $ref: '#/components/schemas/AssetType' example: - FxVanillaOption ManagementType: title: Account's Management Type. allOf: - $ref: '#/components/schemas/ManagementType' MarginCalculationMethod: title: Calculation method for assessing margin utilization. allOf: - $ref: '#/components/schemas/PortfolioMarginMethod' MarginLendingEnabled: title: Margin Lending Enabled. allOf: - $ref: '#/components/schemas/MarginLendingEnabled' PortfolioBasedMarginEnabled: title: Portfolio Based Margin (PBM) is a method for mapping the risk of an investment portfolio. True if enabled else false. type: boolean example: true Sharing: title: Returns a list of application identifiers that the account has been shared with. type: array items: type: string example: stringValue example: - stringValue SupportsAccountValueProtectionLimit: title: 'If true, an AccountValueProtectionLimit may be set on this account. If it is false, the AccountValueProtectionLimit can be set on client or account group.' type: boolean example: true UseCashPositionsAsMarginCollateral: title: Enable/disable the use of cash positions for margin trading collateral. type: boolean example: true additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00.0000000+00:00' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false AccountResponseArray: type: array items: $ref: '#/components/schemas/AccountResponse' example: - AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false AccountResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/AccountResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false AccountSubType: title: Describes the sub type of the account. enum: - EquitySaving - None - NorwayASK - PEA - PEA_PME - SwedenISK type: string example: None x-enum-descriptions: None: 'Default , used for None.' EquitySaving: Equity Saving Account. PEA: PEA. PEA_PME: PEA-PME. NorwayASK: Norway ASK ( Tax saving Account). SwedenISK: Sweden ISK ( Tax Saving Account). AccountType: title: Describes the type of account. enum: - AutoTradingFollower - AutoTradingLeader - BlockTrading - Collateral - Commission - Funding - Interest - MarginLending - Normal - Omnibus - Other - Pension - Settlement - SettlementTrading - Tax - TaxFavoredAccount type: string example: BlockTrading x-enum-descriptions: Normal: Default. Used for normal client accounts. BlockTrading: Account used for allocating large block orders. SettlementTrading: 'For FX Settlement trading clients, this account type is used for the main trading account.' Collateral: Account used to hold collateral assets. Not used for trading. Funding: Account used to transfer funds between client accounts. Not used for trading. Commission: Booking account for comissions only. Not used for trading. Interest: Booking account for interest only. Not used for trading. Omnibus: Partner account used to execute and clear client trades. Settlement: Used in connection with SettlementTrading accounts. SettlementTrading accounts is used on the actual trading account. Settlement accounts are used on the sub accounts. Not used for trading. Tax: Retention account for accumulating or withholding taxes. Not used for trading. AutoTradingLeader: Account Type for AutoTrading leader accounts. AutoTradingFollower: Account Type for AutoTrading follower accounts. TaxFavoredAccount: Tax favored account. MarginLending: Margin Lending. Pension: Pension account. Other: Account type not mapped. AccountUpdateRequest: title: A parameter wrapper for Account update operations. type: object properties: AccountValueProtectionLimit: title: "If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded.\n A limit of zero means there is no limit." type: number example: 10 BenchmarkInstrument: title: Sets the instrument to be used as comparison then evaluating account performance. allOf: - $ref: '#/components/schemas/AccountBenchmarkInstrument' DisplayName: title: The nickname the client would like to give the account. type: string example: stringValue UseCashPositionsAsMarginCollateral: title: Enable/disable the use of cash positions for margin trading collateral. type: boolean example: true additionalProperties: false example: DisplayName: Trading Account AccountsRequest: title: "Represents a request for one or more accounts.\n At least one of the following must be specified." type: object properties: AccountGroupKey: title: The key of the account group to which the accounts belong. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account to monitor. minLength: 1 type: string x-type-name: AccountKey ClientKey: title: 'Unique key identifying the client that owns the accounts. Default: Logged-in user''s client.' minLength: 1 type: string x-type-name: ClientKey additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== AccountsSubscriptionRequest: title: Public request contract for setting up a subscription on accounts for a client. required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/AccountsRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ContextId: '20221030064905067' Format: application/json ReferenceId: A21312 RefreshRate: 500 Tag: MyAccountRelatedSubscriptions AccountsSubscriptionResponse: title: Public response contract returned after setting up a subscription on accounts for a client. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/AccountResponseListResult' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: ContextId: '20221030064905073' Format: application/json InactivityTimeout: 1500 ReferenceId: A70755 RefreshRate: 500 Snapshot: Data: - AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== AccountType: Normal Active: true CanUseCashPositionsAsMarginCollateral: false CfdBorrowingCostsActive: false ClientId: '654321' ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CreationDate: '2017-01-01T13:00:00Z' Currency: EUR CurrencyDecimals: 2 DirectMarketAccess: false FractionalOrderEnabled: false IndividualMargining: false IsCurrencyConversionAtSettlementTime: false IsMarginTradingAllowed: true IsShareable: true IsTrialAccount: false LegalAssetTypes: - FxSpot - Stock - ContractFutures ManagementType: Client MarginCalculationMethod: Default MarginLendingEnabled: None PortfolioBasedMarginEnabled: false Sharing: - TradingFloor SupportsAccountValueProtectionLimit: false UseCashPositionsAsMarginCollateral: false State: Active Tag: MyAccountRelatedSubscriptions AllowedTradingSessions: title: Allowed trading sessions. Default value "Regular". enum: - All - Regular type: string example: Regular x-enum-descriptions: Regular: Default value. Regular trading hours session. All: Extended trading hours session. AssetType: title: The possible AssetTypes for which you can get a quote or place an order or a trade. enum: - Bond - Cash - CertificateBonus - CertificateCappedBonus - CertificateCappedCapitalProtected - CertificateCappedOutperformance - CertificateConstantLeverage - CertificateDiscount - CertificateExpress - CertificateTracker - CertificateUncappedCapitalProtection - CertificateUncappedOutperformance - CfdIndexOption - CfdOnCompanyWarrant - CfdOnEtc - CfdOnEtf - CfdOnEtn - CfdOnFund - CfdOnFutures - CfdOnIndex - CfdOnRights - CfdOnStock - CompanyWarrant - ContractFutures - Etc - Etf - Etn - Fund - FuturesOption - FuturesStrategy - FxBinaryOption - FxForwards - FxKnockInOption - FxKnockOutOption - FxNoTouchOption - FxOneTouchOption - FxSpot - FxVanillaOption - GuaranteeNote - IpoOnStock - ManagedFund - MiniFuture - MutualFund - PortfolioNote - Rights - SrdOnEtf - SrdOnStock - Stock - StockIndex - StockIndexOption - StockOption - Warrant - WarrantDoubleKnockOut - WarrantKnockOut - WarrantOpenEndKnockOut - WarrantSpread type: string example: FxForwards x-enum-descriptions: FxSpot: Forex Spot. FxForwards: Forex Forward. FxVanillaOption: Forex Vanilla Option. FxKnockInOption: Forex Knock In Option. FxKnockOutOption: Forex Knock Out Option. FxBinaryOption: Forex Binary Option. FxOneTouchOption: Forex One Touch Option. FxNoTouchOption: Forex No Touch Option. ContractFutures: Contract Futures. FuturesStrategy: Futures Strategy. Stock: Stock. StockOption: Stock Option. Bond: Bond. FuturesOption: Futures Option. StockIndexOption: Stock Index Option. ManagedFund: 'Obsolete: Managed Fund.' Cash: Cash. Not tradeable! CfdOnStock: Cfd on Stock. CfdOnIndex: Cfd on Stock Index. CfdOnFutures: Cfd on Futures. StockIndex: Stock Index. MutualFund: Mutual Fund. CfdIndexOption: Cfd Index Option. CfdOnEtf: Cfd on Etf CfdOnEtc: Cfd on Etc CfdOnEtn: Cfd on Etn CfdOnFund: Cfd on Fund CfdOnRights: Cfd on Rights CfdOnCompanyWarrant: Cfd on unlisted warrant issued by a corporation. Etf: Exchange traded fund. Etc: Etc Etn: Etn Fund: Fund Rights: Rights Warrant: Warrant MiniFuture: MiniFuture. WarrantSpread: Warrant with built-in spread. WarrantKnockOut: Warrant with a knock-out barrier. WarrantOpenEndKnockOut: Knock-out Warrant with no expiry. WarrantDoubleKnockOut: Warrant with two knock-out barriers. CertificateUncappedCapitalProtection: Guarantees a percentage increase of the underlying asset's value above the issue price at expiry/maturity. Max loss is the amount invested multiplied by the CapitalProtection percentage. CertificateCappedCapitalProtected: Guarantees a capped percentage increase of the underlying asset's value above the issue price at expiry/maturity. Max loss is the amount invested multiplied by the CapitalProtection percentage. CertificateDiscount: 'Yields a capped return if the underlying asset''s value is above the specified cap level at expiry. If the underlying''s value is below the strike at expiry, the investor received the underlying or equivalent value. Offers direct exposure in underlying at a lower price (discount) with a capped potential profit and limited loss.' CertificateCappedOutperformance: Capped Outperformance Certificate. CertificateCappedBonus: Certificate Capped Bonus. CertificateExpress: Certificate Express kick out. CertificateTracker: A certificate that mirrors the price movement of the underlying instrument. Often used to trade movements in indicies. Movements can be a fixed ratio of the underlying and can be inverted for bearish/short speculation. Risk is equivalent to owning the underlying. CertificateUncappedOutperformance: 'Provides leveraged returns when the underlying price exceeds the threshold strike price. The amount leverage is defined by the Participation %. When the underlying is below the strike price, the certificate mirrors the underlying price 1:1.' CertificateBonus: 'Mirrors the price movement of the underlying only if and when the underlying price exceeds the defined barrier. If the certificate expires below the barrier, it offers partial protection/return of investment.' CertificateConstantLeverage: Certificate Constant Leverage. SrdOnStock: SRD. (Service de Règlement Différé) on Stock. SrdOnEtf: SRD. (Service de Règlement Différé) on Etf. IpoOnStock: IPO on Stock CompanyWarrant: 'Unlisted warrant issued by a corporation, often physically settled.' PortfolioNote: Danish pooled investment scheme (“Pulje”). Not online tradeable. GuaranteeNote: Danish investment scheme (“Grantbevis”). Not online tradeable. BalanceFieldGroup: title: Specification of fieldsets to include in results. enum: - CalculateCashForTrading - MarginOverview type: string example: CalculateCashForTrading x-enum-descriptions: MarginOverview: 'Include instrument margin utilization for positions on a client, account group or an account.' CalculateCashForTrading: Calculates cash available for trading from all accounts. x-type-warning: FlaggableEnum BalanceRequest: title: 'Represents a request for the account balance for a specified Client, AccountGroup or Account.' required: - ClientKey type: object properties: AccountGroupKey: title: The key of the account group for which the balance data is returned minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account for which the balance data is returned minLength: 1 type: string x-type-name: AccountKey ClientKey: title: The key of the client for which the balance data is returned minLength: 1 type: string x-type-name: ClientKey FieldGroups: title: Specifies which data to return. type: array items: $ref: '#/components/schemas/BalanceFieldGroup' additionalProperties: false example: AccountGroupKey: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 ClientKey: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 FieldGroups: - MarginOverview BalanceResponse: title: Data contract for account or client balance type: object properties: AccountFundingLimit: title: Account funding limit. This field is available for TaxSaving AccountType and FrancePea and FrancePeaPme SubAccountTypes. type: number example: 10 AccountNetFundedAmount: title: Account funding limit. This field is available for TaxSaving AccountType and FrancePea and FrancePeaPme SubAccountTypes. type: number example: 10 AccountRemainingFunding: title: 'Account Remaining Funding. This field is available for TaxSaving and Pension AccountTypes, and FrancePea and FrancePeaPme SubAccountTypes.' type: number example: 10 AccountValueProtectionLimit: title: 'If set, this value shields the account/client value from going below the given limit by automatically triggering closing of open positions should the limit be exceeded. A limit of zero means there is no limit.' type: number example: 10 CalculationReliability: title: 'In case an error was encountered while computing balances, this field indicates the source of the calculation error.' allOf: - $ref: '#/components/schemas/CalculationReliability' CashAvailableForTrading: title: Cash available for trading for the current account/client. type: number example: 10 CashBalance: title: Current cash balance of the account/client. type: number example: 10 CashBlocked: title: Cash blocked for the current account/client. type: number example: 10 ChangesScheduled: title: 'True if there are scheduled changes to margin, collateral or rating changes.' type: boolean example: true ClosedPositionsCount: title: Number of current closed positions. type: integer format: int32 example: 99 CollateralAvailable: title: 'Sum of collateral from positions, cash, collateral credit and other holdings available to maintain positions.' type: number example: 10 CollateralCreditLine: title: The utilization state and maximum collateral credit line limit. allOf: - $ref: '#/components/schemas/LineStatus' CollateralCreditValue: title: The utilization state and maximum collateral credit value. allOf: - $ref: '#/components/schemas/LineStatus' CollateralLoan: title: Size of loan secured by collateral type: number example: 10 CorporateActionUnrealizedAmounts: title: Corporate Action Unrealized Amounts. type: number example: 10 CostToClosePositions: title: Estimated costs payable if all position where to be closed on the account/client. The provided value is negative for costs charged to the account. type: number example: 10 CreditLine: title: The utilization state and maximum credit limit. allOf: - $ref: '#/components/schemas/LineStatus' Currency: title: 'Currency of the Account, AccountGroup, or Client, depending on the selected entity for which balances are requested. All values provided in this response are denominated in this currency unless otherwise specified.' type: string example: stringValue CurrencyDecimals: title: 'Number of decimals used to represent values in this currency. For most common currency denominations this value will be: 2.' type: integer format: int32 example: 99 FundsAvailableForSettlement: title: Funds available for trades settling today. type: number example: 10 FundsReservedForSettlement: title: Funds reserved for trades settling today at market opening. type: number example: 10 InitialMargin: title: 'If set, this represents the calculation entity''s initial margin (purchasing power).' allOf: - $ref: '#/components/schemas/InitialMarginResponse' IntradayMarginDiscount: title: Margin credited for unnetted positions closed intraday type: number example: 10 IsPortfolioMarginModelSimple: title: 'True if the given client/account is on simple margining. F.ex. Used to indicate if the account supports close all positions. Typically this means the client has a single account or single account margining and no settlement accounts. As well as no Fx Forwards/Options, listed options or Futures using advanced margining methods.' type: boolean example: true MarginAndCollateralUtilizationPct: title: Level of margin already utilized in percent. I.e. the ratio between the margin collateral used and the total available margin collateral. Indicates distance to margin calls. type: number example: 10 MarginAvailableForTrading: title: Margin available for trading. The amount of remaining collateral available for margin trading for the account/client. type: number example: 10 MarginCollateralNotAvailable: title: Current collateral deduction of unrealized positions. type: number example: 10 MarginCollateralNotAvailableDetail: title: Detail of MarginCollateralNotAvailable allOf: - $ref: '#/components/schemas/MarginCollateralNotAvailableDetail' MarginExposureCoveragePct: title: 'Percentage of total margin exposure to total collateral. I.e. the ratio between the Account Value and the Net Exposure. If account exposure is 0, the coverage percent is also returned as 0.' type: number example: 10 MarginNetExposure: title: Total net exposure of margin traded positions across all instruments. type: number example: 10 MarginOverview: title: Instrument margin utilization for positions. allOf: - $ref: '#/components/schemas/MarginOverviewByGroup' MarginUsedByCurrentPositions: title: Sum of maintenance margin used for current positions on the account/client. The provided value is negative for any margin that is charged to the available margin on the account/client. type: number example: 10 MarginUtilizationPct: title: Level of margin already utilized in percent. I.e. the ratio between the margin collateral used and the total available margin collateral. Indicates distance to margin calls. type: number example: 10 NetEquityForMargin: title: 'Value used as basis to calculate maintinance margin. It is calculated as TotalValue plus pending settlements (funds awaiting settlement for partners), minus MarginCollateralNotAvailable.' type: number example: 10 NetPositionsCount: title: Number of current open net positions. type: integer format: int32 example: 99 NonMarginPositionsValue: title: Sum of MarketValue for all non-margin instruments held in the account/by the client. type: number example: 10 OpenIpoOrdersCount: title: Open Ipo order(s) count type: integer format: int32 example: 99 OpenPositionsCount: title: Number of current open positions. type: integer format: int32 example: 99 OptionPremiumsMarketValue: title: 'Combined market value of premium for all options, both FX and Contract Options.' type: number example: 10 OrdersCount: title: Number of current open orders. type: integer format: int32 example: 99 OtherCollateral: title: Indicates the value of securities that have been deposited as collateral for margin. type: number example: 10 OtherCollateralDeduction: title: Other Collateral Deduction derived from regulatory contributor margin value. type: number example: 10 SettlementLine: title: The utilization state and maximum settlement credit limit. allOf: - $ref: '#/components/schemas/LineStatus' SettlementValue: title: 'Net current settlement value, long and short positions combined.' type: number example: 10 SpendingPowerDetail: title: Available spending power on the account/client. allOf: - $ref: '#/components/schemas/SpendingPower' TotalRiskLine: title: The utilization state and risk credit limit. allOf: - $ref: '#/components/schemas/LineStatus' TotalValue: title: 'Current value of unrealized positions incl. costs, cash balance and transactions not booked.' type: number example: 10 TradingLine: title: The utilization state and maximum trading credit limit. allOf: - $ref: '#/components/schemas/LineStatus' TransactionsNotBooked: title: Value of transactions that have yet to be booked to the account/client. type: number example: 10 TransactionsNotBookedDetail: title: Detail of transaction(s) that yet have to be booked to the account/client. allOf: - $ref: '#/components/schemas/TransactionsNotBookedDetail' TriggerOrdersCount: title: Number of current open trigger orders. type: integer format: int32 example: 99 UnrealizedMarginClosedProfitLoss: title: ProfitLoss on all closed (netting and explicit) part of positions (Intraday netting specific). type: number example: 10 UnrealizedMarginOpenProfitLoss: title: ProfitLoss on open part of positions (Intraday netting specific). type: number example: 10 UnrealizedMarginProfitLoss: title: Sum of profit/loss ex. costs for all margin instruments held in the account/by the client. type: number example: 10 UnrealizedPositionsValue: title: The current unrealized profit/loss and face value of all positions excl. costs. type: number example: 10 VariationMargin: title: The change in value of unrealized derivatives positions since opening them. type: number example: 10 VariationMarginCashBalance: title: Cash amount withdrawn from unrealized derivatives positions (VariationMargin). type: number example: 10 VariationMarginThreshold: title: Maximmum amount that may be withdrawn from unrealized derivatives positions (VariationMargin). type: number example: 10 additionalProperties: false example: CalculationReliability: Ok CashAvailableForTrading: 100573853.73 CashBalance: 100573853.73 CashBlocked: 0 ChangesScheduled: false ClosedPositionsCount: 0 CollateralAvailable: 99839075.64 CorporateActionUnrealizedAmounts: 0 CostToClosePositions: -1677.57 Currency: EUR CurrencyDecimals: 0 InitialMargin: CollateralAvailable: 12254541.55 MarginAvailable: 12254541.55 MarginCollateralNotAvailable: 0 MarginUsedByCurrentPositions: -1225544.66 MarginUtilizationPct: 15.11 NetEquityForMargin: 1222521.77 OtherCollateralDeduction: 0 IntradayMarginDiscount: 0 IsPortfolioMarginModelSimple: true MarginAndCollateralUtilizationPct: 0.38 MarginAvailableForTrading: 99839075.64 MarginCollateralNotAvailable: -468419.84 MarginExposureCoveragePct: 344.35 MarginNetExposure: 29088391.02 MarginUsedByCurrentPositions: -326828.87 MarginUtilizationPct: 0.33 NetEquityForMargin: 85539075.64 NetPositionsCount: 0 NonMarginPositionsValue: 509207.41 OpenIpoOrdersCount: 0 OpenPositionsCount: 0 OptionPremiumsMarketValue: 0 OrdersCount: 0 OtherCollateral: 103798.26 SettlementValue: 0 SpendingPowerDetail: Current: 50 Maximum: 50 TotalValue: 100634324.36 TransactionsNotBooked: -118.71 TriggerOrdersCount: 0 UnrealizedMarginClosedProfitLoss: 0 UnrealizedMarginOpenProfitLoss: 0 UnrealizedMarginProfitLoss: -550738.76 UnrealizedPositionsValue: -43208.92 BalanceSubscriptionRequest: title: Public request contract for setting up a subscription on a balance. required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/BalanceRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: AccountKey: ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ContextId: '20221030064906306' ReferenceId: B49083 RefreshRate: 500 Tag: MyBalancesRelatedSubscriptions BalanceSubscriptionResponse: title: Public response contract returned after setting up a subscription on accounts. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/BalanceResponse' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: ContextId: '20221030064906306' Format: application/json InactivityTimeout: 1500 ReferenceId: B49083 RefreshRate: 500 Snapshot: CalculationReliability: Ok CashAvailableForTrading: 100573853.73 CashBalance: 100573853.73 CashBlocked: 0 ChangesScheduled: false ClosedPositionsCount: 0 CollateralAvailable: 99839075.64 CorporateActionUnrealizedAmounts: 0 CostToClosePositions: -1677.57 Currency: EUR CurrencyDecimals: 0 InitialMargin: CollateralAvailable: 12254541.55 MarginAvailable: 12254541.55 MarginCollateralNotAvailable: 0 MarginUsedByCurrentPositions: -1225544.66 MarginUtilizationPct: 15.11 NetEquityForMargin: 1222521.77 OtherCollateralDeduction: 0 IntradayMarginDiscount: 0 IsPortfolioMarginModelSimple: true MarginAndCollateralUtilizationPct: 0.38 MarginAvailableForTrading: 99839075.64 MarginCollateralNotAvailable: -468419.84 MarginExposureCoveragePct: 344.35 MarginNetExposure: 29088391.02 MarginUsedByCurrentPositions: -326828.87 MarginUtilizationPct: 0.33 NetEquityForMargin: 85539075.64 NetPositionsCount: 0 NonMarginPositionsValue: 509207.41 OpenIpoOrdersCount: 0 OpenPositionsCount: 0 OptionPremiumsMarketValue: 0 OrdersCount: 0 OtherCollateral: 103798.26 SettlementValue: 0 ShareSpendingPower: 50 SpendingPower: 50 SpendingPowerDetail: Current: 50 Maximum: 50 SrdSpendingPower: 50 TotalValue: 100634324.36 TransactionsNotBooked: -118.71 TriggerOrdersCount: 0 UnrealizedMarginClosedProfitLoss: 0 UnrealizedMarginOpenProfitLoss: 0 UnrealizedMarginProfitLoss: -550738.76 UnrealizedPositionsValue: -43208.92 State: Active Tag: MyBalancesRelatedSubscriptions BuySell: title: 'Describes the direction of an order, action or trade.' enum: - Buy - Sell type: string example: Sell x-enum-descriptions: Buy: Buy. Sell: Sell. CalculationReliability: title: To what extent can the calculated values and P/L be trusted enum: - ApproximatedPrice - CurrencyConversionFailed - FailedToCalculateCollateral - NoMarketAccess - Ok - OkWithConditions - PricePending - SystemError - UnknownPrice type: string example: UnknownPrice x-enum-descriptions: Ok: Ok - calculation successful UnknownPrice: Unknown price CurrencyConversionFailed: Currency conversion failed FailedToCalculateCollateral: Failed to calculate collateral OkWithConditions: Calculation was ok given some conditions PricePending: Calculation depends on a price that is currently unavailable. NoMarketAccess: No Market Access for price. SystemError: General error due to system or client configuration. ApproximatedPrice: Profit/loss calculated based on a synthetic non-market price. ClientContractType: title: Clients Contract Types enum: - JointAccount type: string example: JointAccount x-enum-descriptions: JointAccount: Joint account ClientPositionNettingMethod: title: Client's position netting method enum: - Average - FIFO type: string example: FIFO x-enum-descriptions: FIFO: FIFO Netting Method Average: Average Netting Method ClientPositionNettingMode: title: Client's position netting mode enum: - EndOfDay - Intraday type: string example: EndOfDay x-enum-descriptions: EndOfDay: Default EndOfDay netting mode. Intraday: Intraday netting mode. ClientPositionNettingProfile: title: Client's position netting profile enum: - AverageRealTime - FifoEndOfDay - FifoRealTime type: string example: AverageRealTime x-enum-descriptions: AverageRealTime: AverageRealTime netting profile FifoRealTime: FifoRealTime netting profile FifoEndOfDay: FifoEndOfDay netting profile ClientResponse: title: Public data contract representing a client. type: object properties: AccountValueProtectionLimit: title: "If set, this value shields the total client value from going below the given limit by automatically triggering closing of positions should the limit be exceeded.\n A limit of zero means there is no limit." type: number example: 10 AllowedNettingProfiles: title: Allowed Netting Profiles for Client. type: array items: $ref: '#/components/schemas/ClientPositionNettingProfile' example: - FifoRealTime AllowedTradingSessions: title: Indicates if the client is allowed for extended trading hours. allOf: - $ref: '#/components/schemas/AllowedTradingSessions' ClientId: title: Unique ID of the client - for display to the user. type: string example: stringValue ClientKey: title: The unique key for the client. minLength: 1 type: string x-type-name: ClientKey CollateralMonitoringMode: title: "Collateral Monitoring Mode.\n Null when entity is not monitored on collateral." allOf: - $ref: '#/components/schemas/CollateralMonitoringMode' ContractType: title: "Client Contract Type.\n Null if Client contract doesn’t belong to joint account." allOf: - $ref: '#/components/schemas/ClientContractType' CurrencyDecimals: title: Number of decimals used in currency. type: integer format: int32 example: 99 DefaultAccountId: title: The default account for this client. type: string example: stringValue DefaultAccountKey: title: The unique key for the client's default account. minLength: 1 type: string x-type-name: AccountKey DefaultCurrency: title: 'The default currency for this client. Used for example for aggregation: if the client has accounts in multiple currencies, show the aggregated P/L in the this currency.' type: string example: stringValue ForceOpenDefaultValue: title: 'If True, the order(s) placed by default will be set to force open , therfore resulting positions will not automatically be netted with positions in the opposite direction.' type: boolean example: true IsMarginTradingAllowed: title: Indicates whether trading on margin is allowed for the account. type: boolean example: true IsVariationMarginEligible: title: Indicates if the client is enabled for withdrawal of unrealized profit/loss of derivatives positions. type: boolean example: true LegalAssetTypes: title: 'The combined list of asset types, which can be traded on at least one of the accounts owned by this client.' type: array items: $ref: '#/components/schemas/AssetType' example: - FxVanillaOption LegalAssetTypesAreIndicative: title: 'Certain clients have LegalAssetTypes on the account level and there may be instrument specific exceptions, so the client application must look up the individual instruments in Ref/InstrumentDetails to determine trade and prices permissions.' type: boolean example: true MarginCalculationMethod: title: Calculation method for assessing margin utilization. allOf: - $ref: '#/components/schemas/PortfolioMarginMethod' MarginMonitoringMode: title: "Margin Monitoring Mode.\n Null when entity is not monitored on margin." allOf: - $ref: '#/components/schemas/MarginMonitoringMode' MutualFundsCashAmountOrderCurrency: title: Indicates the currency used when placing MutualFunds orders with OrderAmountType.CashAmount. allOf: - $ref: '#/components/schemas/MutualFundsCashAmountOrderCurrency' Name: title: The name of the client. type: string example: stringValue PositionNettingMethod: title: The position netting method for this client. allOf: - $ref: '#/components/schemas/ClientPositionNettingMethod' PositionNettingMode: title: The position netting mode for this client. allOf: - $ref: '#/components/schemas/ClientPositionNettingMode' PositionNettingProfile: title: The position netting profile for this client. allOf: - $ref: '#/components/schemas/ClientPositionNettingProfile' ReduceExposureOnly: title: 'If True, Client has been marked to reduce exposure.' type: boolean example: true SecurityLendingEnabled: title: Indicates if the client is enabled for security lending. allOf: - $ref: '#/components/schemas/SecurityLendingEnabled' SupportsAccountValueProtectionLimit: title: 'If true, an AccountValueProtectionLimit may be set on the client level. If it is false, the AccountValueProtectionLimit must be set on individual accounts or on account group level.' type: boolean example: true additionalProperties: false example: AllowedTradingSessions: Regular ClientId: '654321' ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== CurrencyDecimals: 0 DefaultAccountId: 192134INET DefaultAccountKey: uke8gbCUrk6l7TnS5fnIdQ== DefaultCurrency: EUR ForceOpenDefaultValue: false IsMarginTradingAllowed: false IsVariationMarginEligible: false LegalAssetTypes: - Stock - FxSpot - CfdOnStock - Bond - ContractFutures LegalAssetTypesAreIndicative: false MarginCalculationMethod: Default Name: Mr. Anthony Test PositionNettingMethod: FIFO PositionNettingMode: EndOfDay PositionNettingProfile: FifoEndOfDay ReduceExposureOnly: false SupportsAccountValueProtectionLimit: false ClientResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/ClientResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AllowedTradingSessions: Regular ClientId: '654321' ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== CurrencyDecimals: 0 DefaultAccountId: 192134INET DefaultAccountKey: uke8gbCUrk6l7TnS5fnIdQ== DefaultCurrency: EUR ForceOpenDefaultValue: false IsMarginTradingAllowed: false IsVariationMarginEligible: false LegalAssetTypes: - Stock - FxSpot - CfdOnStock - Bond - ContractFutures LegalAssetTypesAreIndicative: false MarginCalculationMethod: Default Name: Mr. Anthony Test PositionNettingMethod: FIFO PositionNettingMode: EndOfDay PositionNettingProfile: FifoEndOfDay ReduceExposureOnly: false SupportsAccountValueProtectionLimit: false ClientUpdateRequest: title: A parameter wrapper for updating client values. type: object properties: AccountValueProtectionLimit: title: "If set, this value shields the total client value from going below the given limit by automatically triggering closing of positions should the limit be exceeded.\n A limit of zero means there is no limit." type: number example: 10 ForceOpenDefaultValue: title: 'If True, the order(s) placed by default will be set to force open , therfore resulting positions will not automatically be netted with positions in the opposite direction' type: boolean example: true NewPositionNettingMode: title: 'The position netting mode, client would like to switch to.' allOf: - $ref: '#/components/schemas/ClientPositionNettingMode' NewPositionNettingProfile: title: 'The position netting profile, client would like to switch to.' allOf: - $ref: '#/components/schemas/ClientPositionNettingProfile' additionalProperties: false example: AccountValueProtectionLimit: 10 ForceOpenDefaultValue: false NewPositionNettingMode: Intraday NewPositionNettingProfile: FifoEndOfDay ClosedPosition: title: Static contents for a closed position. type: object properties: AccountId: title: The id of the account to which the closed position belongs. type: string example: stringValue Amount: title: Sum volume of positions in instrument. type: number example: 10 AssetType: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' BuyOrSell: title: Closing direction - Buy or Sell allOf: - $ref: '#/components/schemas/BuySell' ClientId: title: The id of the client to which the closed position belongs. type: string example: stringValue ClosedProfitLoss: title: Closed ProfitLoss in Instrument currency type: number example: 10 ClosedProfitLossInBaseCurrency: title: Closed ProfitLoss in Base (client/ account) currency type: number example: 10 ClosingIndexRatio: title: 'Closing IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 ClosingMarketValue: title: Market value at closing for non-options in instrument currency type: number example: 10 ClosingMarketValueInBaseCurrency: title: Market value at closing for non-options in base currency type: number example: 10 ClosingMethod: title: "The closing method of the position. \n Possible values: Explicit, Fifo." allOf: - $ref: '#/components/schemas/PositionClosingMethod' ClosingPositionId: title: The Id of closing position that caused closing.. type: string example: stringValue ClosingPremium: title: 'Premium for option positions that are closed, in instrument currency' type: number example: 10 ClosingPremiumInBaseCurrency: title: 'Premium for option positions that are closed, in base currency' type: number example: 10 ClosingPrice: title: Closing price type: number example: 10 ConversionRateInstrumentToBaseSettledClosing: title: True when the closing trades currency conversion rate has been settled (i.e. is fixed and not fluctuating). This is the case for accounts using Market Conversion-Rates. type: boolean example: true ConversionRateInstrumentToBaseSettledOpening: title: True when the opening trades currency conversion rate has been settled (i.e. is fixed and not fluctuating). This is the case for accounts using Market Conversion-Rates. type: boolean example: true CostClosing: title: Total Cost in instrument currency type: number example: 10 CostClosingInBaseCurrency: title: Total Cost in client/account currency type: number example: 10 CostOpening: title: Total Cost in instrument currency type: number example: 10 CostOpeningInBaseCurrency: title: Total Cost in client/account currency type: number example: 10 ExecutionTimeClose: title: The UTC date and time the position was closed. type: string format: date-time x-type-name: UtcDateTime ExecutionTimeOpen: title: The UTC date and time the position was opened. type: string format: date-time x-type-name: UtcDateTime ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime FxOptionData: title: Fx option-related data. Only for fx options. allOf: - $ref: '#/components/schemas/FXOptionsBaseData' NoticeDate: title: Futures only - The date on which the owner may be required to take physical delivery of the instrument commodity. type: string format: date-time x-type-name: UtcDateTime OpenPrice: title: The price the instrument was traded at. type: number example: 10 OpeningIndexRatio: title: 'Opening IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 OpeningPositionId: title: The Id of opening position that has been closed. type: string example: stringValue ProfitLossCurrencyConversion: title: The profit loss from currency conversion between position close and position open. type: number example: 10 ProfitLossOnTrade: title: The P/L on the trade in the currency in which the instrument is traded. type: number example: 10 ProfitLossOnTradeInBaseCurrency: title: The P/L in the client/account group/account currency. type: number example: 10 SrdSettlementDate: title: SRD Settlement Date type: string format: date-time x-type-name: UtcDateTime Uic: title: Unique id of the instrument. type: integer format: int32 example: 99 additionalProperties: false example: AccountId: stringValue Amount: 10 AssetType: CfdOnFutures BuyOrSell: Sell ClientId: stringValue ClosedProfitLoss: 10 ClosedProfitLossInBaseCurrency: 10 ClosingIndexRatio: 10 ClosingMarketValue: 10 ClosingMarketValueInBaseCurrency: 10 ClosingMethod: Explicit ClosingPositionId: stringValue ClosingPremium: 10 ClosingPremiumInBaseCurrency: 10 ClosingPrice: 10 ConversionRateInstrumentToBaseSettledClosing: true ConversionRateInstrumentToBaseSettledOpening: false CostClosing: 10 CostClosingInBaseCurrency: 10 CostOpening: 10 CostOpeningInBaseCurrency: 10 ExecutionTimeClose: '9999-12-31T23:59:59.9999990+00:00' ExecutionTimeOpen: '9999-12-31T23:59:59.9999990+00:00' ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' FxOptionData: BarrierEventOccurred: false ExpiryCut: TK ExpiryDate: '9999-12-31T23:59:59.999999Z' LowerBarrier: 10 PutCall: None Strike: 10 UpperBarrier: 10 NoticeDate: '9999-12-31T23:59:59.9999990+00:00' OpeningIndexRatio: 10 OpeningPositionId: stringValue OpenPrice: 10 ProfitLossCurrencyConversion: 10 ProfitLossOnTrade: 10 ProfitLossOnTradeInBaseCurrency: 10 SrdSettlementDate: '9999-12-31T23:59:59.9999990+00:00' Uic: 99 ClosedPositionDetailedResponse: title: Describes an open position in detail required: - ClosedPositionUniqueId type: object properties: ClosedPosition: title: ClosedPosition info allOf: - $ref: '#/components/schemas/ClosedPosition' ClosedPositionDetails: title: Additional details related to the position. allOf: - $ref: '#/components/schemas/ClosedPositionDetails' ClosedPositionUniqueId: title: Unique id of the closed position based on OpeningPositionId and ClosingPositionId - Required for subscription to provide a key. type: string example: stringValue DisplayAndFormat: title: '[Community] Information about the instrument of the closed position and how to display it.' allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' Exchange: title: Information about the instrument's exchange and trading status. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' NetPositionId: title: NetPosition ID type: string example: stringValue additionalProperties: false example: ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionDetails: CurrencyConversionRateInstrumentToBaseClosing: 1 CurrencyConversionRateInstrumentToBaseOpening: 1 ValueDateClose: '2017-05-04T00:00:00Z' ValueDateOpen: '2017-05-04T00:00:00Z' ClosedPositionUniqueId: 139597294-139694249 DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD Exchange: Description: Inter Bank ExchangeId: SBFX IsOpen: true NetPositionId: EURUSD_FxSpot ClosedPositionDetails: title: 'Detailed information about a closed position, which is only available as a snapshot.' type: object properties: CostClosing: title: Costs associated with the closing trade. allOf: - $ref: '#/components/schemas/CostData' CostClosingInBaseCurrency: title: A Estimate of the cost of closing all underlying positions in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' CostOpening: title: Costs associated with the opening trade. allOf: - $ref: '#/components/schemas/CostData' CostOpeningInBaseCurrency: title: Costs associated with the opening trade in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' CurrencyConversionRateInstrumentToBaseClosing: title: True when the opening trades currency conversion rate has been settled (i.e. is fixed and not fluctuating). This is the case for accounts using Market Conversion-Rates. type: number example: 10 CurrencyConversionRateInstrumentToBaseOpening: title: Trade Closing time type: number example: 10 OpenMarketValue: title: Marketvalue for Non-Options in Instrument currency type: number example: 10 OpenMarketValueInBaseCurrency: title: Marketvalue for Non-Options in base currency type: number example: 10 OpenPremium: title: Open Premium for Option products in Instrument currency type: number example: 10 OpenPremiumInBaseCurrency: title: Open Premium for Option products in base currency type: number example: 10 ValueDateClose: title: The value date of the closing position. type: string format: date-time x-type-name: UtcDateTime ValueDateOpen: title: The value date of the opening position. type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: CostClosing: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 CostClosingInBaseCurrency: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 CostOpening: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 CostOpeningInBaseCurrency: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 CurrencyConversionRateInstrumentToBaseClosing: 10 CurrencyConversionRateInstrumentToBaseOpening: 10 OpenMarketValue: 10 OpenMarketValueInBaseCurrency: 10 OpenPremium: 10 OpenPremiumInBaseCurrency: 10 ValueDateClose: '9999-12-31T23:59:59.9999990+00:00' ValueDateOpen: '9999-12-31T23:59:59.9999990+00:00' ClosedPositionFieldGroup: title: Specification of fieldsets to include in results. enum: - ClosedPosition - ClosedPositionDetails - DisplayAndFormat - ExchangeInfo type: string example: ClosedPosition x-enum-descriptions: ClosedPosition: Closed position data which is calculated differently whether viewed at client or account level DisplayAndFormat: Information about the instrument of the net position and how to display it. ExchangeInfo: 'Adds information about the instrument''s exchange. This includes Exchange name, exchange code and open status.' ClosedPositionDetails: Detailed information about a closed position. Applicable when ClosedPositionId is included in the request and not a subscription request. x-type-warning: FlaggableEnum ClosedPositionRequest: title: "Represents a request for one or more netpositions.\n At least one of the following must be specified." required: - ClientKey type: object properties: AccountGroupKey: title: The key of the account group to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account to which the closed positions belongs. minLength: 1 type: string x-type-name: AccountKey ClientKey: title: The key of the client to which the closesd positions belongs. minLength: 1 type: string x-type-name: ClientKey ClosedPositionId: title: The id of the closed position to which the closedposition belongs type: string FieldGroups: title: 'Specifies which data to return. Default is [ClosedPosition]' type: array items: $ref: '#/components/schemas/ClosedPositionFieldGroup' additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ClosedPositionId: 139597294-139694249 FieldGroups: - ClosedPosition ClosedPositionResponse: title: Information for a closed position required: - ClosedPositionUniqueId type: object properties: ClosedPosition: title: ClosedPosition info allOf: - $ref: '#/components/schemas/ClosedPosition' ClosedPositionUniqueId: title: Unique id of the closed position based on OpeningPositionId and ClosingPositionId - Required for subscription to provide a key. type: string example: stringValue DisplayAndFormat: title: '[Community] Information about the instrument of the closed position and how to display it.' allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' Exchange: title: Information about the instrument's exchange and trading status. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' NetPositionId: title: NetPosition ID type: string example: stringValue additionalProperties: false example: ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot ClosedPositionResponseArray: type: array items: $ref: '#/components/schemas/ClosedPositionResponse' example: - ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot ClosedPositionResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/ClosedPositionResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot ClosedPositionsSubscriptionRequest: title: Public request contract for setting up a subscription on a list of net positions required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/ClosedPositionRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ClosedPositionId: 139597294-139694249 FieldGroups: - ClosedPosition ContextId: '20221030064907102' Format: application/json ReferenceId: CP35618 RefreshRate: 1000 Tag: PAGE1 ClosedPositionsSubscriptionResponse: title: Public response contract returned after setting up a subscription on net position. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/ClosedPositionResponseListResult' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: Format: application/json InactivityTimeout: 120 ReferenceId: CP50382 RefreshRate: 1000 Snapshot: Data: - ClosedPosition: AccountId: 192134INET Amount: 300000 AssetType: FxSpot BuyOrSell: Buy ClientId: '654321' ClosedProfitLoss: 9597 ClosedProfitLossInBaseCurrency: 9597 ClosingMarketValue: 0 ClosingMarketValueInBaseCurrency: 0 ClosingMethod: Explicit ClosingPositionId: '139694249' ClosingPrice: 1.09139 ConversionRateInstrumentToBaseSettledClosing: false ConversionRateInstrumentToBaseSettledOpening: true ExecutionTimeClose: '2017-05-02T00:00:00Z' ExecutionTimeOpen: '2017-04-12T00:00:00Z' OpeningPositionId: '139597294' OpenPrice: 1.0594 Uic: 21 ClosedPositionUniqueId: 139597294-139694249 NetPositionId: EURUSD_FxSpot State: Active CollateralMonitoringMode: title: 'Collateral Monitoring Mode. Different monitoring modes will change the behavior of stop outs, pre-checks etc (For Collateral based entities).' enum: - CollateralCreditValue - MaxOfCollateralCreditValueAndCollateralCreditLine type: string example: CollateralCreditValue x-enum-descriptions: MaxOfCollateralCreditValueAndCollateralCreditLine: Monitoring (stop-out's) are based on collateral credit value and collateral credit line. CollateralCreditValue: Monitoring (stop-out's) are based on collateral credit value CorrelationType: title: Specificies the type of correlation identified by the CorrelationKey. In OpenAPI we only expose a subset of all system internal correlation types. enum: - Allocation - Assignment - AutoAssignment - AutoExercise - AutoTrade - CopyTrade - Exercise type: string example: Allocation x-enum-descriptions: Allocation: Entity is part of a trade allocation Exercise: Entity originated from an options exercise. AutoExercise: Entity originated from an automatic options exercise. Assignment: Entitiy originated for an options assignment. AutoAssignment: Entitiy originated for an automatic options assignment. CopyTrade: Entity originated from a CopyTrade AutoTrade: Entity originated from an AutoTrade CostData: title: Trading costs associated with opening/closing a position or net position type: object properties: AdditionalTransactionCosts: title: Additional Transaction Costs. type: number example: 10 Commission: title: Transaction commission costs. type: number example: 10 ExchangeFee: title: Transaction fee as charged by the underlying exchange. type: number example: 10 ExternalCharges: title: Transaction charges added by external facilitators. type: number example: 10 PerformanceFee: title: Fee or commission based on profit/loss of position. type: number example: 10 StampDuty: title: 'National transaction duty/tax, where applicable.' type: number example: 10 additionalProperties: false example: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 CurrencyExposureBreakdown: title: Breakdown of currency exposures type: object properties: Cash: title: Cash contribution type: number example: 10 Fx: title: Fx contribution type: number example: 10 ProfitLoss: title: Profit loss contribution type: number example: 10 Total: title: The total type: number example: 10 additionalProperties: false example: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 CurrencyExposureEntry: title: Breakdown of currency exposures type: object properties: Cash: title: Cash contribution type: number example: 10 Fx: title: Fx contribution type: number example: 10 ProfitLoss: title: Profit loss contribution type: number example: 10 Total: title: The total type: number example: 10 additionalProperties: false example: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 CurrencyExposurePerValueDate: title: Currency exposure breakdown by value date type: object properties: Amounts: title: Exposure breakdown for each date type: array items: $ref: '#/components/schemas/ValueDateExposureEntry' example: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: title: Exposure with no specific value date allOf: - $ref: '#/components/schemas/CurrencyExposureBreakdown' Total: title: Total allOf: - $ref: '#/components/schemas/CurrencyExposureBreakdown' additionalProperties: false example: Amounts: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Total: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 CurrencyExposureResponse: title: Pack Currency Exposures and Net Open Position Value (NOV) type: object properties: CurrencyExposures: title: Currency exposures type: array items: $ref: '#/components/schemas/CurrencyExposures' example: - AmountsInCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInEntityCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInRequestCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Currency: stringValue ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 ValueDateCurrencyExposures: Amounts: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Total: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 NetOpenPositionValue: title: Net Open Position Value allOf: - $ref: '#/components/schemas/NetOpenPositionValue' additionalProperties: false example: CurrencyExposures: - AmountsInCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInEntityCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInRequestCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Currency: stringValue ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 ValueDateCurrencyExposures: Amounts: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Total: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 NetOpenPositionValue: AmountInEntityCurrency: 10 AmountInRequestCurrency: 10 ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 CurrencyExposureSubscriptionRequest: title: Public request contract for setting up a subscription on a list of instrument exposures required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/Exposures.CurrencyExposuresRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 ClientKey: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 CurrencyCode: stringValue PriceMode: RegularTradingHours ContextId: '-' Format: stringValue ReferenceId: '-' RefreshRate: 106 ReplaceReferenceId: '-' Tag: stringValue CurrencyExposureSubscriptionResponse: title: Public response contract returned after setting up a subscription to exposures by instrument. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/CurrencyExposureResponse' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: ContextId: stringValue Format: stringValue InactivityTimeout: 99 ReferenceId: stringValue RefreshRate: 99 Snapshot: CurrencyExposures: - AmountsInCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInEntityCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInRequestCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Currency: stringValue ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 ValueDateCurrencyExposures: Amounts: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Total: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 NetOpenPositionValue: AmountInEntityCurrency: 10 AmountInRequestCurrency: 10 ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 State: Active Tag: stringValue CurrencyExposures: title: Represents a net open exposure in an a currency. required: - Currency type: object properties: AmountsInCurrency: title: Exposures in the given currency allOf: - $ref: '#/components/schemas/CurrencyExposureEntry' AmountsInEntityCurrency: title: Exposures in the currency of the calculation entity allOf: - $ref: '#/components/schemas/CurrencyExposureEntry' AmountsInRequestCurrency: title: Exposure in the requested currency allOf: - $ref: '#/components/schemas/CurrencyExposureEntry' Currency: title: The exposure currency. type: string example: stringValue ExposureCurrencyCode: title: The currency of the ExposureLimit type: string example: stringValue ExposureLimit: title: Current exposure limit type: number example: 10 ExposureUtilization: title: Current exposure utilization type: number example: 10 ValueDateCurrencyExposures: title: Currency exposures breakdown by value date allOf: - $ref: '#/components/schemas/CurrencyExposurePerValueDate' additionalProperties: false example: AmountsInCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInEntityCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 AmountsInRequestCurrency: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Currency: stringValue ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 ValueDateCurrencyExposures: Amounts: - Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.999999Z' ValueDateKey: stringValue NonDatedExposure: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 Total: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 CurrencyExposuresResponse: title: Represents a net open exposure in an a currency. required: - Currency type: object properties: Amount: title: Total exposure in the given currency. type: number example: 10 AmountInCalculationEntityCurrency: title: Total exposure in the currency of the calculation entity. type: number example: 10 Currency: title: The exposure currency. type: string example: stringValue additionalProperties: false example: Amount: 10 AmountInCalculationEntityCurrency: 10 Currency: stringValue CurrencyExposuresResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/CurrencyExposuresResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: Data: - Amount: 10 AmountInCalculationEntityCurrency: 10 Currency: stringValue MaxRows: 99 DisplayHintType: title: Display Hint Type. enum: - Continuous - CryptoCurrencies - Etc - Etf - Etn - Forex - Fund - Interests - None - PreciousMetal - Rights - StockIndices - Warrant type: string example: Continuous x-enum-descriptions: None: Indicates not special display hint is required. PreciousMetal: Metals like XAUUSD. Continuous: Used for the parent ContractFutures. Etf: Exchange Traded Funds. Etn: Exchange Traded Notes. Etc: Exchange Traded Certificates/Currencies. Rights: Rights. Warrant: Warrants. Forex: Forex. Intended to be used for Cfds on Futures on Forex. Interests: Interest rates. Intended to be used for Cfds on Futures on bonds. StockIndices: Stock indices. Intended to be used for Cfds on Futures on stock indices. Fund: Fund. CryptoCurrencies: Crypto currencies. Entitlement: title: Contain asset types access information. type: object properties: Greeks: title: AssetTypes where user has real time access on greeks. type: array items: $ref: '#/components/schemas/AssetType' example: - CertificateCappedCapitalProtected RealTimeFullBook: title: AssetTypes where user has real time full book access on prices. type: array items: $ref: '#/components/schemas/AssetType' example: - CertificateCappedCapitalProtected RealTimeTopOfBook: title: AssetTypes where user has real time top of book access on prices. type: array items: $ref: '#/components/schemas/AssetType' example: - CertificateCappedCapitalProtected additionalProperties: false example: Greeks: - CertificateUncappedCapitalProtection RealTimeFullBook: - WarrantDoubleKnockOut RealTimeTopOfBook: - WarrantOpenEndKnockOut EntitlementDetails: title: Public data contract for an entitlement. type: object properties: Entitlements: title: 'The all client specific entitlements for market data, which the user currently has access to..' type: array items: $ref: '#/components/schemas/Entitlement' example: - Greeks: - CertificateTracker RealTimeFullBook: - CertificateExpress RealTimeTopOfBook: - CertificateCappedBonus ExchangeId: title: The unique ID of the exchange. type: string example: stringValue additionalProperties: false example: Entitlements: - Greeks: - WarrantKnockOut RealTimeFullBook: - WarrantSpread RealTimeTopOfBook: - MiniFuture ExchangeId: stringValue EntitlementDetailsListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/EntitlementDetails' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: Data: - Entitlements: - Greeks: - CertificateConstantLeverage RealTimeFullBook: - CertificateBonus RealTimeTopOfBook: - CertificateUncappedOutperformance ExchangeId: stringValue MaxRows: 99 ExerciseStyle: title: Indicates the type of the Options. Currently defined for European and American. enum: - American - European - None type: string example: European x-enum-descriptions: None: Option not defined. American: American Option. Can be exercised prior to expiry date. European: European Option. Must be exercised on expiry date. ExpiryCut: title: Specifies the type of cut-time used in option expiration. enum: - Budapest - Mexico - Moscow - NY - None - PreciousMetals - TK - Turkey - Unknown - Warsaw type: string description: "Expiry cuts are associated to string values (indicators) from ExpiryCuts MITS DB table.\n This enum should be updated each time when ExpiryCuts MITS DB table updated." example: TK x-enum-descriptions: None: Not specified. Usually option trade with this type of expiration has invalid state or not initialized. NY: Option will be expired on the New-York time. TK: Option will be expired on the Tokyo time. Warsaw: 'WR: Option is expired/exercised manually. Priced as NY.' Budapest: 'BD: Option is expired/exercised manually. Priced as NY.' PreciousMetals: 'Precious metals cut (PM): Option is expired/exercised manually. Priced as NY.' Turkey: 'Turkish cut (TR): Option is expired/exercised manually. Priced as NY.' Mexico: 'Mexico cut (MX): Option is expired/exercised manually. Priced as NY.' Moscow: 'Moscow cut (MW): Option is expired/exercised manually. Priced as NY.' Unknown: 'Unknown cut: (UX): Option is expired/exercised manually. Priced as NY.' Exposures.CurrencyExposuresRequest: title: Represents a request for total currency exposures. required: - CurrencyCode - ClientKey type: object properties: AccountGroupKey: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey ClientKey: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey CurrencyCode: title: Currency code for the request type: string additionalProperties: false example: AccountGroupKey: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 ClientKey: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4 CurrencyCode: stringValue FXOptionsBaseData: title: FXOptions Base type: object properties: BarrierEventOccurred: title: True if the barrier event has occurred for the option type: boolean example: true ExpiryCut: title: ExpiryCut. allOf: - $ref: '#/components/schemas/ExpiryCut' ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime LowerBarrier: title: LowerBarrier for digital option. type: number example: 10 PutCall: title: The Put/Call value of the option. allOf: - $ref: '#/components/schemas/PutCall' Strike: title: The strike price of the option. type: number example: 10 UpperBarrier: title: UpperBarrier for digital option. type: number example: 10 additionalProperties: false example: BarrierEventOccurred: true ExpiryCut: Moscow ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' LowerBarrier: 10 PutCall: Call Strike: 10 UpperBarrier: 10 FixedIncomeData: title: Extended details about yeild and accrued interest for bonds. type: object properties: ClosedAccruedInterest: title: Part of the close price that accounts for the Accrued Interest. type: number example: 10 ClosedAccruedInterestInBaseCurrency: title: Part of the close price that accounts for the Accrued Interest in reqesting client/account currency. type: number example: 10 OpenAccruedInterest: title: Part of the open price that accounts for the Accrued Interest. type: number example: 10 OpenAccruedInterestInBaseCurrency: title: Part of the open price that accounts for the Accrued Interest in reqesting client/account currency. type: number example: 10 additionalProperties: false example: ClosedAccruedInterest: 10 ClosedAccruedInterestInBaseCurrency: 10 OpenAccruedInterest: 10 OpenAccruedInterestInBaseCurrency: 10 Greeks: title: Describes the sensitivity of the value of an option or instrument to a change in a given underlying parameter. type: object properties: Delta: title: Shows the equivalent FX Spot exposure of a given position. This is the sensitivity of a position’s value with respect to the spot rate. type: number example: 10 DeltaCurrency: title: Currency of Delta. type: string example: stringValue Gamma: title: 'This is the second derivative of the position value with respect to spot, i.e. it shows how much the delta changes when spot changes (i.e. how much will the delta change when spot moves up by one percentage point.' type: number example: 10 GammaCurrency: title: Currency of Gamma. type: string example: stringValue InstrumentDelta: title: Delta for the instrument. type: number example: 10 InstrumentGamma: title: Gamma for the instrument. type: number example: 10 InstrumentTheta: title: Theta for the instrument. type: number example: 10 InstrumentVega: title: Vega for the instrument. type: number example: 10 MidVol: title: The mid rate for the implied volatility used in pricing this option type: number example: 10 Phi: title: Phi type: number example: 10 Rho: title: Interest rate sensitivity indicator. Derivative of the option value with and risk free interest rate. type: number example: 10 TheoreticalPrice: title: The theoretical price. type: number example: 10 Theta: title: Also known as time decay. This shows by how much the position will increase or decrease in value from one day to the next. type: number example: 10 ThetaCurrency: title: Currency of Theta. type: string example: stringValue Vega: title: Sensitivity of a position with respect to the implied volatility used to price FX Options. This shows how much money is made (positive number) or lost (negative number) when volatility goes up by one percentage point. type: number example: 10 VegaCurrency: title: Currency of Vega. type: string example: stringValue additionalProperties: false example: Delta: 10 DeltaCurrency: stringValue Gamma: 10 GammaCurrency: stringValue InstrumentDelta: 10 InstrumentGamma: 10 InstrumentTheta: 10 InstrumentVega: 10 MidVol: 10 Phi: 10 Rho: 10 TheoreticalPrice: 10 Theta: 10 ThetaCurrency: stringValue Vega: 10 VegaCurrency: stringValue InitialMarginResponse: title: The calculation entity's initial margin (purchasing power) status. type: object properties: CollateralAvailable: title: 'Sum of collateral from positions, cash, collateral credit and other holdings available for opening new positions.' type: number example: 10 MarginAvailable: title: Margin available for opening new positions. Initial margin available. type: number example: 10 MarginUsedByCurrentPositions: title: Sum of initial margin currently reserved. type: number example: 10 MarginUtilizationPct: title: Level of margin already utilized in percent. I.e. the ratio between the margin collateral used and the total available margin collateral. Indicates distance to margin calls. type: number example: 10 NetEquityForMargin: title: Value used as basis to calculate initial margin available. type: number example: 10 OtherCollateralDeduction: title: Other Collateral Deduction derived from regulatory contributors margin value. type: number example: 10 additionalProperties: false example: CollateralAvailable: 10 MarginAvailable: 10 MarginUsedByCurrentPositions: 10 MarginUtilizationPct: 10 NetEquityForMargin: 10 OtherCollateralDeduction: 10 InstrumentCollateralDetail: title: Instrument collateral detail type: object properties: AssetType: title: Instrument Asset type allOf: - $ref: '#/components/schemas/AssetType' Description: title: Instrument Description type: string example: stringValue InitialCollateral: title: Initial collateral available of the instrument type: number example: 10 InitialCollateralNotAvailable: title: Initial collateral not available of the instrument type: number example: 10 MaintenanceCollateral: title: Maintenance collateral available of the instrument type: number example: 10 MaintenanceCollateralNotAvailable: title: Maintenance collateral not available of the instrument type: number example: 10 MarketValue: title: Market value of the instrument type: number example: 10 Symbol: title: Instrument Symbol type: string example: stringValue Uic: title: Uic of the instrument type: integer format: int32 example: 99 additionalProperties: false example: AssetType: PortfolioNote Description: stringValue InitialCollateral: 10 InitialCollateralNotAvailable: 10 MaintenanceCollateral: 10 MaintenanceCollateralNotAvailable: 10 MarketValue: 10 Symbol: stringValue Uic: 99 InstrumentDisplayAndFormat: title: 'Public data contract containing information about the instrument of a position, which is useful for display and formatting.' type: object properties: BarrierDecimals: title: "Number of display decimals for barrier price.\n One touch/no touch options only." type: integer format: int32 example: 99 BarrierFormat: title: "Display format of barrier price.\n One touch/no touch options only." allOf: - $ref: '#/components/schemas/PriceDisplayFormatType' Currency: title: The ISO currency code of the instrument. type: string example: stringValue Decimals: title: "The resolution in which e.g. a price must be displayed and possibly edited.\n Positive numbers are represents digits, and negative numbers represent fractions using this formula: 1/(2^x).\n Same as DisplayDecimals." type: integer format: int32 example: 99 Description: title: 'Description of instrument (DAX Index - Nov 2013), in English.' type: string example: stringValue DisplayHint: title: Hint to the client application about how it should display the instrument. allOf: - $ref: '#/components/schemas/DisplayHintType' Format: title: Format code specifying how price should be formatted. allOf: - $ref: '#/components/schemas/PriceDisplayFormatType' NumeratorDecimals: title: 'Some fractional prices have decimals in the numerator, e.g. 2.5/32. This is relevant for futures and cfds on futures.' type: integer format: int32 example: 99 OrderDecimals: title: The number of decimals trigger price for orders should be formatted with. type: integer format: int32 example: 99 StrikeDecimals: title: "The decimals value to use when formatting strike price.\n Only relevant for options." type: integer format: int32 example: 99 StrikeFormat: title: "The price format to use when formatting strike price.\n Only relevant for options." allOf: - $ref: '#/components/schemas/PriceDisplayFormatType' Symbol: title: Symbol- A combination of letters used to uniquely identify a traded instrument. e.g. ODAX/X13C8950:xeur. type: string example: stringValue UnderlyingInstrumentDescription: title: Common full name of the underlying instrument. Only used for options and is the same as the option root description. type: string example: stringValue additionalProperties: false example: BarrierDecimals: 99 BarrierFormat: Normal Currency: stringValue Decimals: 99 Description: stringValue DisplayHint: PreciousMetal Format: Percentage NumeratorDecimals: 99 OrderDecimals: 99 StrikeDecimals: 99 StrikeFormat: AllowDecimalPips Symbol: stringValue UnderlyingInstrumentDescription: stringValue InstrumentExchangeDetails: title: Information about an exchange and its trading hours. type: object properties: Description: title: Full name/description of the exchange type: string example: stringValue ExchangeId: title: Short exchange code. type: string example: stringValue IsOpen: title: Indicates if the exchange is currently open for trading type: boolean example: true TimeZoneId: title: Exchange's TimeZone type: string example: stringValue additionalProperties: false example: Description: stringValue ExchangeId: stringValue IsOpen: true TimeZoneId: stringValue InstrumentExposureRequest: title: "Filters results so only exposures that match the provided criteria are returned.\n ClientKey must be specified." required: - ClientKey type: object properties: AccountGroupKey: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey AssetType: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' ClientKey: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey ExpiryDate: title: The expiry date. Only used to distinguish FxOptions. type: string format: date-time x-type-name: UtcDateTime LowerBarrier: title: The Lower Barrier. Only used to distinguish Fx Barrier Options. type: number PutCall: title: Put or Call. Only used to distinguish FxOptions. allOf: - $ref: '#/components/schemas/PutCall' Strike: title: The strike price of the option. Only used to distinguish FxOptions. type: number Uic: title: Unique id of the instrument. type: integer format: int32 UpperBarrier: title: The Upper Barrier. Only used to distinguish Fx Barrier Options. type: number ValueDate: title: The value date. Only used to distinguish FxForwards. type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== AssetType: FxSpot ClientKey: 7m4I|vtYLUnEGg77o9uQhw== Uic: 21 InstrumentExposureResponse: title: Represents a net open exposure in an instrument. required: - NetPositionId type: object properties: Amount: title: Sum exposure of positions in instrument type: number example: 10 AssetType: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' AverageOpenPrice: title: The average price of all the positions that make up the exposure. type: number example: 10 CalculationReliability: title: If an error was encountered this code indicates source of the calculation error. allOf: - $ref: '#/components/schemas/CalculationReliability' CanBeClosed: title: Indicates if the exposure may be closed. type: boolean example: true DisplayAndFormat: title: Information about the instrument and how to display it. allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime InstrumentPriceDayPercentChange: title: Percent change in instrument's price between Previous Close and current Last Traded price. type: number example: 10 LowerBarrier: title: LowerBarrier for digital option. type: number example: 10 NetPositionId: title: The exposure net position id. May be used to fetch the net position or open positions of the net position from the Open Positions service. type: string example: stringValue ProfitLossOnTrade: title: The P/L on the trade in the currency in which the instrument is traded. type: number example: 10 PutCall: title: The Put/Call value of the option. allOf: - $ref: '#/components/schemas/PutCall' Strike: title: The strike price of the option. type: number example: 10 Uic: title: Unique id of the instrument. type: integer format: int32 example: 99 UpperBarrier: title: UpperBarrier for digital option. type: number example: 10 ValueDate: title: The value date. Only used to distinguish FxForwards. type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 InstrumentExposureResponseArray: type: array items: $ref: '#/components/schemas/InstrumentExposureResponse' example: - Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 InstrumentExposureResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/InstrumentExposureResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 InstrumentExposureSubscriptionRequest: title: Public request contract for setting up a subscription on a list of instrument exposures required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/InstrumentExposureRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== AssetType: FxSpot ClientKey: 7m4I|vtYLUnEGg77o9uQhw== PriceMode: RegularTradingHours Uic: 21 ContextId: '-' Format: stringValue ReferenceId: '-' RefreshRate: 104 ReplaceReferenceId: '-' Tag: stringValue InstrumentExposureSubscriptionResponse: title: Public response contract returned after setting up a subscription to exposures by instrument. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/InstrumentExposureResponseListResult' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: ContextId: '20221030064906529' Format: application/json InactivityTimeout: 120 ReferenceId: E68752 RefreshRate: 1000 Snapshot: Data: - Amount: 200000 AssetType: FxSpot AverageOpenPrice: 1.08414 CalculationReliability: Ok CanBeClosed: false DisplayAndFormat: Currency: USD Decimals: 4 Description: Euro/US Dollar Format: AllowDecimalPips Symbol: EURUSD NetPositionId: EURUSD_FxSpot Uic: 21 State: Active LineStatus: title: 'Describes the current utilization and size of a Credit, Risk or Trading line.' type: object properties: Exposure: title: The current utilization of the credit line. type: number example: 10 Line: title: The maximum credit limit allowed. type: number example: 10 UtilizationPct: title: The current utilization of the credit line in proportion to the line limit. type: number example: 10 additionalProperties: false example: Exposure: 10 Line: 10 UtilizationPct: 10 LoginStatus: title: Used to describe the state of the last login attempt. enum: - Successful - Unsuccessful type: string example: Successful x-enum-descriptions: Successful: The user logged in Unsuccessful: The user recieved an access denied ManagementType: title: Account Management Type enum: - Advisory - Client - Discretionary - ExternallyManaged - ModelAdvisory - ModelManaged - SelfPeriodicInvestment - TradeAdvisory type: string example: TradeAdvisory x-enum-descriptions: Client: The account is managed by the client. (Default). TradeAdvisory: 'Advisors can call clients with trade suggestions across products, but trades are accepted by the client.' ModelAdvisory: 'The account is managed by a model, but client has to accept changes to the model.' ModelManaged: The account is managed by a model. Client cannot trade on the account. ExternallyManaged: 'The account is managed externally (not in a saxo bank system). Client cannot trade on the account, but authorized dealers can.' SelfPeriodicInvestment: Client can schedule periodic investments on one or multiple Instruments Discretionary: The account is managed by partner. Client (beneficial owner of the account) cannot trade on this account but authorized dealers can. Client will not receive any trade notifications. Advisory: 'The account is managed by partner. Client (beneficial owner of the account) cannot trade on this account but authorized dealers can. However, client will get trade notifications.' MarginCollateralNotAvailableDetail: title: Detail of Margin Collateral Not Available type: object properties: InitialFxHaircut: title: Initial Fx Haircut type: number example: 10 InstrumentCollateralDetails: title: Instrument collateral collection type: array items: $ref: '#/components/schemas/InstrumentCollateralDetail' example: - AssetType: GuaranteeNote Description: stringValue InitialCollateral: 10 InitialCollateralNotAvailable: 10 MaintenanceCollateral: 10 MaintenanceCollateralNotAvailable: 10 MarketValue: 10 Symbol: stringValue Uic: 99 MaintenanceFxHaircut: title: Maintenance Fx Haircut type: number example: 10 additionalProperties: false example: InitialFxHaircut: 10 InstrumentCollateralDetails: - AssetType: CompanyWarrant Description: stringValue InitialCollateral: 10 InitialCollateralNotAvailable: 10 MaintenanceCollateral: 10 MaintenanceCollateralNotAvailable: 10 MarketValue: 10 Symbol: stringValue Uic: 99 MaintenanceFxHaircut: 10 MarginLendingEnabled: title: Margin Lending Enabled. enum: - No - None - Yes type: string example: Yes x-enum-descriptions: None: Default. Margin Lending is not applicable. Yes: Margin Lending is enabled. No: Margin Lending is disabled. MarginMonitoringMode: title: Margin Monitoring Mode. enum: - Equity - Lines - Margin type: string example: Lines x-enum-descriptions: Margin: 'Monitoring (stop-out''s) are based on standard margin utilization, pre-check''s are done against standard margin utilization.' Lines: 'Monitoring (stop-out''s) are based on credit line utilization, pre-check''s are done against trading and credit line utilization.' Equity: 'Monitoring is based on standard equity utilization, pre-check''s are done against standard equity utilization.' MarginOverviewByGroup: title: 'Margin utilization for positions, broken down into groups of AssetTypes.' type: object properties: Groups: title: List of AssetType groups with it's contributing positions and total margin utilization. type: array items: $ref: '#/components/schemas/MarginOverviewGroup' example: - Contributors: - AssetTypes: - FxSpot InstrumentDescription: EURUSD description InstrumentSpecifier: EURUSD Margin: 1235 Uic: 21 - AssetTypes: - FxSpot InstrumentDescription: GBPUSD description InstrumentSpecifier: GBPUSD Margin: 789 Uic: 22 GroupType: FX TotalMargin: 100000 additionalProperties: false example: Groups: - Contributors: - AssetTypes: - FxSpot InstrumentDescription: EURUSD description InstrumentSpecifier: EURUSD Margin: 1235 Uic: 21 - AssetTypes: - FxSpot InstrumentDescription: GBPUSD description InstrumentSpecifier: GBPUSD Margin: 789 Uic: 22 GroupType: FX TotalMargin: 100000 - Contributors: - AssetTypes: - CfdOnIndex InstrumentDescription: SP500 description InstrumentSpecifier: SP500.I Margin: 4321 Uic: 4910 - AssetTypes: - CfdOnIndex InstrumentDescription: CSE20 description InstrumentSpecifier: CSE20.I Margin: 975 Uic: 5768 - AssetTypes: - CfdOnIndex InstrumentDescription: DAX description InstrumentSpecifier: DAX.I Margin: 864 Uic: 27098 GroupType: CFDs TotalMargin: 200000 MarginOverviewContributor: title: Total margin impact by net position. type: object properties: AssetTypes: title: AssetTypes for this contributor. type: array items: $ref: '#/components/schemas/AssetType' example: - FxVanillaOption DisplayHint: title: Hint to the client application about how it should display the instrument. allOf: - $ref: '#/components/schemas/DisplayHintType' InstrumentDescription: title: Description of instrument. Not available for futures. type: string example: stringValue InstrumentSpecifier: title: Instrument identifier. Base contract for futures and symbol for other instruments. type: string example: stringValue Margin: title: Margin impact of the contributor type: number example: 10 Uic: title: 'Uic identifying the instrument, if any' type: integer format: int32 example: 99 additionalProperties: false example: AssetTypes: - FxSpot InstrumentDescription: EURUSD description InstrumentSpecifier: EURUSD Margin: 1235 Uic: 21 MarginOverviewGroup: title: Margin utilization of the AssetType group as applied to the overall margin calculation. type: object properties: Contributors: title: Contributors are either a list of instruments or a single (anonymous) object representing implicitly aggregated contributors type: array items: $ref: '#/components/schemas/MarginOverviewContributor' example: - AssetTypes: - FxSpot InstrumentDescription: EURUSD description InstrumentSpecifier: EURUSD Margin: 1235 Uic: 21 GroupType: title: AssetType group - used by margin calculation. allOf: - $ref: '#/components/schemas/MarginOverviewGroupType' TotalMargin: title: Total margin impact of the group of instrument. type: number example: 10 additionalProperties: false example: Contributors: - AssetTypes: - FxSpot InstrumentDescription: EURUSD description InstrumentSpecifier: EURUSD Margin: 1235 Uic: 21 - AssetTypes: - FxSpot InstrumentDescription: GBPUSD description InstrumentSpecifier: GBPUSD Margin: 789 Uic: 22 GroupType: FX TotalMargin: 100000 MarginOverviewGroupType: title: Margin calculation category of AssetType. enum: - CFDs - FX - FuturesAndOptions - Other type: string example: CFDs x-enum-descriptions: CFDs: Margin impact of CFDs - presumably all categories FuturesAndOptions: Margin impact of future and option contract instruments FX: Margin impact of FX instruments Other: Margin overview group based on unspecified criteria MarketState: title: Defines the possible states of the Market. enum: - Closed - ClosingAuction - IntraDayAuction - Open - OpeningAuction - PostMarket - PreMarket - TradingAtLast type: string example: Closed x-enum-descriptions: Open: 'Market is open for trades (Automatic Trading, usually).' Closed: Market is closed PreMarket: Market is in Pre Market Auction state PostMarket: Market is in Post Market Auction state IntraDayAuction: "Market is temporary out of normal Trading. In an Auction state This state is\n for Intraday Auction. We have 2 specific states for Opening and Closing Auction" OpeningAuction: "Market is temporary out of normal Trading. This is the Auction that occur before \n the market opens" ClosingAuction: "Market is temporary out of normal Trading. This is the Auction that occur after\n the market closes." TradingAtLast: 'This state is after the Auction has finished, before normal Trading starts.' ModelStateDictionary: type: object additionalProperties: type: array items: type: string MultiLegOrderDetails: title: Contains common properties for multi-leg (strategy) orders. type: object properties: Amount: title: Amount for the multi-leg order. Each leg may have independent amounts. type: number example: 10 BuySell: title: Buy/sell direction for the multi-leg order. Each leg may point in independent directions. allOf: - $ref: '#/components/schemas/BuySell' CurrentPrice: title: The user specific(delayed/realtime) current market price of the multi-leg order. type: number example: 10 Description: title: Description of the multi-leg order. type: string example: stringValue DistanceToMarket: title: Distance to market for this multi-leg order. (Dynamically updating) type: number example: 10 FilledAmount: title: Amount for the multi-leg order that has already been filled. type: number example: 10 LegCount: title: Number of orders that make up the multi-leg order. type: integer format: int32 example: 99 MultiLegOrderId: title: Unique identifier for the multi-leg order. Same for all legs. type: string example: stringValue Price: title: Overall limit price for the multi-leg order. type: number example: 10 StrategyType: title: The enumeration If the legs match a common options strategy. allOf: - $ref: '#/components/schemas/OptionsStrategyType' additionalProperties: false example: Amount: 10 BuySell: Buy CurrentPrice: 10 Description: stringValue DistanceToMarket: 10 FilledAmount: 10 LegCount: 99 MultiLegOrderId: stringValue Price: 10 StrategyType: Vertical MutualFundsCashAmountOrderCurrency: title: Indicates the currency used when placing orders with OrderAmountType.CashAmount. enum: - Account - Instrument type: string example: Account x-enum-descriptions: Account: Use the specified account currency. Instrument: Use the currency of the specified instrument. NetOpenPositionValue: title: Net Open Position Value ( NOV ) type: object properties: AmountInEntityCurrency: title: In entity currency type: number example: 10 AmountInRequestCurrency: title: in request currency type: number example: 10 ExposureCurrencyCode: title: Currency of the exposure limit type: string example: stringValue ExposureLimit: title: exposure limit type: number example: 10 ExposureUtilization: title: Exposure utilization type: number example: 10 additionalProperties: false example: AmountInEntityCurrency: 10 AmountInRequestCurrency: 10 ExposureCurrencyCode: stringValue ExposureLimit: 10 ExposureUtilization: 10 NetPositionDetailedResponse: title: "Data representing an open net position.\n Internal Note: Fields, which are also made available to communities are identified by a [Community] entry in the comment" required: - NetPositionId type: object properties: DisplayAndFormat: title: '[Community] Information about the instrument of the net position and how to display it.' allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' Exchange: title: Information about the exchange where this instrument or the underlying instrument is traded. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' Greeks: title: 'Greeks for option(s) i.e. FX Option, Contract Options and Contract Options CFD .' allOf: - $ref: '#/components/schemas/Greeks' NetPositionBase: title: Static part of net position information allOf: - $ref: '#/components/schemas/NetPositionStatic' NetPositionDetails: title: 'Detailed information about a netposition, which is only available as a snapshot.' allOf: - $ref: '#/components/schemas/NetPositionDetails' NetPositionId: title: '[Community] The id of the net position. This can be used to fetch the open positions of a net position from the Positions service.' type: string example: stringValue NetPositionView: title: Dynamic part of net position information. allOf: - $ref: '#/components/schemas/NetPositionDynamic' SinglePosition: title: "Obsolete If the NetPosition consists of a single position, this is the position details.\n This will be empty if the NetPosition is comprised of more than one positions." allOf: - $ref: '#/components/schemas/SubPositionResponse' deprecated: true x-deprecated-date: '2022-11-01' additionalProperties: false example: NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionDetails: MarketValue: -2958 MarketValueInBaseCurrency: -2958 NonTradableReason: None NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 NetPositionDetails: title: Additional details related to the net position type: object properties: CloseCost: title: Costs associated with the closing trade. allOf: - $ref: '#/components/schemas/CostData' CloseCostInBaseCurrency: title: A Estimate of the cost of closing all underlying positions in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' ClosedProfitLoss: title: 'For partially closed net positions, this is the realized P/L in the client/account base currency.' type: number example: 10 ClosedProfitLossInBaseCurrency: title: 'For partially closed net positions, this is the realized P/L converted to requesting account/client currency.' type: number example: 10 Greeks: title: Greeks (if fx option). allOf: - $ref: '#/components/schemas/Greeks' MarketState: title: Exchange state for the instrument allOf: - $ref: '#/components/schemas/MarketState' MarketValue: title: Market value of position excl. closing costs. type: number example: 10 MarketValueInBaseCurrency: title: 'The total nominal value of the of the underlying positions, in rquested acount/client currency.' type: number example: 10 MarketValueOpen: title: The value of the position at time of opening. type: number example: 10 MarketValueOpenInBaseCurrency: title: 'The nominal value of the position at the time of open, in requested account/client currency.' type: number example: 10 NonTradableReason: title: Non tradable reason. allOf: - $ref: '#/components/schemas/NonTradableReasons' OpenCost: title: Costs associated with the opening trade in instrument currency. allOf: - $ref: '#/components/schemas/CostData' OpenCostInBaseCurrency: title: Costs associated with the opening trade in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' OpenInterest: title: The total number of contracts that have not been settled and remain open as of the end of a trading day. type: number example: 10 OriginalCost: title: Original cost data for Net Positions. Available for Mutual Funds only. allOf: - $ref: '#/components/schemas/OriginalCostData' RealizedCloseCosts: title: 'If underlying positions are explicitly(only) closed, these are the close costs of the closed positions in instrument currency.' allOf: - $ref: '#/components/schemas/CostData' RealizedClosedCostsLossInBaseCurrency: title: 'If underlying positions are explicitly(only) closed, these are the close costs of the closed positions in client/account group/account currency.' allOf: - $ref: '#/components/schemas/CostData' RealizedOpenCosts: title: 'If underlying positions are explicitly(only) closed, these are the open costs of the closed positions in instrument currency.' allOf: - $ref: '#/components/schemas/CostData' RealizedOpenCostsLossInBaseCurrency: title: 'If underlying positions are explicitly(only) closed, these are the open costs of the closed positions in client/account group/account currency.' allOf: - $ref: '#/components/schemas/CostData' ShortTrading: title: Short trading allowed or not on instrument allOf: - $ref: '#/components/schemas/ShortTrading' StockBlockingDetails: title: Stock blocking details type: array items: $ref: '#/components/schemas/StockBlockingDetail' example: - BlockingId: 99 BlockingQuantity: 10 BlockingReason: stringValue EventReferenceId: stringValue TradingStatus: title: Instrument is tradable or not allOf: - $ref: '#/components/schemas/TradingStatus' additionalProperties: false example: CloseCost: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 CloseCostInBaseCurrency: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 ClosedProfitLoss: 10 ClosedProfitLossInBaseCurrency: 10 Greeks: Delta: 10 DeltaCurrency: stringValue Gamma: 10 GammaCurrency: stringValue InstrumentDelta: 10 InstrumentGamma: 10 InstrumentTheta: 10 InstrumentVega: 10 MidVol: 10 Phi: 10 Rho: 10 TheoreticalPrice: 10 Theta: 10 ThetaCurrency: stringValue Vega: 10 VegaCurrency: stringValue MarketState: ClosingAuction MarketValue: 10 MarketValueInBaseCurrency: 10 MarketValueOpen: 10 MarketValueOpenInBaseCurrency: 10 NonTradableReason: ExpiredInstrument OpenCost: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 OpenCostInBaseCurrency: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 OpenInterest: 10 OriginalCost: IndicativeExitTaxApplicable: 10 IndicativeProfitLossOnTrade: 10 OpenCost: 10 RealizedCloseCosts: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 RealizedClosedCostsLossInBaseCurrency: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 RealizedOpenCosts: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 RealizedOpenCostsLossInBaseCurrency: AdditionalTransactionCosts: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 PerformanceFee: 10 StampDuty: 10 ShortTrading: Allowed StockBlockingDetails: - BlockingId: 99 BlockingQuantity: 10 BlockingReason: stringValue EventReferenceId: stringValue TradingStatus: NonTradable NetPositionDynamic: title: Dynamic information related to the net position. Unless otherwise stated all prices and amounts are in instrument currency. type: object properties: Ask: title: The current market ask price. type: number example: 10 AverageOpenPrice: title: The average price of all the open positions that make up the net position. type: number example: 10 Bid: title: The current market bid price. type: number example: 10 CalculationReliability: title: If an error was encountered this code indicates source of the calculation error. allOf: - $ref: '#/components/schemas/CalculationReliability' ConversionRateCurrent: title: Current conversion rate used for opening trade costs. type: number example: 10 CurrentPrice: title: The user specific(delayed/realtime) current market price of the instrument. type: number example: 10 CurrentPriceDelayMinutes: title: 'If set, it defines the number of minutes by which the price is delayed.' type: integer format: int32 example: 99 CurrentPriceLastTraded: title: Indicates when the user specific current market price of the instrument was last traded. type: string format: date-time x-type-name: UtcDateTime CurrentPriceType: title: The price type (Bid/Ask/LastTraded) of the user specific(delayed/realtime) current market price of the instrument. allOf: - $ref: '#/components/schemas/PriceType' Exposure: title: 'Current nominal value of position, but differs from market value in that it has a value for margin products.' type: number example: 10 ExposureCurrency: title: Currency of exposure. type: string example: stringValue ExposureInBaseCurrency: title: 'Current nominal value of position, but differs from market value in that it has a value for margin products. Converted to requesting account/client currency.' type: number example: 10 IndexRatio: title: 'Current IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 InstrumentPriceDayPercentChange: title: Percent change in instrument's price between Previous Close and current Last Traded price. type: number example: 10 MarketValue: title: Sum market value of positions excl. closing costs. type: number example: 10 MarketValueInBaseCurrency: title: 'The total nominal value of the of the underlying positions, in rquested acount/client currency.' type: number example: 10 MarketValueOpen: title: The value of the position at time of opening. type: number example: 10 MarketValueOpenInBaseCurrency: title: 'The nominal value of the position at the time of open, in requested account/client currency.' type: number example: 10 OpenInterest: title: The total number of contracts that have not been settled and remain open as of the end of a trading day. type: number example: 10 PositionCount: title: The number of Open Positions for this NetPosition type: integer format: int32 example: 99 PositionsNotClosedCount: title: Simple count of effective open positions under this net position. I.e. without related closing positions. type: integer format: int32 example: 99 ProfitLossCurrencyConversion: title: The P/L from currency conversion between now and position open. type: number example: 10 ProfitLossOnTrade: title: The P/L on the trade in the currency in which the instrument is traded. type: number example: 10 ProfitLossOnTradeInBaseCurrency: title: The P/L in the client/account group/account currency. type: number example: 10 RealizedCostsTotal: title: 'If underlying positions are explicitly(only) closed, these are the costs of the closed positions in instrument currency.' type: number example: 10 RealizedCostsTotalInBaseCurrency: title: 'If underlying positions are explicitly(only) closed, these are the costs of the closed positions in client/account group/account currency.' type: number example: 10 RealizedProfitLoss: title: 'If underlying positions are explicitly(only) closed, this is the sum of realized P/L of the closed positions in instrument currency.' type: number example: 10 RealizedProfitLossInBaseCurrency: title: 'If underlying positions are explicitly(only) closed, this is the sum of realized P/L of the closed positions in the client/account group/account currency.' type: number example: 10 SettlementInstruction: title: Settlement Instructions allOf: - $ref: '#/components/schemas/SettlementInstructions' Status: title: "The status of the net position. \n Possible values: Open, Closed, Closing, PartiallyClosed, Locked." allOf: - $ref: '#/components/schemas/PositionStatus' TradeCostsTotal: title: 'The sum of all open costs and realized/unrealized close costs for the underlying positions, in instrument currency.' type: number example: 10 TradeCostsTotalInBaseCurrency: title: The sum of all open costs and realized/unrealized close costs for the underlying positions. type: number example: 10 additionalProperties: false example: Ask: 10 AverageOpenPrice: 10 Bid: 10 CalculationReliability: Ok ConversionRateCurrent: 10 CurrentPrice: 10 CurrentPriceDelayMinutes: 99 CurrentPriceLastTraded: '9999-12-31T23:59:59.9999990+00:00' CurrentPriceType: LastTraded Exposure: 10 ExposureCurrency: stringValue ExposureInBaseCurrency: 10 IndexRatio: 10 InstrumentPriceDayPercentChange: 10 MarketValue: 10 MarketValueInBaseCurrency: 10 MarketValueOpen: 10 MarketValueOpenInBaseCurrency: 10 OpenInterest: 10 PositionCount: 99 PositionsNotClosedCount: 99 ProfitLossCurrencyConversion: 10 ProfitLossOnTrade: 10 ProfitLossOnTradeInBaseCurrency: 10 RealizedCostsTotal: 10 RealizedCostsTotalInBaseCurrency: 10 RealizedProfitLoss: 10 RealizedProfitLossInBaseCurrency: 10 SettlementInstruction: ActualRolloverAmount: 10 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 99 SettlementType: PartialSettlement Year: 99 Status: Closing TradeCostsTotal: 10 TradeCostsTotalInBaseCurrency: 10 NetPositionFieldGroup: title: Specification of fieldsets to include in results. enum: - DisplayAndFormat - ExchangeInfo - Greeks - NetPositionBase - NetPositionView - SinglePosition - SinglePositionBase - SinglePositionView type: string example: DisplayAndFormat x-enum-deprecated: - SinglePosition - SinglePositionBase - SinglePositionView x-enum-deprecated-date: SinglePosition: '2022-11-01' SinglePositionBase: '2022-11-01' SinglePositionView: '2022-11-01' x-enum-descriptions: NetPositionBase: NetPosition data which does not change whether viewed at client or account level DisplayAndFormat: Information about the instrument of the net position and how to display it. NetPositionView: 'NetPosition, data which is calculated differently whether viewed at client or account level' ExchangeInfo: 'Adds information about the instrument''s exchange. This includes Exchange name, exchange code and open status.' SinglePosition: "Obsolete If the NetPosition consists of a single position, include the positionid.\n This list will be empty if the NetPosition is comprised of more than one positions." SinglePositionBase: 'Obsolete If the NetPosition consists of a single position, include data which does not change whether viewed at client or account level.' SinglePositionView: 'Obsolete If the NetPosition consists of a single position, include data which is calculated differently whether viewed at client or account level, or changes with the market.' Greeks: 'Greeks for Option(s), only applicable to Fx Options , Contract Options and Contract options CFD' x-type-warning: FlaggableEnum NetPositionRequest: title: "Filters results so only netpositions that match the provided criteria are returned.\n ClientKey must be specified." required: - ClientKey type: object properties: AccountGroupKey: title: The key of the account group to which the positions belong. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account to which the positions belong. minLength: 1 type: string x-type-name: AccountKey AssetType: title: Optional. The AssetType. allOf: - $ref: '#/components/schemas/AssetType' ClientKey: title: The key of the client to which the positions belong. minLength: 1 type: string x-type-name: ClientKey ExpiryDate: title: Optional. The expiry date. Only used to distinguish FxOptions. type: string format: date-time x-type-name: UtcDateTime FieldGroups: title: 'Specifies which data to return. Default is [NetPositionBase,NetPositionView]' type: array items: $ref: '#/components/schemas/NetPositionFieldGroup' LowerBarrier: title: Optional. The Lower Barrier. Only used to distinguish Fx Barrier Options. type: number NetPositionId: title: Optional. The id of the netposition type: string PutCall: title: Optional. Put or Call. Only used to distinguish FxOptions. allOf: - $ref: '#/components/schemas/PutCall' Strike: title: Optional. The strike price of the option. Only used to distinguish FxOptions. type: number Uic: title: Optional. Unique id of the instrument. type: integer format: int32 UpperBarrier: title: Optional. The Upper Barrier. Only used to distinguish Fx Barrier Options. type: number ValueDate: title: Optional. The value date. Only used to distinguish FxForwards. type: string format: date-time x-type-name: UtcDateTime WatchlistId: title: Optional. Watchlist Id.Filter on watchlist instruments type: string additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== FieldGroups: - NetPositionView - NetPositionBase NetPositionId: EURUSD 41761NY 1.3765 C NetPositionResponse: title: "Data representing an open net position.\n Internal Note: Fields, which are also made available to communities are identified by a [Community] entry in the comment" required: - NetPositionId type: object properties: DisplayAndFormat: title: '[Community] Information about the instrument of the net position and how to display it.' allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' Exchange: title: Information about the exchange where this instrument or the underlying instrument is traded. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' Greeks: title: 'Greeks for option(s) i.e. FX Option, Contract Options and Contract Options CFD .' allOf: - $ref: '#/components/schemas/Greeks' NetPositionBase: title: Static part of net position information allOf: - $ref: '#/components/schemas/NetPositionStatic' NetPositionId: title: '[Community] The id of the net position. This can be used to fetch the open positions of a net position from the Positions service.' type: string example: stringValue NetPositionView: title: Dynamic part of net position information. allOf: - $ref: '#/components/schemas/NetPositionDynamic' SinglePosition: title: "Obsolete If the NetPosition consists of a single position, this is the position details.\n This will be empty if the NetPosition is comprised of more than one positions." allOf: - $ref: '#/components/schemas/SubPositionResponse' deprecated: true x-deprecated-date: '2022-11-01' additionalProperties: false example: NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 NetPositionResponseArray: type: array items: $ref: '#/components/schemas/NetPositionResponse' example: - NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 NetPositionResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/NetPositionResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 NetPositionStatic: title: Static information related to the net position. type: object properties: AccountId: title: "The id of the account to which the net position belongs.\n This is blank, if AccountKey was not specified in the querystring." type: string example: stringValue Amount: title: Sum volume of positions in instrument type: number example: 10 AmountLong: title: Sum of volume positions that are long. type: number example: 10 AmountShort: title: Sum of volume positions that are short. type: number example: 10 AssetType: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' BlockedQuantity: title: Stock blocking Quantity type: number example: 10 CanBeClosed: title: Indicates if the net position may be closed. type: boolean example: true ClientId: title: The id of the client to which the net position belongs. type: string example: stringValue ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime FixedIncomeData: title: Information specific to fixed income products. allOf: - $ref: '#/components/schemas/FixedIncomeData' HasForceOpenPositions: title: 'If true, Underlying position(s) having ForceOpen position(s)' type: boolean example: true IsMarketOpen: title: True if the instrument is currently tradable on its exchange. type: boolean example: true MarketState: title: Market state of exchange for instrument allOf: - $ref: '#/components/schemas/MarketState' NonTradableReason: title: Non tradable reason. allOf: - $ref: '#/components/schemas/NonTradableReasons' NoticeDate: title: Futures only - The date on which the owner may be required to take physical delivery of the instrument commodity. type: string format: date-time x-type-name: UtcDateTime NumberOfRelatedOrders: title: The number of related orders to positions under this NetPosition. type: integer format: int32 example: 99 OpenIndexRatioAverage: title: 'Open IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 OpenIpoOrdersCount: title: Open Ipo order(s) count type: integer format: int32 example: 99 OpenOrdersCount: title: Open order(s) Count type: integer format: int32 example: 99 OpenTriggerOrdersCount: title: Open Trigger order(s) Count type: integer format: int32 example: 99 OptionsData: title: 'Details for options, warrants and structured products.' allOf: - $ref: '#/components/schemas/OptionsData' PositionsAccount: title: 'If all underlying positions are on the same account then this is the account. If not, it is omitted.' maxLength: 16 minLength: 1 type: string x-type-name: AccountId ShortTrading: title: Short trading allowed or not on instrument allOf: - $ref: '#/components/schemas/ShortTrading' SinglePositionAccountId: title: "The accountid of the first and only position.\n Omitted if the net position has more than one underlying position." type: string example: stringValue SinglePositionId: title: "Unique id of the first and only position.\n Omitted if the net position has more than one underlying position." type: string example: stringValue SinglePositionStatus: title: "The status of the first and only position.\n Omitted if the net position has more than one underlying position." allOf: - $ref: '#/components/schemas/PositionStatus' SrdLastTradeDate: title: SRD Last Trade Date type: string format: date-time x-type-name: UtcDateTime SrdSettlementDate: title: SRD Settlement Date type: string format: date-time x-type-name: UtcDateTime TradingStatus: title: Instrument is tradable or not allOf: - $ref: '#/components/schemas/TradingStatus' Uic: title: Unique id of the instrument. type: integer format: int32 example: 99 ValueDate: title: The value date of the net position type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: AccountId: stringValue Amount: 10 AmountLong: 10 AmountShort: 10 AssetType: Stock BlockedQuantity: 10 CanBeClosed: true ClientId: stringValue ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' FixedIncomeData: ClosedAccruedInterest: 10 ClosedAccruedInterestInBaseCurrency: 10 Duration: 10 EffectiveYield: 10 OpenAccruedInterest: 10 OpenAccruedInterestInBaseCurrency: 10 HasForceOpenPositions: false IsMarketOpen: false MarketState: PostMarket NonTradableReason: ReduceOnlyInstrument NoticeDate: '9999-12-31T23:59:59.9999990+00:00' NumberOfRelatedOrders: 99 OpenIndexRatioAverage: 10 OpenIpoOrdersCount: 99 OpenOrdersCount: 99 OpenTriggerOrdersCount: 99 OptionsData: Barrier: 10 BarrierEventOccurred: false BarrierLower: 10 BarrierUpper: 10 CanBeExercised: true ExerciseStyle: None ExpiryCut: Warsaw ExpiryDate: '9999-12-31T23:59:59.999999Z' FinancingLevel: 10 Gearing: 10 LowerBarrier: 10 Moneyness: 10 PremiumDate: '9999-12-31T23:59:59.999999Z' PutCall: Call Ratio: 10 SettlementStyle: PhysicalDelivery SpreadStrikePriceLower: 10 SpreadStrikePriceUpper: 10 StopLossLevel: 10 Strike: 10 TradePerspective: Bull UpperBarrier: 10 PositionsAccount: 1577318a-1b95-44 ShortTrading: NotAllowed SinglePositionAccountId: stringValue SinglePositionId: stringValue SinglePositionStatus: Closed SrdLastTradeDate: '9999-12-31T23:59:59.9999990+00:00' SrdSettlementDate: '9999-12-31T23:59:59.9999990+00:00' TradingStatus: Tradable Uic: 99 ValueDate: '9999-12-31T23:59:59.9999990+00:00' NetPositionsSubscriptionRequest: title: Public request contract for setting up a subscription on a list of net positions required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/NetPositionRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== FieldGroups: - NetPositionView - NetPositionBase NetPositionId: EURUSD 41761NY 1.3765 C PriceMode: RegularTradingHours ContextId: '20221030064904217' Format: application/json ReferenceId: NP12768 RefreshRate: 1000 Tag: PAGE1 NetPositionsSubscriptionResponse: title: Public response contract returned after setting up a subscription on net position. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/NetPositionResponseListResult' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: ContextId: stringValue Format: stringValue InactivityTimeout: 99 ReferenceId: stringValue RefreshRate: 99 Snapshot: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' HasForceOpenPositions: false IsMarketOpen: false NonTradableReason: None NumberOfRelatedOrders: 0 OpeningDirection: Buy OpenIpoOrdersCount: 0 OpenOrdersCount: 0 OpenTriggerOrdersCount: 0 PositionsAccount: 192134INET SinglePositionStatus: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' NetPositionId: GPBUSD_FXSpot NetPositionView: AverageOpenPrice: 1.32167 AverageOpenPriceIncludingCosts: 1.32172 CalculationReliability: Ok CurrentPrice: 1.29188 CurrentPriceDelayMinutes: 15 CurrentPriceType: Mid Exposure: 100000 ExposureInBaseCurrency: 129205 InstrumentPriceDayPercentChange: 0.27 PositionCount: 1 PositionsNotClosedCount: 0 ProfitLossOnTrade: -2979 Status: Open TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 State: Active Tag: stringValue NonTradableReasons: title: Non Tradable Reasons enum: - ETFsWithoutKIIDs - ExpiredInstrument - NonShortableInstrument - None - NotOnlineClientTradable - OfflineTradableBonds - OtherReason - ReduceOnlyInstrument type: string example: NotOnlineClientTradable x-enum-descriptions: None: None NotOnlineClientTradable: This instrument is not tradable ReduceOnlyInstrument: This instrument is not reduce-only ExpiredInstrument: This instrument has expired OfflineTradableBonds: This instrument is tradable offline ETFsWithoutKIIDs: The issuer has not provided a Key Information Document (KID) for this instrument NonShortableInstrument: Short selling is not available for this instrument OtherReason: This instrument is not tradable OpenOrderRelation: title: Description of the order relation. enum: - IfDoneMaster - IfDoneSlave - IfDoneSlaveOco - Oco - StandAlone type: string example: Oco x-enum-descriptions: StandAlone: Standalone. No relations to other orders. Oco: 'One cancels other. Relation between two orders. When one is filled, the other is cancelled.' IfDoneMaster: If done master. Relation between two or three orders. The slave orders are released only if the master order is filled. IfDoneSlave: If done slave. Relation between two orders. The other is always IfDoneMaster. IfDoneSlaveOco: "If done slave OCO. Relation between three orders. One is always IfDoneMaster and the other is always also IfDoneSlaveOCO.\n The OCO relation is between the two slave orders." OpenOrdersRequest: title: "Represents a request for one or more open orders.\n At least one of the following must be specified." required: - ClientKey type: object properties: AccountGroupKey: title: The key of the account group to which the order belongs. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: Unique key identifying the account that owns the orders. minLength: 1 type: string x-type-name: AccountKey ClientKey: title: Unique key identifying the client that owns the orders. minLength: 1 type: string x-type-name: ClientKey FieldGroups: title: 'Specifies which data to return. Default is empty, meaning Display and Formatting information is not included.' type: array items: $ref: '#/components/schemas/OrderFieldGroup' OrderId: title: The id of the order type: string Status: title: Selects only a subset of open orders to be returned. Default is to return working orders only. allOf: - $ref: '#/components/schemas/OrderStatusFilter' WatchlistId: title: Selects only orders those instruments belongs to the given watchlist id type: string additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== OptionsData: title: Public data contract for options (both FX Options and ETO's)). type: object properties: BarrierEventOccurred: title: True if the barrier event has occurred for the option type: boolean example: true CanBeExercised: title: 'If true, the option position may be exercised by the user.' type: boolean example: true ExerciseStyle: title: Used to indicate if an option is to follow American or European style exercise rules. American-style may be exercised at any time. European-style may only be exercised at expiry. allOf: - $ref: '#/components/schemas/ExerciseStyle' ExpiryCut: title: ExpiryCut. allOf: - $ref: '#/components/schemas/ExpiryCut' ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime LowerBarrier: title: LowerBarrier for digital option. type: number example: 10 PremiumDate: title: Forex Options premium date. type: string format: date-time x-type-name: UtcDateTime PutCall: title: The Put/Call value of the option. allOf: - $ref: '#/components/schemas/PutCall' SettlementStyle: title: The settlement style of the option allOf: - $ref: '#/components/schemas/SettlementStyle' Strike: title: The strike price of the option. type: number example: 10 UpperBarrier: title: UpperBarrier for digital option. type: number example: 10 additionalProperties: false example: BarrierEventOccurred: true CanBeExercised: false ExerciseStyle: American ExpiryCut: NY ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' LowerBarrier: 10 PremiumDate: '9999-12-31T23:59:59.9999990+00:00' PutCall: None SettlementStyle: PhysicalDelivery Strike: 10 UpperBarrier: 10 OptionsStrategyType: title: Common exchange traded options strategies. enum: - BackRatio - Butterfly - CalendarSpread - Combo - Condor - Custom - Diagonal - Gut - IronButterfly - IronCondor - RiskReversal - Straddle - Strangle - Synthetic - Vertical type: string example: BackRatio x-enum-descriptions: Custom: User defined custom strategy. Vertical: 'A vertical spread has two legs. One is buy and one is sell with same expiration date, but with different strike prices.' BackRatio: 'Consists of two options, of same type and expiry, but with different amounts and strike prices.' Diagonal: 'A diagonal spread is two options of the same type, one buy and one sell, but with different expiry times and different strike prices. Essentially a combination of a Vertical and Calendar spread.' Condor: 'A condor strategy leverages four options with same expiry. A buy and a sell in the money, and a buy and a sell out of the money. Can also be characterized as two call spreads.' Butterfly: 'Non directional strategy that combines legs of same expiry, but with varying amounts and strike prices.' IronButterfly: Two overlapping vertical spreads. One of the verticals is on the call side and one is on the put side. IronCondor: A combined put and call spread with same expiration but varying different strikes. Straddle: 'A position in both a call and a put with the same underlier, strike price and maturity expiration date' Strangle: A position in both a call and put with different strike prices but with the same maturity and underlier RiskReversal: 'One leg is an OTM put, the other leg is an OTM call.' CalendarSpread: 'A calendar spread is a long-short position is two calls or two puts. Both options have the same strike, but they have different expirations.' Gut: 'Buy a call and then buy a put at a higher strike price, Sell a call and then sell a put at higher strike price. 1:1 ratio' Synthetic: 'Buy a call, sell a put at the same strike. Sell a call, buy a put at the same strike. 1:1 ratio' Combo: 'Sell call, buy put at lower strike. Buy call, Sell put at lower strike (1:1 ratio).' OrderAmountType: title: Indicates if the order Amount is specified as an absolute amount of lots/shares/contracts or as a currency value. enum: - CashAmount - Quantity type: string example: CashAmount x-enum-descriptions: Quantity: Default. Order Amount is specified as an amount of lots/shares/contracts. CashAmount: Order amount is specified as a monetary value. OrderDuration: title: "The time frame during which the order is valid.\n If the OrderDurationType is GoodTillDate, then an ExpirationDateTime must also be provided." type: object properties: DurationType: title: Gets the order duration type. allOf: - $ref: '#/components/schemas/OrderDurationType' ExpirationDate: title: 'Obsolete. The ExpirationDate, if the Order Type is GoodTillDate. The field has been obsoleted and will be removed from OpenAPI on or after November 1, 2022. Use ExpirationDateTime instead.' type: string format: date-time deprecated: true x-deprecated-date: '2022-11-01' x-type-name: UtcDateTime ExpirationDateContainsTime: title: 'Gets the value indicating whether the ExpirationDateTime field contains the time. Notice, that the value can only be true for GoodTillDate duration type.' type: boolean example: true ExpirationDateTime: title: Gets the expiration date and (optionally) time if the order duration type is GoodTillDate. type: string description: 'If the field contains a time, it will always be expressed in the exchange local time. No time zone indication will be added.' example: stringValue additionalProperties: false example: DurationType: GoodTillCancel ExpirationDate: '2020-12-04T06:36:30.1014980+00:00' ExpirationDateContainsTime: true ExpirationDateTime: '2020-12-04T06:36:30.1014983' OrderDurationType: title: "An enum describing the different order duration types.\n Note that not all order types are possible for all asset types." enum: - AtTheClose - AtTheOpening - DayOrder - FillOrKill - GoodForPeriod - GoodTillCancel - GoodTillDate - ImmediateOrCancel type: string example: AtTheClose x-enum-descriptions: AtTheClose: At the close of the trading session. AtTheOpening: At the opening of the trading session. DayOrder: Day Order - Valid for the trading session. FillOrKill: Fill or Kill order. GoodForPeriod: Good for a specified period. GoodTillCancel: Good til Cancel. GoodTillDate: Good til Date - Expiration Date must also be specified. ImmediateOrCancel: Immediate or Cancel Order. OrderFieldGroup: title: Specification of the additional fields to be included in the result. enum: - DisplayAndFormat - ExchangeInfo - Greeks type: string example: DisplayAndFormat x-enum-descriptions: DisplayAndFormat: 'Adds information about the instrument, which is useful for display and formatting. This includes Currency Code, Decimals, Instrument Description, Display Decimals, Price format and Symbol' ExchangeInfo: 'Adds information about the instrument''s exchange. This includes Exchange name, exchange code and open status.' Greeks: 'Greeks for Option(s), only applicable to Fx Options , Contract Options and Contract options CFD' x-type-warning: FlaggableEnum OrderOptionsData: title: 'Data specific to options, warrants and warrant derivatives in the orders list.' type: object properties: ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime PutCall: title: The Put/Call value of the option. allOf: - $ref: '#/components/schemas/PutCall' Strike: title: The strike price of the option. type: number example: 10 additionalProperties: false example: ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' PutCall: None Strike: 10 OrderResponse: title: Describes an open order. required: - OrderId type: object properties: AccountId: title: The id of the account to which the net position belongs. type: string example: stringValue AccountKey: title: Unique key of the account where the order is placed minLength: 1 type: string x-type-name: AccountKey AdviceNote: title: Field for adviser to place relevant information. type: string example: stringValue AlgoOrderData: title: Additional order data for algorithmic orders. type: array items: $ref: '#/components/schemas/StringStringKeyValuePair' example: stringValue: stringValue AlgoStrategyName: title: Type of algo order strategy. type: string example: stringValue AllocationKeyId: title: Allocation Key type: string example: stringValue Amount: title: Order size type: number example: 10 Ask: title: The current market ask price. type: number example: 10 AssetType: title: The instrument asset type. allOf: - $ref: '#/components/schemas/AssetType' Bid: title: The current market bid price. type: number example: 10 BreakoutTriggerDownPrice: title: 'Used for conditional BreakoutTrigger orders. Lower trigger price. If the instrument price falls below this level, a stop loss order will be activated.' type: number example: 10 BreakoutTriggerUpPrice: title: 'Used for conditional BreakoutTrigger orders. Upper trigger price. If the instrument price exceeds this level, a take profit limit order will be activated.' type: number example: 10 BuySell: title: Indicates if the order is Buy Or Sell. allOf: - $ref: '#/components/schemas/BuySell' CalculationReliability: title: If an error was encountered this code indicates source of the calculation error. allOf: - $ref: '#/components/schemas/CalculationReliability' CashAmount: title: 'The monetary/cash purchase amount, only used when OrderAmountType is ValueInInstrumentCurrency. When set, ignore order Amount.' type: number example: 10 ClientId: title: Unique identifier of the client. type: string example: stringValue ClientKey: title: Unique key of the client where the order is placed minLength: 1 type: string x-type-name: ClientKey ClientName: title: The name of the client. type: string example: stringValue ClientNote: title: The specific text instructions for the Trading Desk to better understand IAM users intentions for staging the order. type: string example: stringValue CopiedPositionId: title: The ID of the position this order was copied from type: string example: stringValue CorrelationKey: title: Correlation key pattern: '^[0-9a-fA-F]{32}$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string example: 7347a716-2626-4198-bd00-5e5025b13265 CorrelationTypes: title: Type of the correlation type: array items: $ref: '#/components/schemas/CorrelationType' example: - Exercise CurrentPrice: title: The user specific(delayed/realtime) current market price of the instrument. type: number example: 10 CurrentPriceDelayMinutes: title: 'If set, it defines the number of minutes by which the price is delayed.' type: integer format: int32 example: 99 CurrentPriceLastTraded: title: Indicates when the user specific current market price of the instrument was last traded. type: string format: date-time x-type-name: UtcDateTime CurrentPriceType: title: The price type (Bid/Ask/LastTraded) of the user specific(delayed/realtime) current market price of the instrument. allOf: - $ref: '#/components/schemas/PriceType' DisplayAndFormat: title: Information about the instrument and how to display it. allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' DistanceToMarket: title: Distance to market for this order. (Dynamically updating) type: number example: 10 Duration: title: "The time frame during which the order is valid.\n If the OrderDurationType is GTD, then an ExpirationDate must also be provided." allOf: - $ref: '#/components/schemas/OrderDuration' Exchange: title: Information about the instrument's exchange and trading status. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' ExpiryDate: title: The ExpiryDate. Valid for options and futures. type: string format: date-time x-type-name: UtcDateTime ExternalReference: title: Gets or sets the Client order reference id. type: string example: stringValue FilledAmount: title: 'The amount of the order, which has already been filled, in case of partial fills.' type: number example: 10 Greeks: title: 'Greeks for option(s) i.e. FX Option, Contract Options and Contract Options CFD .' allOf: - $ref: '#/components/schemas/Greeks' IpoFinancingAmountPct: title: Financing Amount Pct for IPO orders type: number example: 10 IpoSubscriptionFee: title: Subscription fee for IPO orders type: number example: 10 IsForceOpen: title: 'If True, the order''s resulting position will not automatically be netted with position(s) in the opposite direction' type: boolean example: true IsMarketOpen: title: True if the instrument is currently tradable on its exchange. type: boolean example: true MarketPrice: title: Current trading price of instrument. (Dynamically updating) type: number example: 10 MarketState: title: Market state of exchange for instrument allOf: - $ref: '#/components/schemas/MarketState' MarketValue: title: Market value of position excl. closing costs. type: number example: 10 MultiLegOrderDetails: title: Common properties for multi-leg (strategy) orders. allOf: - $ref: '#/components/schemas/MultiLegOrderDetails' NonTradableReason: title: Non tradable reason. allOf: - $ref: '#/components/schemas/NonTradableReasons' OpenInterest: title: The total number of contracts that have not been settled and remain open as of the end of a trading day. type: number example: 10 OpenOrderType: title: Specifies the Order Type. allOf: - $ref: '#/components/schemas/OrderType' OptionsData: title: 'Details for options, warrants and structured products.' allOf: - $ref: '#/components/schemas/OrderOptionsData' OrderAmountType: title: Indicates if the order Amount is specified as lots/shares/contracts or as a monetary purchase amount in instrument currency. allOf: - $ref: '#/components/schemas/OrderAmountType' OrderId: title: Unique Id of the order. type: string example: stringValue OrderRelation: title: Relation to other active orders. allOf: - $ref: '#/components/schemas/OpenOrderRelation' OrderTime: title: The UTC date and time the order was placed type: string format: date-time x-type-name: UtcDateTime OwnerId: title: Client id of the client's owner. Only set when relevant. type: string example: stringValue Price: title: Price at which the order is triggered. type: number example: 10 RelatedOpenOrders: title: "List of information about related open orders.\n There should be enough information that the UI can show the price of the order, and calculate distance to market." type: array items: $ref: '#/components/schemas/RelatedOrderInfo' example: - Amount: 10 Duration: DurationType: FillOrKill ExpirationDate: '2024-01-04T22:16:38.580726Z' ExpirationDateContainsTime: false ExpirationDateTime: '2024-01-04T22:16:38.5807263' OpenOrderType: StopIfTraded OrderId: stringValue OrderPrice: 10 StopLimitPrice: 10 TrailingStopDistanceToMarket: 10 TrailingStopStep: 10 RelatedPositionId: title: Id of the related position. type: string example: stringValue ShortTrading: title: Short trading allowed or not on instrument allOf: - $ref: '#/components/schemas/ShortTrading' SleepingOrderCondition: title: Represent the condition on sleeping order. allOf: - $ref: '#/components/schemas/SleepingOrderCondition' Status: title: Current status of the order allOf: - $ref: '#/components/schemas/OrderStatus' StopLimitPrice: title: Secondary price level for StopLimit orders. type: number example: 10 SwitchInstrumentName: title: Name of 'SwitchInstrumentUic'/>. type: string example: stringValue SwitchInstrumentUic: title: 'Mutual funds only. When set, instructs the order is to switch (transfer) the value of a matching open position into the specified "switch" instrument (UIC).' type: integer format: int32 example: 99 ToOpenClose: title: Whether the position should be created to open/increase or close/decrease a position. allOf: - $ref: '#/components/schemas/ToOpenClose' TradeAllocationKey: title: Obsolete. Trade Allocation Key type: integer format: int32 example: 99 deprecated: true x-deprecated-date: '2022-10-01' TradeIdeaId: title: The ID of the TradeMaker recommendation. type: string example: stringValue TradingStatus: title: Instrument is tradable or not allOf: - $ref: '#/components/schemas/TradingStatus' TrailingStopDistanceToMarket: title: Distance to market for a trailing stop order. type: number example: 10 TrailingStopStep: title: Step size for trailing stop order. type: number example: 10 TriggerParentOrderId: title: Order id of related conditional order that controls placement/activation of this order. type: string example: stringValue TriggerPriceType: title: Type of price chosen to trigger a conditional order. allOf: - $ref: '#/components/schemas/OrderTriggerPriceType' Uic: title: Unique Id of the instrument type: integer format: int32 example: 99 ValueDate: title: The value date (only for FxForwards). type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00.0000000+00:00' Price: 1.05 Status: Working Uic: 21 OrderResponseArray: type: array items: $ref: '#/components/schemas/OrderResponse' example: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 Status: Working Uic: 21 OrderResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/OrderResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 Status: Working Uic: 21 OrderStatus: title: Indicates the visible status of an order. enum: - Filled - LockedPlacementPending - NotWorking - NotWorkingLockedCancelPending - NotWorkingLockedChangePending - Parked - Unknown - Working - WorkingLockedCancelPending - WorkingLockedChangePending type: string example: Working x-enum-descriptions: Unknown: Unknown Working: Working LockedPlacementPending: Locked. Placement pending. WorkingLockedChangePending: Working. Locked. Change Pending. WorkingLockedCancelPending: Working. Locked. Cancel Pending. Filled: Filled NotWorking: Not Working NotWorkingLockedChangePending: Locked. Change pending. NotWorkingLockedCancelPending: Locked. Cancel pending. Parked: 'Parked orders are in inactive state, can''t be filled, but remain available in so they can be made active at any time. Clients can manually ''park'' and ''activate'' an order.' OrderStatusFilter: title: Used to select only a subset of open orders to be returned. enum: - All - Working type: string example: Working x-enum-descriptions: Working: Returns only top level orders and OCO orders. Stop/Limit orders details are available in the RelatedOrders properties. All: Returns all orders regardless of type OrderSubscriptionRequest: title: Public request contract for setting up a subscription on orders for a client. required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/OpenOrdersRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== ContextId: '20221030064905457' Format: application/json ReferenceId: O40952 RefreshRate: 5 Tag: PAGE1 OrderSubscriptionResponse: title: Public response contract returned after setting up a subscription on orders for a client. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/OrderResponseListResult' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: Format: application/json InactivityTimeout: 120 ReferenceId: O03905 RefreshRate: 1000 Snapshot: Data: - AccountId: 192134INET AccountKey: LZTc7DdejXODf-WSl2aCyQ== Amount: 250000 AssetType: FxSpot BuySell: Buy CalculationReliability: Ok ClientKey: 7m4I|vtYLUnEGg77o9uQhw== CurrentPrice: 1.09062 CurrentPriceDelayMinutes: 0 CurrentPriceType: Ask DistanceToMarket: 0.04062 Duration: DurationType: GoodTillCancel IsExtendedHoursEnabled: false IsForceOpen: false IsMarketOpen: false MarketPrice: 1.09062 NonTradableReason: None OpenOrderType: Limit OrderAmountType: Quantity OrderId: '49318458' OrderRelation: StandAlone OrderTime: '2017-04-12T07:56:00Z' Price: 1.05 PriceWithoutSpread: 1.04 Status: Working Uic: 21 State: Active OrderTriggerPriceType: title: Type of price chosen to trigger a conditional order. enum: - Ask - Bid - Close - LastTraded - Open type: string example: Open x-enum-descriptions: LastTraded: Last traded price Open: Market open price Close: Closing price Bid: Bid Ask: Ask OrderType: title: Specifies under what conditions an order should be triggered. enum: - BreakoutTrigger - CallLimit - CallStop - DealCapture - GuaranteedStop - Limit - LimitTrigger - Market - MarketDefault - MarketExpiry - MarketRollover - MarketStopOut - PreviouslyQuoted - Stop - StopIfTraded - StopLimit - StopTrigger - Switch - TrailingStop - TrailingStopIfTraded - TrailingStopLimit - Traspaso - TraspasoIn - TriggerBreakout - TriggerLimit - TriggerStop - Unknown type: string example: Market x-enum-deprecated: - LimitTrigger - StopTrigger - BreakoutTrigger x-enum-deprecated-date: LimitTrigger: '2022-10-01' StopTrigger: '2022-10-01' BreakoutTrigger: '2022-10-01' x-enum-descriptions: Unknown: Unknown Market: Market. Limit: Limit. StopIfTraded: Stop if traded. Stop: Stop. StopLimit: Stop Limit. MarketStopOut: Market StopOut CallLimit: Call Limit CallStop: Call Stop MarketExpiry: Market Expiry TrailingStopIfTraded: Trailing stop if traded TrailingStop: Trailing stop TrailingStopLimit: Trailing Stop Limit PreviouslyQuoted: Previously Quoted. MarketDefault: Market Default. Switch: 'Switch order, Sell X and Buy Y with one order.' Traspaso: Specific type of switch order. Only available on select MutualFunds. TraspasoIn: Specific type of switch order. Only available on select MutualFunds. GuaranteedStop: Guaranteed Stop. Currently not supported. MarketRollover: Market Rollover orders are used to automate the process of closing out open positions in soon to expire contracts in favour of contracts with later expiration dates. LimitTrigger: 'If the price moves above or below the trigger price, then place related order.' StopTrigger: 'If price falls below trigger price, a stop order with a trailing distance is placed. Similar to a trailing stop order.' BreakoutTrigger: 'If asset price goes above or below defined upper/lower limit (trigger) prices, then place related order.' DealCapture: Deal capture order TriggerBreakout: 'If asset price goes above or below defined upper/lower limit (trigger) prices, then place related order.' TriggerLimit: 'If the price moves above or below the trigger price, then place related order.' TriggerStop: 'If price falls below trigger price, a stop order with a trailing distance is placed. Similar to a trailing stop order.' OriginalCostData: title: "Contains original cost data for Net Positions.\n Available for Mutual Funds only." type: object properties: IndicativeExitTaxApplicable: title: "Discloses aggregate profit of profit-making positions.\n Includes deferred tax and P/L for current positions based on cost of the Original Position/Subscription." type: number example: 10 IndicativeProfitLossOnTrade: title: Aggregate Profit/Loss across all current positions for instrument. type: number example: 10 OpenCost: title: Original Opening Cost. type: number example: 10 additionalProperties: false example: IndicativeExitTaxApplicable: 10 IndicativeProfitLossOnTrade: 10 OpenCost: 10 PortfolioMarginMethod: title: Specifies the margin calculaion method for the given entity. enum: - Default - JanusMarginReplication - SpanForFutures - SpanForFuturesAndOptions type: string example: SpanForFutures x-enum-descriptions: Default: Uses Saxo exposure based margin. SpanForFutures: Uses rules-based SPAN methods to calculate margin on futures alone. SpanForFuturesAndOptions: Uses rules-based SPAN methods to calculate margin on futures and options. JanusMarginReplication: Uses rules-based the Janus methodology to calculate margin. PositionClosingMethod: title: Intra day netting modes enum: - Explicit - Fifo - Unknown type: string example: Fifo x-enum-descriptions: Explicit: Explicit closed Fifo: Netting Closed Unknown: Unknown PositionCost: title: Trading costs associated with opening/closing a position type: object properties: CloseCost: title: Costs associated with the closing trade. allOf: - $ref: '#/components/schemas/CostData' CloseCostInBaseCurrency: title: A Estimate of the cost of closing all underlying positions in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' CurrencyCutPct: title: Currency cut percentage. type: number example: 10 OpenCost: title: Costs associated with the opening trade. allOf: - $ref: '#/components/schemas/CostData' OpenCostInBaseCurrency: title: Costs associated with the opening trade in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' additionalProperties: false example: PositionDetailedResponse: title: Detailed information about a position.This is only provided as a snapshot and can not be subscribed to. required: - PositionId type: object properties: Costs: title: Trading costs associated with opening/closing a position. allOf: - $ref: '#/components/schemas/PositionCost' DisplayAndFormat: title: Information about the position instrument and how to display it. allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' Exchange: title: Information about the instrument's exchange and trading status. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' Greeks: title: 'Greeks, only available for options, i.e. FX Options, Contract Options, and Contract Options CFDs.' allOf: - $ref: '#/components/schemas/Greeks' NetPositionId: title: 'The id of the NetPosition, to which this position is belongs. All positions in the same instrument have the same NetPositionId.' type: string example: stringValue PositionBase: title: Static part of position information. allOf: - $ref: '#/components/schemas/PositionStatic' PositionDetails: title: Additional details related to the position. allOf: - $ref: '#/components/schemas/PositionDetails' PositionId: title: Unique id of this position. type: string example: stringValue PositionView: title: Dynamic part of position information. allOf: - $ref: '#/components/schemas/PositionDynamic' additionalProperties: false example: DisplayAndFormat: Currency: EUR Decimals: 4 Description: British Pound/US Dollar Format: AllowDecimalPips Symbol: GBPUSD NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 PositionDetails: title: 'Detailed information about a position, which is only available as a snapshot.' type: object properties: AllocationKeyId: title: Allocation Key type: string example: stringValue CloseCost: title: Costs associated with the closing trade. allOf: - $ref: '#/components/schemas/CostData' CloseCostInBaseCurrency: title: A Estimate of the cost of closing all underlying positions in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' CopiedPositionId: title: 'The id of the position that this position was copied from, if applicable.' type: string example: stringValue CorrelationKey: title: Obsolete. Correlation key. pattern: '^[0-9a-fA-F]{32}$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string example: 7347a716-2626-4198-bd00-5e5025b13265 deprecated: true x-deprecated-date: '2022-11-01' CorrelationTypes: title: Obsolete. Type of the correlation. type: array items: $ref: '#/components/schemas/CorrelationType' example: - Exercise deprecated: true x-deprecated-date: '2022-11-01' CurrencyCutPct: title: Currency cut percentage. type: number example: 10 ExternalReference: title: Gets or sets the Client order reference id. type: string example: stringValue Greeks: title: Greeks (if option). allOf: - $ref: '#/components/schemas/Greeks' LockedByBackOffice: title: Indicates whether the position is currently locked by back office. type: boolean example: true MarketValue: title: Market value of position excl. closing costs. type: number example: 10 MarketValueInBaseCurrency: title: 'The total nominal value of the of the underlying positions, in requested account/client currency.' type: number example: 10 MarketValueOpen: title: "Obsolete. MarketValueOpen will not be available from 01 November 2022, use PositionView.MarketValueOpen instead.\n The value of the position at time of opening." type: number example: 10 deprecated: true x-deprecated-date: '2022-11-01' OpenCost: title: Costs associated with the opening trade. allOf: - $ref: '#/components/schemas/CostData' OpenCostInBaseCurrency: title: Costs associated with the opening trade in requested account or client currency. allOf: - $ref: '#/components/schemas/CostData' OpenSwap: title: Specifies the swap component of an FX forward price. type: number example: 10 OriginatingAlgoOrderStrategyId: title: The ID of originating AlgoOrderStrategy. type: string example: stringValue OriginatingAlgoOrderText: title: Description of the originating AlgoOrder. type: string example: stringValue SourceOrderId: title: Obsolete. Unique id of the source order. type: string example: stringValue deprecated: true x-deprecated-date: '2022-11-01' StrategyId: title: Associated trade strategy id. type: string example: stringValue TradeIdeaId: title: The ID of the trademaker recommendation. type: string example: stringValue additionalProperties: false example: CloseCost: AdditionalTransactionCosts: 0.5 Commission: 216 ExchangeFee: 239 ExternalCharges: 5 PerformanceFee: 80 StampDuty: 156 CopiedPositionId: '1019942425' CorrelationKey: 0f8fad5b-d9cb-469f-a165-70867728950e CorrelationTypes: - AutoTrade CurrencyCutPct: 237 Greeks: Delta: 29 Gamma: 2 InstrumentDelta: 0 InstrumentGamma: 0 InstrumentTheta: 0 InstrumentVega: 0 MidVol: 165 Theta: 192 Vega: 74 LockedByBackOffice: true OpenCost: AdditionalTransactionCosts: 0.5 Commission: 211 ExchangeFee: 239 ExternalCharges: 3 PerformanceFee: 40 StampDuty: 1 OpenSwap: 101 OriginatingAlgoOrderStrategyId: 4b47 OriginatingAlgoOrderText: 48b6-b3b7-e43ed121d72a SourceOrderId: 1fb3-4e83-973f-72857983b72d StrategyId: b260-85eb3b4b729f TradeIdeaId: fa316a7-6b8a-4010-9ce6-593925c1bf19 PositionDynamic: title: 'Dynamic Contents for a Position. The following fields are updated as prices change or the position is updated, filled or closed.' type: object properties: Ask: title: The current market ask price. type: number example: 10 Bid: title: The current market bid price. type: number example: 10 CalculationReliability: title: If an error was encountered this code indicates source of the calculation error. allOf: - $ref: '#/components/schemas/CalculationReliability' ConversionRateClose: title: Conversion rate used for closing trade costs. type: number example: 10 ConversionRateCurrent: title: Current conversion rate used for opening trade costs. type: number example: 10 ConversionRateOpen: title: Conversion rate used for opening trade costs. type: number example: 10 CurrentPrice: title: The current price for the instrument type: number example: 10 CurrentPriceDelayMinutes: title: 'If set, it defines the number of minutes by which the price is delayed.' type: integer format: int32 example: 99 CurrentPriceLastTraded: title: Indicates when the user specific current market price of the instrument was last traded. type: string format: date-time x-type-name: UtcDateTime CurrentPriceType: title: The price type (Bid/Ask/LastTraded) of the user specific(delayed/realtime) current market price of the instrument. allOf: - $ref: '#/components/schemas/PriceType' Exposure: title: 'Current nominal value of position, but differs from market value in that it has a value for margin products.' type: number example: 10 ExposureCurrency: title: Currency of exposure. type: string example: stringValue ExposureInBaseCurrency: title: 'Current nominal value of position, but differs from market value in that it has a value for margin products. Converted to requesting account/client currency.' type: number example: 10 IndexRatio: title: 'Current IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 InstrumentPriceDayPercentChange: title: Percent change in instrument's price between Previous Close and current Last Traded price. type: number example: 10 MarketState: allOf: - $ref: '#/components/schemas/MarketState' MarketValue: title: Market value of position excl. closing costs. type: number example: 10 MarketValueInBaseCurrency: title: 'The total nominal value of the of the underlying positions, in requested account/client currency.' type: number example: 10 MarketValueOpen: title: The value of the position at time of opening. type: number example: 10 MarketValueOpenInBaseCurrency: title: 'The nominal value of the position at the time of open, in requested account/client currency.' type: number example: 10 OpenInterest: title: The total number of contracts that have not been settled and remain open as of the end of a trading day. type: number example: 10 ProfitLossCurrencyConversion: title: The P/L from currency conversion between now and position open. type: number example: 10 ProfitLossOnTrade: title: The P/L in the quote currency. type: number example: 10 ProfitLossOnTradeInBaseCurrency: title: The P/L on in the client/account base currency. type: number example: 10 SettlementInstruction: title: SettlementInstruction allOf: - $ref: '#/components/schemas/SettlementInstructions' TradeCostsTotal: title: 'The sum of all open costs and realized/unrealized close costs for the underlying positions, in instrument currency.' type: number example: 10 TradeCostsTotalInBaseCurrency: title: The sum of all open costs and realized/unrealized close costs for the underlying positions. type: number example: 10 additionalProperties: false example: Ask: 10 Bid: 10 CalculationReliability: CurrencyConversionFailed ConversionRateClose: 10 ConversionRateCurrent: 10 ConversionRateOpen: 10 CurrentPrice: 10 CurrentPriceDelayMinutes: 99 CurrentPriceLastTraded: '9999-12-31T23:59:59.9999990+00:00' CurrentPriceType: Mid Exposure: 10 ExposureCurrency: stringValue ExposureInBaseCurrency: 10 IndexRatio: 10 InstrumentPriceDayPercentChange: 10 MarketState: PreMarket MarketValue: 10 MarketValueInBaseCurrency: 10 MarketValueOpen: 10 MarketValueOpenInBaseCurrency: 10 OpenInterest: 10 ProfitLossCurrencyConversion: 10 ProfitLossOnTrade: 10 ProfitLossOnTradeInBaseCurrency: 10 SettlementInstruction: ActualRolloverAmount: 10 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: true Month: 99 SettlementType: PartialSettlement Year: 99 TradeCostsTotal: 10 TradeCostsTotalInBaseCurrency: 10 PositionFieldGroup: title: Specification of fieldsets to include in results. enum: - Costs - DisplayAndFormat - ExchangeInfo - Greeks - PositionBase - PositionIdOnly - PositionView type: string example: DisplayAndFormat x-enum-descriptions: PositionBase: 'Individual Positions. Base data, which does not change with client/account view, or market data' DisplayAndFormat: Information about the instrument of the position and how to display it. PositionView: 'Individual Positions. Dynamic Data, which changes with client/account view, or market data' ExchangeInfo: 'Adds information about the instrument''s exchange. This includes Exchange name, exchange code and open status.' PositionIdOnly: Individual PositionId only. Greeks: 'Greeks for Option(s), only applicable to Fx Options , Contract Options and Contract options CFD' Costs: Trading costs associated with opening/closing a position x-type-warning: FlaggableEnum PositionPagingSubscriptionUpdateRequest: title: A parameter wrapper for position subscription paging update operations. type: object properties: NewPageSize: title: 'Extends or reduces the page size, number of positions shown, on a running positions subscription.' type: integer format: int32 example: 99 additionalProperties: false example: NewPageSize: 99 PositionRequest: title: "Represents a request for one or more netpositions.\n At least one of the following must be specified." required: - ClientKey type: object properties: AccountGroupKey: title: The key of the account group to which the net positions belongs. minLength: 1 type: string x-type-name: AccountGroupKey AccountKey: title: The key of the account to which the net positions belongs. minLength: 1 type: string x-type-name: AccountKey ClientKey: title: The key of the client to which the net positions belongs. minLength: 1 type: string x-type-name: ClientKey FieldGroups: title: 'Specifies which data to return. Default is [PositionBase,PositionView]' type: array items: $ref: '#/components/schemas/PositionFieldGroup' NetPositionId: title: The id of the netposition to which the position belongs type: string PositionId: title: The id of the position. type: string WatchlistId: title: Selects only positions those instruments belongs to the given watchlist id type: string additionalProperties: false example: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== FieldGroups: - PositionBase - PositionView NetPositionId: GBPUSD_FxSpot PositionId: '1019942425' PositionResponse: title: Describes an open position required: - PositionId type: object properties: Costs: title: Trading costs associated with opening/closing a position. allOf: - $ref: '#/components/schemas/PositionCost' DisplayAndFormat: title: Information about the position instrument and how to display it. allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' Exchange: title: Information about the instrument's exchange and trading status. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' Greeks: title: 'Greeks, only available for options, i.e. FX Options, Contract Options, and Contract Options CFDs.' allOf: - $ref: '#/components/schemas/Greeks' NetPositionId: title: 'The id of the NetPosition, to which this position is belongs. All positions in the same instrument have the same NetPositionId.' type: string example: stringValue PositionBase: title: Static part of position information. allOf: - $ref: '#/components/schemas/PositionStatic' PositionId: title: Unique id of this position. type: string example: stringValue PositionView: title: Dynamic part of position information. allOf: - $ref: '#/components/schemas/PositionDynamic' additionalProperties: false example: NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 PositionResponseArray: type: array items: $ref: '#/components/schemas/PositionResponse' example: - NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 PositionResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/PositionResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: __next: /openapi/port/....../?$top=1&$skip=1 Data: - NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 PositionStatic: title: Static contents for a position. The following fields do not change when the price is updated type: object properties: AccountId: title: The id of the account to which the position belongs. type: string example: stringValue AccountKey: title: Unique key of the account where the position is placed. minLength: 1 type: string x-type-name: AccountKey AllocationKeyId: title: Allocation Key type: string example: stringValue Amount: title: Sum volume of positions in instrument. type: number example: 10 AssetType: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' CanBeClosed: title: Indicates if the position may be closed. type: boolean example: true ClientId: title: The id of the client to which the position belongs. type: string example: stringValue CloseConversionRateSettled: title: True when the closing trades currency conversion rate has been settled (i.e. is fixed and not fluctuating). This is the case for accounts using Market Conversion-Rates. type: boolean example: true ContractId: title: The position's options board contract. Only applicable if the position was registered as originating from the options board. type: integer format: int32 example: 99 CopiedPositionId: title: 'The id of the position that this position was copied from, if applicable.' type: string example: stringValue CorrelationKey: title: Correlation key. pattern: '^[0-9a-fA-F]{32}$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string example: 7347a716-2626-4198-bd00-5e5025b13265 CorrelationTypes: title: Type of the correlation. type: array items: $ref: '#/components/schemas/CorrelationType' example: - Exercise ExecutionTimeClose: title: The UTC date and time the position was closed. type: string format: date-time x-type-name: UtcDateTime ExecutionTimeOpen: title: The UTC date and time the position was opened. type: string format: date-time x-type-name: UtcDateTime ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime ExternalReference: title: Gets or sets the Client order reference id. type: string example: stringValue FixedIncomeData: title: Information related to fixed income products. allOf: - $ref: '#/components/schemas/FixedIncomeData' IsForceOpen: title: 'If True, the position will not automatically be netted with position in the opposite direction' type: boolean example: true IsMarketOpen: title: True if the instrument is currently tradable on its exchange. type: boolean example: true LockedByBackOffice: title: Indicates whether the position is currently locked by back office. type: boolean example: true NoticeDate: title: Futures only - The date on which the owner may be required to take physical delivery of the instrument commodity. type: string format: date-time x-type-name: UtcDateTime OpenIndexRatio: title: 'Open IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 OpenPrice: title: The price the instrument was traded at. type: number example: 10 OpenPriceIncludingCosts: title: 'The price the instrument was traded, with trading costs added.' type: number example: 10 OpenSwap: title: Specifies the swap component of an FX forward price. type: number example: 10 OptionsData: title: 'Details for options, warrants and structured products.' allOf: - $ref: '#/components/schemas/OptionsData' OriginatingAlgoOrderStrategyId: title: The ID of originating AlgoOrderStrategy. type: string example: stringValue RelatedOpenOrders: title: List of information about related open orders. type: array items: $ref: '#/components/schemas/RelatedOrderInfo' example: - Amount: 10 Duration: DurationType: DayOrder ExpirationDate: '2020-11-24T19:15:24.794692Z' ExpirationDateContainsTime: false ExpirationDateTime: '2020-11-24T19:15:24.7946925' OpenOrderType: TrailingStop OrderId: stringValue OrderPrice: 10 StopLimitPrice: 10 TrailingStopDistanceToMarket: 10 TrailingStopStep: 10 RelatedPositionId: title: Id of possible related position. type: string example: stringValue SourceOrderId: title: Unique id of the source order type: string example: stringValue SpotDate: title: The date on which settlement is to occur for an Fx spot transaction. type: string format: date x-type-name: Date SrdLastTradeDate: title: SRD Last Trade Date type: string format: date-time x-type-name: UtcDateTime SrdSettlementDate: title: SRD Settlement Date type: string format: date-time x-type-name: UtcDateTime Status: title: "The status of the position. \n Possible values: Open, Closed, Closing, PartiallyClosed, Locked." allOf: - $ref: '#/components/schemas/PositionStatus' StrategyId: title: Associated trade strategy id. type: string example: stringValue ToOpenClose: title: Whether the position was opened in order to open/increase or close/decrease a position. allOf: - $ref: '#/components/schemas/ToOpenClose' Uic: title: Unique id of the instrument. type: integer format: int32 example: 99 ValueDate: title: The value date of the position. type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: AccountId: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 AllocationKeyId: stringValue Amount: 10 AssetType: CfdOnIndex CanBeClosed: false ClientId: stringValue CloseConversionRateSettled: true ContractId: 99 CopiedPositionId: stringValue CorrelationKey: 1980106f-51d1-46cd-a6da-08632dc8341e CorrelationTypes: - AutoExercise ExecutionTimeClose: '9999-12-31T23:59:59.9999990+00:00' ExecutionTimeOpen: '9999-12-31T23:59:59.9999990+00:00' ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' ExternalReference: stringValue FixedIncomeData: ClosedAccruedInterest: 10 ClosedAccruedInterestInBaseCurrency: 10 Duration: 10 EffectiveYield: 10 OpenAccruedInterest: 10 OpenAccruedInterestInBaseCurrency: 10 IsForceOpen: false IsMarketOpen: true LockedByBackOffice: false NoticeDate: '9999-12-31T23:59:59.9999990+00:00' OpenIndexRatio: 10 OpenPrice: 10 OpenPriceIncludingCosts: 10 OpenSwap: 10 OptionsData: Barrier: 10 BarrierEventOccurred: false BarrierLower: 10 BarrierUpper: 10 CanBeExercised: true ExerciseStyle: None ExpiryCut: None ExpiryDate: '9999-12-31T23:59:59.999999Z' FinancingLevel: 10 Gearing: 10 LowerBarrier: 10 Moneyness: 10 PremiumDate: '9999-12-31T23:59:59.999999Z' PutCall: Call Ratio: 10 SettlementStyle: CashDelivery SpreadStrikePriceLower: 10 SpreadStrikePriceUpper: 10 StopLossLevel: 10 Strike: 10 TradePerspective: Long UpperBarrier: 10 OriginatingAlgoOrderStrategyId: stringValue RelatedPositionId: stringValue SourceOrderId: stringValue SpotDate: '0001-01-01' SrdLastTradeDate: '9999-12-31T23:59:59.9999990+00:00' SrdSettlementDate: '9999-12-31T23:59:59.9999990+00:00' Status: Open StrategyId: stringValue ToOpenClose: ToClose Uic: 99 ValueDate: '9999-12-31T23:59:59.9999990+00:00' PositionStatus: title: Defines possible values for position or net position status. enum: - Closed - Closing - Locked - Open - PartiallyClosed - RelatedClose - Square type: string example: Closed x-enum-descriptions: Open: Open Closed: Closed Closing: Closing with market order PartiallyClosed: Partially closed Locked: Locked by back office RelatedClose: Related closing position Square: Implicitly closed. Used for Net Positions only. PositionsSubscriptionRequest: title: Public request contract for setting up a subscription on open positions. required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\n This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9_-]{1,50}$' type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\n This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters." pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReferenceId-1 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/PositionRequest' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n Currently only application/json and application/x-protobuf is supported.\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string example: application/json RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n Note that it is not possible to get a refresh rate lower than the rate specified in the\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 example: 0 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string example: ReplaceReferenceId-1 Tag: title: Optional client specified tag used for grouping subscriptions. type: string example: ClientTag additionalProperties: false example: Arguments: AccountGroupKey: LZTc7DdejXODf-WSl2aCyQ== AccountKey: LZTc7DdejXODf-WSl2aCyQ== ClientKey: 7m4I|vtYLUnEGg77o9uQhw== FieldGroups: - PositionBase - PositionView NetPositionId: GBPUSD_FxSpot PositionId: '1019942425' PriceMode: RegularTradingHours ContextId: '20221030064905734' Format: application/json ReferenceId: P48094 RefreshRate: 1000 Tag: PAGE1 PositionsSubscriptionResponse: title: Public response contract returned after setting up a subscription on open positions. type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string example: ContextId-1 x-display-order: 1 ReferenceId: title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type) type: string example: ReferenceId-1 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string example: application/json InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 example: 0 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 example: 0 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' allOf: - $ref: '#/components/schemas/PositionResponseListResult' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. example: Active Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string example: ClientTag additionalProperties: false example: Format: application/json InactivityTimeout: 120 ReferenceId: P11029 RefreshRate: 1000 Snapshot: Data: - NetPositionId: GBPUSD_FxSpot PositionBase: AccountId: 192134INET Amount: 100000 AssetType: FxSpot CanBeClosed: true ClientId: '654321' CloseConversionRateSettled: false ExecutionTimeOpen: '2016-09-02T10:25:00Z' IsForceOpen: false IsMarketOpen: false LockedByBackOffice: false OpenPrice: 1.32167 SpotDate: '2016-09-06' Status: Open Uic: 31 ValueDate: '2017-05-04T00:00:00Z' PositionId: '1019942425' PositionView: Ask: 1.2917 Bid: 1.29162 CalculationReliability: Ok CurrentPrice: 1.29169 CurrentPriceDelayMinutes: 0 CurrentPriceType: Bid Exposure: 100000 ExposureCurrency: GBP ExposureInBaseCurrency: 129192 InstrumentPriceDayPercentChange: 0.26 ProfitLossOnTrade: -2998 ProfitLossOnTradeInBaseCurrency: -2998 SettlementInstruction: ActualRolloverAmount: 0 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 7 SettlementType: FullSettlement Year: 2020 TradeCostsTotal: 0 TradeCostsTotalInBaseCurrency: 0 State: Active PriceDisplayFormatType: title: The format modifiers in which e.g. a price must be displayed and possibly edited. enum: - AllowDecimalPips - Fractions - ModernFractions - Normal - Percentage type: string example: Fractions x-enum-descriptions: Normal: Standard decimal formatting is used with the Decimals field indicating the number of decimals. Fractions: Display as regular fraction i.e. 3 1/4 ModernFractions: 'Special US Bonds futures fractional format (1/32s or 1/128s without nominator). If PriceDecimals = -5 then the nominator is 32, else 128.' Percentage: 'Display as percentage, e.g. 12.34%.' AllowDecimalPips: "Display the last digit as a smaller than the rest of the numbers. Note that this digit is not included in the number of decimals, effectively\n increasing the number of decimals by one. E.g. 12.345 when Decimals is 2 and DisplayFormat is AllowDecimalPips." PriceType: title: Used to describe the type of the price enum: - Ask - Bid - Close - High - Indicative - LastTraded - Low - Mid - None - Open - Synthetic type: string example: Ask x-enum-descriptions: Bid: Highest price from buyer. Ask: Best offer from seller (offer price) Mid: The price between the best price of the sellers (bid) and best offer from the buyers (ask). LastTraded: Price at which instrument was last traded. Close: Official price of instrument at the end of trading session. Open: Official price of instrument at the start of trading session. Synthetic: Computed price of instrument. High: Highest traded price in period. Low: Lowest traded price in period. Indicative: 'Best estimate price based on market conditions. Used mainly in low liquidity markets, where Bid/Ask/LastTraded/Close may not be available.' None: Unknown/No value set PutCall: title: Describes the direction of an option. enum: - Call - None - Put type: string example: Put x-enum-descriptions: None: Not specified. Put: Put. Call: Call. RelatedOrderInfo: title: Information about related order to be shown on order list. required: - OrderId type: object properties: Amount: title: Order size type: number example: 10 Duration: title: The time frame during which the order is valid. allOf: - $ref: '#/components/schemas/OrderDuration' OpenOrderType: title: The order type. allOf: - $ref: '#/components/schemas/OrderType' OrderId: title: The orderId. type: string example: stringValue OrderPrice: title: Price at which the order is triggered. type: number example: 10 StopLimitPrice: title: Stop limit price for stop limit order. type: number example: 10 TrailingStopDistanceToMarket: title: Distance to market for a trailing stop order. type: number example: 10 TrailingStopStep: title: Step size for trailing stop order. type: number example: 10 additionalProperties: false example: Amount: 10 Duration: DurationType: DayOrder ExpirationDate: '2023-11-17T01:00:56.411915Z' ExpirationDateContainsTime: true ExpirationDateTime: '2023-11-17T01:00:56.4119159' OpenOrderType: Limit OrderId: stringValue OrderPrice: 10 StopLimitPrice: 10 TrailingStopDistanceToMarket: 10 TrailingStopStep: 10 SecurityLendingEnabled: title: Security Lending Enabled. enum: - No - Yes type: string example: Yes x-enum-descriptions: Yes: Security Lending is enabled. No: Security Lending is disabled. SettlementInstructions: title: SettlementInstructions associated with a net position type: object properties: ActualRolloverAmount: title: The amount that will be rolled over type: number example: 10 ActualSettlementAmount: title: The amount of the net positions that is going to settle type: number example: 10 Amount: title: The amount that is given by the client and stored as instructions type: number example: 10 IsSettlementInstructionsAllowed: title: The liquidation date is the last day where the instructions can be updated and it can be done till the exchange is open. type: boolean example: true Month: title: SRD Calendar month type: integer format: int32 example: 99 SettlementType: title: Client's chosen settlement type allOf: - $ref: '#/components/schemas/SettlementType' Year: title: SRD Calendar year type: integer format: int32 example: 99 additionalProperties: false example: ActualRolloverAmount: 10 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 99 SettlementType: FullSettlement Year: 99 SettlementStyle: title: Options for how a contract option is settled when exercised. enum: - CashDelivery - PhysicalDelivery type: string example: CashDelivery x-enum-descriptions: CashDelivery: The contract option is settled as cash. PhysicalDelivery: The contract option is settled by physical delivery. SettlementType: title: SettlementType for SRD enum: - FullRollover - FullSettlement - PartialSettlement type: string example: FullRollover x-enum-descriptions: PartialSettlement: Default / Partial settlement method. Use the amount for settlement FullSettlement: FullSettlement. Ignore amount and settle all FullRollover: Full Roll over. Delete instructions and revert to default SRD behaviour ShortTrading: title: Indicates whether short trading is allowed or not. enum: - Allowed - NotAllowed type: string example: Allowed x-enum-descriptions: Allowed: Short trading is possible for instrument. NotAllowed: Short trading is not possible for instrument. SleepingOrderCondition: title: Represent trigger order ( or condition on sleeping order) required: - ConditionId type: object properties: Amount: title: Order size type: number example: 10 AssetType: title: The instrument asset type. allOf: - $ref: '#/components/schemas/AssetType' BreakoutTriggerDownPrice: title: 'Used for conditional BreakoutTrigger orders. Lower trigger price. If the instrument price falls below this level, a stop loss order will be activated.' type: number example: 10 BreakoutTriggerUpPrice: title: 'Used for conditional BreakoutTrigger orders. Upper trigger price. If the instrument price exceeds this level, a take profit limit order will be activated.' type: number example: 10 BuySell: title: Indicates if the order is Buy Or Sell. allOf: - $ref: '#/components/schemas/BuySell' CalculationReliability: title: If an error was encountered this code indicates source of the calculation error. allOf: - $ref: '#/components/schemas/CalculationReliability' ConditionId: title: Unique Id of the Condition. type: string example: stringValue CopiedPositionId: title: The ID of the position this order was copied from type: string example: stringValue CurrentPrice: title: The user specific(delayed/realtime) current market price of the instrument. type: number example: 10 CurrentPriceDelayMinutes: title: 'If set, it defines the number of minutes by which the price is delayed.' type: integer format: int32 example: 99 CurrentPriceType: title: The price type (Bid/Ask/LastTraded) of the user specific(delayed/realtime) current market price of the instrument. allOf: - $ref: '#/components/schemas/PriceType' DisplayAndFormat: title: Information about the instrument and how to display it. allOf: - $ref: '#/components/schemas/InstrumentDisplayAndFormat' DistanceToMarket: title: Distance to market for this order. (Dynamically updating) type: number example: 10 Duration: title: "The time frame during which the order is valid.\n If the OrderDurationType is GTD, then an ExpirationDate must also be provided." allOf: - $ref: '#/components/schemas/OrderDuration' Exchange: title: Information about the instrument's exchange and trading status. allOf: - $ref: '#/components/schemas/InstrumentExchangeDetails' ExpiryDate: title: The ExpiryDate. Valid for options and futures. type: string format: date-time x-type-name: UtcDateTime IsForceOpen: title: 'If True, the order''s resulting position will not automatically be netted with position(s) in the opposite direction' type: boolean example: true IsMarketOpen: title: True if the instrument is currently tradable on its exchange. type: boolean example: true MarketPrice: title: Current trading price of instrument. (Dynamically updating) type: number example: 10 MarketState: title: Market state of exchange for instrument allOf: - $ref: '#/components/schemas/MarketState' NonTradableReason: title: Non tradable reason. allOf: - $ref: '#/components/schemas/NonTradableReasons' OpenOrderType: title: Specifies the Order Type. allOf: - $ref: '#/components/schemas/OrderType' OrderAmountType: title: Indicates if the order Amount is specified as lots/shares/contracts or as a monetary purchase amount in instrument currency. allOf: - $ref: '#/components/schemas/OrderAmountType' OrderRelation: title: Relation to other active orders. allOf: - $ref: '#/components/schemas/OpenOrderRelation' OrderTime: title: The UTC date and time the order was placed type: string format: date-time x-type-name: UtcDateTime Price: title: Price at which the order is triggered. type: number example: 10 RelatedPositionId: title: Id of the related position. type: string example: stringValue Status: title: Current status of the order allOf: - $ref: '#/components/schemas/OrderStatus' StopLimitPrice: title: Secondary price level for StopLimit orders. type: number example: 10 ToOpenClose: title: Whether the position should be created to open/increase or close/decrease a position. allOf: - $ref: '#/components/schemas/ToOpenClose' TrailingStopDistanceToMarket: title: Distance to market for a trailing stop order. type: number example: 10 TrailingStopStep: title: Step size for trailing stop order. type: number example: 10 TriggerPriceType: title: Type of price chosen to trigger a conditional order. allOf: - $ref: '#/components/schemas/OrderTriggerPriceType' Uic: title: Unique Id of the instrument type: integer format: int32 example: 99 ValueDate: title: The value date (only for FxForwards). type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: Amount: 10 AssetType: Bond BreakoutTriggerDownPrice: 10 BreakoutTriggerUpPrice: 10 BuySell: Buy CalculationReliability: Ok ConditionId: stringValue CopiedPositionId: stringValue CurrentPrice: 10 CurrentPriceDelayMinutes: 99 CurrentPriceType: Bid DisplayAndFormat: BarrierDecimals: 99 BarrierFormat: ModernFractions Currency: stringValue Decimals: 99 Description: stringValue DisplayHint: None Format: Normal NumeratorDecimals: 99 OrderDecimals: 99 StrikeDecimals: 99 StrikeFormat: Fractions Symbol: stringValue UnderlyingInstrumentDescription: stringValue DistanceToMarket: 10 Duration: ExpirationDate: '2023-01-01T03:10:02.158361Z' ExpirationDateContainsTime: false ExpirationDateTime: '2023-01-01T03:10:02.1583618' Exchange: Description: stringValue ExchangeId: stringValue IsOpen: true TimeZoneId: stringValue ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' IsForceOpen: false IsMarketOpen: true MarketPrice: 10 MarketState: Open NonTradableReason: None OpenOrderType: Unknown OrderAmountType: Quantity OrderRelation: StandAlone OrderTime: '9999-12-31T23:59:59.9999990+00:00' Price: 10 RelatedPositionId: stringValue Status: Unknown StopLimitPrice: 10 ToOpenClose: Undefined TrailingStopDistanceToMarket: 10 TrailingStopStep: 10 TriggerPriceType: LastTraded Uic: 99 ValueDate: '9999-12-31T23:59:59.9999990+00:00' SpendingPower: title: Describes the spending power. type: object properties: Current: title: The current spending power available. type: number example: 10 Maximum: title: Spending power for shares / ETF (based on max collateral factor defined for shares) type: number example: 10 additionalProperties: false example: Current: 10 Maximum: 10 StockBlockingDetail: title: Stock Blocking Detail type: object properties: BlockingId: title: Blocking Id type: integer format: int32 example: 99 BlockingQuantity: title: Blocking Quantity type: number example: 10 BlockingReason: title: Blocking Reason type: string example: stringValue EventReferenceId: title: Event reference Id type: string example: stringValue additionalProperties: false example: BlockingId: 99 BlockingQuantity: 10 BlockingReason: stringValue EventReferenceId: stringValue StringStringKeyValuePair: type: object properties: Key: type: string example: stringValue Value: type: string example: stringValue additionalProperties: false example: Key: stringValue Value: stringValue SubPositionBase: title: The static part of a sub position. type: object properties: AccountId: title: The id of the account to which the position belongs. type: string example: stringValue AccountKey: title: Unique key of the account where the position is placed. minLength: 1 type: string x-type-name: AccountKey AllocationKeyId: title: Allocation Key type: string example: stringValue Amount: title: Sum volume of positions in instrument. type: number example: 10 AssetType: title: The AssetType. allOf: - $ref: '#/components/schemas/AssetType' CanBeClosed: title: Indicates if the position may be closed. type: boolean example: true ClientId: title: The id of the client to which the position belongs. type: string example: stringValue CloseConversionRateSettled: title: True when the closing trades currency conversion rate has been settled (i.e. is fixed and not fluctuating). This is the case for accounts using Market Conversion-Rates. type: boolean example: true ContractId: title: The position's options board contract. Only applicable if the position was registered as originating from the options board. type: integer format: int32 example: 99 CopiedPositionId: title: 'The id of the position that this position was copied from, if applicable.' type: string example: stringValue CorrelationKey: title: Correlation key. pattern: '^[0-9a-fA-F]{32}$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string example: 7347a716-2626-4198-bd00-5e5025b13265 CorrelationTypes: title: Type of the correlation. type: array items: $ref: '#/components/schemas/CorrelationType' example: - Exercise ExecutionTimeClose: title: The UTC date and time the position was closed. type: string format: date-time x-type-name: UtcDateTime ExecutionTimeOpen: title: The UTC date and time the position was opened. type: string format: date-time x-type-name: UtcDateTime ExpiryDate: title: The ExpiryDate. type: string format: date-time x-type-name: UtcDateTime ExternalReference: title: Gets or sets the Client order reference id. type: string example: stringValue FixedIncomeData: title: Information related to fixed income products. allOf: - $ref: '#/components/schemas/FixedIncomeData' IsForceOpen: title: 'If True, the position will not automatically be netted with position in the opposite direction' type: boolean example: true IsMarketOpen: title: True if the instrument is currently tradable on its exchange. type: boolean example: true LockedByBackOffice: title: Indicates whether the position is currently locked by back office. type: boolean example: true NoticeDate: title: Futures only - The date on which the owner may be required to take physical delivery of the instrument commodity. type: string format: date-time x-type-name: UtcDateTime OpenIndexRatio: title: 'Open IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 OpenPrice: title: The price the instrument was traded at. type: number example: 10 OpenPriceIncludingCosts: title: 'The price the instrument was traded, with trading costs added.' type: number example: 10 OpenSwap: title: Specifies the swap component of an FX forward price. type: number example: 10 OptionsData: title: 'Details for options, warrants and structured products.' allOf: - $ref: '#/components/schemas/OptionsData' OriginatingAlgoOrderStrategyId: title: The ID of originating AlgoOrderStrategy. type: string example: stringValue RelatedOpenOrders: title: List of information about related open orders. type: array items: $ref: '#/components/schemas/RelatedOrderInfo' example: - Amount: 10 Duration: DurationType: DayOrder ExpirationDate: '2020-11-24T19:15:24.794692Z' ExpirationDateContainsTime: false ExpirationDateTime: '2020-11-24T19:15:24.7946925' OpenOrderType: TrailingStop OrderId: stringValue OrderPrice: 10 StopLimitPrice: 10 TrailingStopDistanceToMarket: 10 TrailingStopStep: 10 RelatedPositionId: title: Id of possible related position. type: string example: stringValue SourceOrderId: title: Unique id of the source order type: string example: stringValue SpotDate: title: The date on which settlement is to occur for an Fx spot transaction. type: string format: date x-type-name: Date SrdLastTradeDate: title: SRD Last Trade Date type: string format: date-time x-type-name: UtcDateTime SrdSettlementDate: title: SRD Settlement Date type: string format: date-time x-type-name: UtcDateTime Status: title: "The status of the position. \n Possible values: Open, Closed, Closing, PartiallyClosed, Locked." allOf: - $ref: '#/components/schemas/PositionStatus' StrategyId: title: Associated trade strategy id. type: string example: stringValue ToOpenClose: title: Whether the position was opened in order to open/increase or close/decrease a position. allOf: - $ref: '#/components/schemas/ToOpenClose' Uic: title: Unique id of the instrument. type: integer format: int32 example: 99 ValueDate: title: The value date of the position. type: string format: date-time x-type-name: UtcDateTime additionalProperties: false example: AccountId: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 AllocationKeyId: stringValue Amount: 10 AssetType: Bond CanBeClosed: true ClientId: stringValue CloseConversionRateSettled: false ContractId: 99 CopiedPositionId: stringValue CorrelationKey: 43f1c909-b877-4b07-b8fb-f3c002c235f6 CorrelationTypes: - Exercise ExecutionTimeClose: '9999-12-31T23:59:59.9999990+00:00' ExecutionTimeOpen: '9999-12-31T23:59:59.9999990+00:00' ExpiryDate: '9999-12-31T23:59:59.9999990+00:00' ExternalReference: stringValue FixedIncomeData: ClosedAccruedInterest: 10 ClosedAccruedInterestInBaseCurrency: 10 Duration: 10 EffectiveYield: 10 OpenAccruedInterest: 10 OpenAccruedInterestInBaseCurrency: 10 IsForceOpen: true IsMarketOpen: false LockedByBackOffice: true NoticeDate: '9999-12-31T23:59:59.9999990+00:00' OpenIndexRatio: 10 OpenPrice: 10 OpenPriceIncludingCosts: 10 OpenSwap: 10 OptionsData: Barrier: 10 BarrierEventOccurred: true BarrierLower: 10 BarrierUpper: 10 CanBeExercised: false ExerciseStyle: European ExpiryCut: PreciousMetals ExpiryDate: '9999-12-31T23:59:59.999999Z' FinancingLevel: 10 Gearing: 10 LowerBarrier: 10 Moneyness: 10 PremiumDate: '9999-12-31T23:59:59.999999Z' PutCall: Put Ratio: 10 SettlementStyle: PhysicalDelivery SpreadStrikePriceLower: 10 SpreadStrikePriceUpper: 10 StopLossLevel: 10 Strike: 10 TradePerspective: Call UpperBarrier: 10 OriginatingAlgoOrderStrategyId: stringValue RelatedPositionId: stringValue SourceOrderId: stringValue SpotDate: '0001-01-01' SrdLastTradeDate: '9999-12-31T23:59:59.9999990+00:00' SrdSettlementDate: '9999-12-31T23:59:59.9999990+00:00' Status: Locked StrategyId: stringValue ToOpenClose: Undefined Uic: 99 ValueDate: '9999-12-31T23:59:59.9999990+00:00' SubPositionResponse: title: Information for a position linked up to a net position required: - PositionId type: object properties: PositionBase: title: Obsolete Position fields which do not change with price updates allOf: - $ref: '#/components/schemas/SubPositionBase' deprecated: true x-deprecated-date: '2022-11-01' PositionId: title: Obsolete Unique id of the position. type: string example: stringValue deprecated: true x-deprecated-date: '2022-11-01' PositionView: title: Obsolete Position fields which do change with price updates allOf: - $ref: '#/components/schemas/SubPositionView' deprecated: true x-deprecated-date: '2022-11-01' additionalProperties: false example: PositionBase: AccountId: stringValue AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86 AllocationKeyId: stringValue Amount: 10 AssetType: StockOption CanBeClosed: true ClientId: stringValue CloseConversionRateSettled: false ContractId: 99 CopiedPositionId: stringValue CorrelationKey: 24673932-52b1-49dd-a767-d2a42e672fa5 CorrelationTypes: - Allocation ExecutionTimeClose: '9999-12-31T23:59:59.999999Z' ExecutionTimeOpen: '9999-12-31T23:59:59.999999Z' ExpiryDate: '9999-12-31T23:59:59.999999Z' ExternalReference: stringValue FixedIncomeData: ClosedAccruedInterest: 10 ClosedAccruedInterestInBaseCurrency: 10 Duration: 10 EffectiveYield: 10 OpenAccruedInterest: 10 OpenAccruedInterestInBaseCurrency: 10 IsForceOpen: true Isin: stringValue IsMarketOpen: false IssuerName: stringValue LockedByBackOffice: true NoticeDate: '9999-12-31T23:59:59.999999Z' OpenIndexRatio: 10 OpenPrice: 10 OpenPriceIncludingCosts: 10 OpenSwap: 10 OptionsData: Barrier: 10 BarrierEventOccurred: true BarrierLower: 10 BarrierUpper: 10 CanBeExercised: false ExerciseStyle: American ExpiryCut: Budapest ExpiryDate: '9999-12-31T23:59:59.999999Z' FinancingLevel: 10 Gearing: 10 LowerBarrier: 10 Moneyness: 10 PremiumDate: '9999-12-31T23:59:59.999999Z' PutCall: None Ratio: 10 SettlementStyle: CashDelivery SpreadStrikePriceLower: 10 SpreadStrikePriceUpper: 10 StopLossLevel: 10 Strike: 10 TradePerspective: Bear UpperBarrier: 10 OriginatingAlgoOrderStrategyId: stringValue RelatedPositionId: stringValue SourceOrderId: stringValue SpotDate: '0001-01-01' SrdLastTradeDate: '9999-12-31T23:59:59.999999Z' SrdSettlementDate: '9999-12-31T23:59:59.999999Z' Status: PartiallyClosed StrategyId: stringValue ToOpenClose: ToClose Uic: 99 ValueDate: '9999-12-31T23:59:59.999999Z' PositionId: stringValue PositionView: Ask: 10 Bid: 10 CalculationReliability: UnknownPrice ConversionRateClose: 10 ConversionRateCurrent: 10 ConversionRateOpen: 10 CurrentPrice: 10 CurrentPriceDelayMinutes: 99 CurrentPriceLastTraded: '9999-12-31T23:59:59.999999Z' CurrentPriceType: Close Exposure: 10 ExposureCurrency: stringValue ExposureInBaseCurrency: 10 IndexRatio: 10 InstrumentPriceDayPercentChange: 10 MarketState: IntraDayAuction MarketValue: 10 MarketValueInBaseCurrency: 10 MarketValueOpen: 10 MarketValueOpenInBaseCurrency: 10 OpenInterest: 10 ProfitLossCurrencyConversion: 10 ProfitLossOnTrade: 10 ProfitLossOnTradeInBaseCurrency: 10 SettlementInstruction: ActualRolloverAmount: 10 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 99 SettlementType: FullSettlement Year: 99 TradeCostsTotal: 10 TradeCostsTotalInBaseCurrency: 10 SubPositionView: title: Dynamic part of a sub position. This information may change type: object properties: Ask: title: The current market ask price. type: number example: 10 Bid: title: The current market bid price. type: number example: 10 CalculationReliability: title: If an error was encountered this code indicates source of the calculation error. allOf: - $ref: '#/components/schemas/CalculationReliability' ConversionRateClose: title: Conversion rate used for closing trade costs. type: number example: 10 ConversionRateCurrent: title: Current conversion rate used for opening trade costs. type: number example: 10 ConversionRateOpen: title: Conversion rate used for opening trade costs. type: number example: 10 CurrentPrice: title: The current price for the instrument type: number example: 10 CurrentPriceDelayMinutes: title: 'If set, it defines the number of minutes by which the price is delayed.' type: integer format: int32 example: 99 CurrentPriceLastTraded: title: Indicates when the user specific current market price of the instrument was last traded. type: string format: date-time x-type-name: UtcDateTime CurrentPriceType: title: The price type (Bid/Ask/LastTraded) of the user specific(delayed/realtime) current market price of the instrument. allOf: - $ref: '#/components/schemas/PriceType' Exposure: title: 'Current nominal value of position, but differs from market value in that it has a value for margin products.' type: number example: 10 ExposureCurrency: title: Currency of exposure. type: string example: stringValue ExposureInBaseCurrency: title: 'Current nominal value of position, but differs from market value in that it has a value for margin products. Converted to requesting account/client currency.' type: number example: 10 IndexRatio: title: 'Current IndexRatio, Applicable for Inflation linked bonds.' type: number example: 10 InstrumentPriceDayPercentChange: title: Percent change in instrument's price between Previous Close and current Last Traded price. type: number example: 10 MarketState: allOf: - $ref: '#/components/schemas/MarketState' MarketValue: title: Market value of position excl. closing costs. type: number example: 10 MarketValueInBaseCurrency: title: 'The total nominal value of the of the underlying positions, in requested account/client currency.' type: number example: 10 MarketValueOpen: title: The value of the position at time of opening. type: number example: 10 MarketValueOpenInBaseCurrency: title: 'The nominal value of the position at the time of open, in requested account/client currency.' type: number example: 10 OpenInterest: title: The total number of contracts that have not been settled and remain open as of the end of a trading day. type: number example: 10 ProfitLossCurrencyConversion: title: The P/L from currency conversion between now and position open. type: number example: 10 ProfitLossOnTrade: title: The P/L in the quote currency. type: number example: 10 ProfitLossOnTradeInBaseCurrency: title: The P/L on in the client/account base currency. type: number example: 10 SettlementInstruction: title: SettlementInstruction allOf: - $ref: '#/components/schemas/SettlementInstructions' TradeCostsTotal: title: 'The sum of all open costs and realized/unrealized close costs for the underlying positions, in instrument currency.' type: number example: 10 TradeCostsTotalInBaseCurrency: title: The sum of all open costs and realized/unrealized close costs for the underlying positions. type: number example: 10 additionalProperties: false example: Ask: 10 Bid: 10 CalculationReliability: CurrencyConversionFailed ConversionRateClose: 10 ConversionRateCurrent: 10 ConversionRateOpen: 10 CurrentPrice: 10 CurrentPriceDelayMinutes: 99 CurrentPriceLastTraded: '9999-12-31T23:59:59.9999990+00:00' CurrentPriceType: Open Exposure: 10 ExposureCurrency: stringValue ExposureInBaseCurrency: 10 IndexRatio: 10 InstrumentPriceDayPercentChange: 10 MarketState: OpeningAuction MarketValue: 10 MarketValueInBaseCurrency: 10 MarketValueOpen: 10 MarketValueOpenInBaseCurrency: 10 OpenInterest: 10 ProfitLossCurrencyConversion: 10 ProfitLossOnTrade: 10 ProfitLossOnTradeInBaseCurrency: 10 SettlementInstruction: ActualRolloverAmount: 10 ActualSettlementAmount: 10 Amount: 10 IsSettlementInstructionsAllowed: false Month: 99 SettlementType: FullRollover Year: 99 TradeCostsTotal: 10 TradeCostsTotalInBaseCurrency: 10 ToOpenClose: title: Specifies whether the order will be created to open/increase or close/decrease a position (only relevant for options). enum: - ToClose - ToOpen - Undefined type: string example: ToOpen x-enum-descriptions: Undefined: Undefined. ToOpen: Order/Position is ToOpen. ToClose: Order/Position is ToClose. TradingStatus: title: Trading status of an instrument. enum: - NonTradable - NotDefined - ReduceOnly - Tradable type: string example: NotDefined x-enum-descriptions: NotDefined: Not Defined Tradable: Instrument is tradable NonTradable: Instrument is non tradable ReduceOnly: 'Instrument is Reduce only, which means client can only reduce the exposure by closing existing open position(s) and cannot open new position(s).' x-type-warning: FlaggableEnum TransactionsNotBookedDetail: title: Detail of transaction(s) that yet have to be booked. type: object properties: Accrual: title: Net accrual for the transaction(s) not booked yet type: number example: 10 AdditionalTransactionCost: title: Net additional transaction cost for the transaction(s) not booked yet type: number example: 10 BondValue: title: Net bond value for the transaction(s) not booked yet type: number example: 10 CashDeposit: title: Net cash deposit for the transaction(s) not booked yet type: number example: 10 CashReservation: title: Net cash reservation for the transaction(s) not booked yet type: number example: 10 CashWithdrawal: title: Net cash withdrawal for the transaction(s) not booked yet type: number example: 10 CertificatesValue: title: Net value of certificates for the transaction(s) not booked yet type: number example: 10 Commission: title: Net commission for the transaction(s) not booked yet type: number example: 10 ExchangeFee: title: Net exchange fee for the transaction(s) not booked yet type: number example: 10 ExternalCharges: title: Net external charges for the transaction(s) not booked yet type: number example: 10 FundsReservedByOrder: title: Net funds reserved by order for the transaction(s) not booked yet type: number example: 10 IpoSubscriptionFee: title: IPO subscription fee for the transaction(s) not booked yet type: number example: 10 LeveragedKnockOutProductsValue: title: Net value of leveraged knock-out products (Turbos) for the transaction(s) not booked yet. type: number example: 10 MutualFundValue: title: Net mutual fund value for the transaction(s) not booked yet type: number example: 10 OptionPremium: title: Net option premium for the transaction(s) not booked yet type: number example: 10 ShareValue: title: Net share value for the transaction(s) not booked yet type: number example: 10 StampDuty: title: Net stamp duty for the transaction(s) not booked yet type: number example: 10 WarrantPremium: title: Net warrant premium for the transaction(s) not booked yet type: number example: 10 additionalProperties: false example: Accrual: 10 AdditionalTransactionCost: 10 BondValue: 10 CashDeposit: 10 CashReservation: 10 CashWithdrawal: 10 CertificatesValue: 10 Commission: 10 ExchangeFee: 10 ExternalCharges: 10 FundsReservedByOrder: 10 IpoSubscriptionFee: 10 LeveragedKnockOutProductsValue: 10 MutualFundValue: 10 OptionPremium: 10 ShareValue: 10 StampDuty: 10 WarrantPremium: 10 UserResponse: title: Public data contract representing a user. type: object properties: ClientKey: title: Unique key identifying the client that owns the user. minLength: 1 type: string x-type-name: ClientKey Culture: title: Selected culture for this user. Five letter language culture name. Fx. en-GB type: string example: stringValue Language: title: Selected language for this user. The two letter ISO 639-1 language code. See Reference Data Languages endpoint for supported languages. type: string example: stringValue LastLoginStatus: title: Status of last login or login attempt allOf: - $ref: '#/components/schemas/LoginStatus' LastLoginTime: title: Time of last login or login attempt type: string format: date-time x-type-name: UtcDateTime LegalAssetTypes: title: Asset Types that can be traded on all accounts by this user. type: array items: $ref: '#/components/schemas/AssetType' example: - FxVanillaOption MarketDataViaOpenApiTermsAccepted: title: True if the user has accepted terms for market data via OpenApi access. type: boolean example: true Name: title: The name of the user. type: string example: stringValue TimeZoneId: title: Selected Time Zone for this user. See Reference Data TimeZones endpoint for supported time zones. type: integer format: int32 example: 99 UserId: title: Unique ID of the user. type: string example: stringValue UserKey: title: The unique key for the user. minLength: 1 type: string x-type-name: UserKey additionalProperties: false example: ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== Culture: en-GB Language: en LastLoginStatus: Successful LastLoginTime: '2022-10-28T03:49:04.2658850+00:00' LegalAssetTypes: - FxSpot - Stock - ContractFutures MarketDataViaOpenApiTermsAccepted: false Name: Mr. Anthony Test TimeZoneId: 28 UserId: '654321' UserKey: V-B8jOk9SM8QdqN1u2Bjtw== UserResponseListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/UserResponse' description: The collection of entities for this feed. MaxRows: type: number description: The maximum number of rows that can be returned (if applicable). __count: type: number description: The total count of items in the feed. __next: type: string description: The link for the next page of items in the feed. additionalProperties: false example: Data: - ClientKey: V-B8jOk9SM8QdqN1u2Bjtw== Culture: en-GB Language: en LastLoginStatus: Successful LastLoginTime: '2022-10-28T03:49:04.265885Z' LegalAssetTypes: - FxSpot - Stock - ContractFutures MarketDataViaOpenApiTermsAccepted: false Name: Mr. Anthony Test TimeZoneId: 28 UserId: '654321' UserKey: V-B8jOk9SM8QdqN1u2Bjtw== MaxRows: 99 UserUpdateRequest: title: Public contract representing setting a user may change. type: object properties: Culture: title: Selected culture for this user. Five letter language culture name. Fx. en-GB type: string example: stringValue Language: title: Selected language for this user. The two letter ISO 639-1 language code. See Reference Data Languages endpoint for supported languages. type: string example: stringValue TimeZoneId: title: Selected Time Zone for this user. See Reference Data TimeZones endpoint for supported time zones. type: integer format: int32 example: 99 additionalProperties: false ValueDateExposureEntry: title: Currency exposures for a value date required: - ValueDateKey type: object properties: Exposures: title: The currency exposure breakdown for the value date allOf: - $ref: '#/components/schemas/CurrencyExposureEntry' ValueDate: title: The value date type: string format: date-time x-type-name: UtcDateTime ValueDateKey: title: Unique list entry key. type: string example: stringValue additionalProperties: false example: Exposures: Cash: 10 Fx: 10 ProfitLoss: 10 Total: 10 ValueDate: '9999-12-31T23:59:59.9999990+00:00' ValueDateKey: stringValue responses: BadRequest: description: One or more of the provided parameters are invalid. content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string example: None x-enum-descriptions: InvalidRequest: Default error code returned when it cannot be determined which part of the request is malformed. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' ServiceUnavailable: description: Service Unavailable. TooManyRequests: description: The request was rejected due to rate limit being exceeded. Unauthorized: description: Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token. securitySchemes: OpenApiJWTSecurityScheme: type: http scheme: bearer bearerFormat: JWT OpenApiOAuthSecurityScheme: type: oauth2 flows: authorizationCode: authorizationUrl: https://sim.logonvalidation.net/authorize tokenUrl: https://sim.logonvalidation.net/token scopes: { } tags: - name: AccountGroups description: "End points serving account groups.\n The set of account groups is restricted by the supplied query parameters as well as whether or not the identity represented by the authorization token has access to the groups." - name: Accounts description: "End points serving accounts.\n The set of accounts is restricted by the supplied query parameters as well as whether or not the identity represented by the authorization token has access to the account." - name: Balances description: "Read-only endpoint serving client and account balances. The client or account balance is identified by the supplied ClientKey, AccountGroupKey or AccountKey. \n Access to balance data is further restricted by the access rights of the identity represented by the authorization token." - name: Clients description: "End points serving client related resources\n The set of clients is restricted by the supplied query parameters as well as whether or not the identity \n represented by the authorization token has access to the client." - name: ClosedPositions description: "Read only end points serving closed positions and the underlying closed positions making up the net closed position.\n The set of closed positions is restricted by the supplied query parameters as well as whether or not the identity \n represented by the authorization token has access to the account on which the positions are posted.\n\n* A user of a client will have access to accounts under that client\n* A user of an IB or WLC will have access to accounts on that client or clients there under \n* An employee has access to all accounts\n* A request containing a TradingFloor \"Federated Access\" token will have access to the account specified in that token.\n* If access is granted on the basis of the TradingFloor \"Federated Access\" token, then the number of fields will be a subset \n of the full set of fields shown in the specification for the response." - name: Exposure description: "Read only end points serving exposure of positions.\n The exposure results are restricted by the supplied query parameters as well as whether or not the identity \n represented by the authorization token has access to the client/account owner of the underlying positions.\n\n* A user of a client will have access to accounts under that client\n* A user of an IB or WLC will have access to accounts on that client or clients there under \n* An employee has access to all accounts" - name: ExtendedAccounts description: "Extended Account provides abstraction on top of accounts and account risk-profiles to make them\n appear as one Account. It gives semblance of Bink style Secutity Account where it is possible to book trades \n and have number of assoociated Accounts with Cash on in different Currencies" - name: NetPositions description: "Read only end points serving net positions and the positions making up the net position.\n The set of net positions is restricted by the supplied query parameters as well as whether or not the identity \n represented by the authorization token has access to the account on which the positions are posted.\n\n* A user of a client will have access to accounts under that client\n* A user of an IB or WLC will have access to accounts on that client or clients there under \n* An employee has access to all accounts\n* A request containing a TradingFloor \"Federated Access\" token will have access to the account specified in that token.\n* If access is granted on the basis of the TradingFloor \"Federated Access\" token, then the number of fields will be a subset \n of the full set of fields shown in the specification for the response." - name: Orders description: Read only end points serving orders. - name: Positions description: "Read only end points serving individual positions.\n The set of positions is restricted by the supplied query parameters as well as whether or not the identity \n represented by the authorization token has access to the account on which the positions are posted. \n\n* A user of a client will have access to accounts under that client\n* A user of an IB or WLC will have access to accounts on that client or clients there under \n* An employee has access to all accounts\n* A request containing a TradingFloor \"Federated Access\" token will have access to the account specified in that token.\n* If access is granted on the basis of the TradingFloor \"Federated Access\" token, then the number of fields will be a subset \n of the full set of fields shown in the specification for the response." - name: Users description: End points serving user resources.