openapi: 3.0.1 info: title: Services.AutoTrading description: 'The AutoTrading service group provides endpoints for interacting with Saxo Bank''s SaxoSelect offering.Through these interfaces a client application can get Saxo Select trade leaders, portfolios and investments. Portfolio investments can be created and modifed.

Note:
This service is subject to special licensing agreements and not generally available to all OpenAPI applications.

' version: 2.4.138+710c760591 x-framework-version: 38.0.2+439c5b0ec3 x-machine: SIMOAWEB11-DK2 servers: - url: https://gateway.saxobank.com/sim/openapi paths: '/at/v3/investments/subscriptions/suggestions/{ContextId}/{ReferenceId}': delete: tags: - Investments summary: Remove session wide suggestion subscription description: Removes the suggestion subscription identified by the specified reference id (and streaming context id). operationId: InvestmentsV3DeleteSuggestionSubscription 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: explorer_201704091208182471 - name: ReferenceId in: path description: The reference id that identifies the subscription (within a streaming session). required: true schema: type: string example: '123' responses: '204': description: No Content '202': description: Accepted '404': description: Not Found content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionNotFound type: string x-enum-descriptions: SubscriptionNotFound: Subscription not found. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '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 '/at/v3/investments/subscriptions/{ContextId}/{ReferenceId}': delete: tags: - Investments summary: Remove session wide subscription description: Removes the subscription identified by the specified reference id (and streaming context id). operationId: InvestmentsV3DeleteSubscription 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: explorer_201704091208182471 - name: ReferenceId in: path description: The reference id that identifies the subscription (within a streaming session). required: true schema: type: string example: '123' responses: '204': description: No Content '202': description: Accepted '404': description: Not Found content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - SubscriptionNotFound type: string x-enum-descriptions: SubscriptionNotFound: Subscription not found. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '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 /at/v3/investments/subscriptions/suggestions: post: tags: - Investments summary: Create a session wide suggestion subscription description: "Sets up a new session wide suggestion subscription. The data stream will deliver updates from this point.\r\n Provides updates on all investments that one could possibly participate in." operationId: InvestmentsV3AddSuggestionSubscriptionAsync requestBody: content: application/json: schema: $ref: '#/components/schemas/InvestmentsSubscriptionRequest' example: ContextId: explorer_201704091208182471 ReferenceId: '123' RefreshRate: 1000 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/InvestmentSuggestionContractInvestmentsSubscriptionResponse' example: ContextId: ContextId8d2541cd-f136-45d9-8492-f6fbcca724f3 Format: Format87697a73-44b2-4885-89f7-8cd4d61d88b5 InactivityTimeout: 224 ReferenceId: ReferenceIdf5fda778-c237-4b00-9fda-7f869b359119 RefreshRate: 78 Snapshot: - AutoTradingPartnerLeaderId: AutoTradingPartnerLeaderIda1f21a29-744a-4123-9c4c-da292f76c3c6 ClientId: 1227010735 Currency: Currency0c7a3ebd-626a-41e6-82f0-729c3f873434 IsAuthorizedToFollow: true IsFollowAllowed: false IsFollowing: false IsOpenForFollowers: true IsReadyForTrading: true IsTradeFollowerReady: false MinimumFunding: 0.95958769738655 StrategyName: StrategyName53af1bcf-46aa-4ce8-abd1-61accf9ef5bb TradeLeaderId: TradeLeaderId54972f08-a548-445c-90b5-451868eb3326 State: Active Tag: Tag0598245e-a908-4305-b672-81e2c21d67c5 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidModelState - NotConfiguredForService - RefreshRateMustBePositive - UnsupportedSubscriptionFormat type: string 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. NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. RefreshRateMustBePositive: Refresh rate must be positive. 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 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/InvestmentSuggestionContractIEnumerable' /at/v3/investments/subscriptions: post: tags: - Investments summary: Create a session wide subscription description: "Sets up a new session wide subscription. The data stream will deliver updates from this point.\r\n Provides updates on the investments that one actively participating in." operationId: InvestmentsV3AddSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/InvestmentsSubscriptionRequest' example: ContextId: explorer_201704091208182471 ReferenceId: '123' RefreshRate: 1000 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/InvestmentContractInvestmentsSubscriptionResponse' example: InactivityTimeout: 120 RefreshRate: 1000 Snapshot: - AccountId: ALUSD*2147279411 AccountKey: y3OYuYog1dSJ2gLXrBLYejddPfnZpPFsfci84-E4|X0= AutoTradingPartnerLeaderId: '11' ClientId: 2147279411 Currency: USD DisplayName: Investment Account 1 DisplayState: 7 EntryGateResult: NA ErrorNumber: 0 InitialFunding: 63291 InvestmentId: '3353' InvestmentProcessState: Stopping InvestmentShieldAmount: 0 InvestmentStateId: 32 IsAuthorizedToFollow: true IsFollowAllowed: true IsFollowing: false IsOpenForFollowers: false IsReadyForTrading: false IsTradeFollowerReady: true IsWithdrawalInProgress: false MinimumFunding: 20000 PendingFunding: 63291 ReservedAmount: 0 StateName: Ready StrategyName: Discretionary Trading TradeLeaderId: '1' - AccountId: BRCHA*2147279411 AccountKey: PCXvSNri4gfq0HWg6D18Yp|EQN3qRivawC3ak9LvubA= AutoTradingPartnerLeaderId: '110' ClientId: 2147279411 Currency: CHF DisplayName: Investment Account 2 DisplayState: 3 EntryGateResult: NA ErrorNumber: 0 InitialFunding: 0 InvestmentId: '3356' InvestmentProcessState: Retry InvestmentShieldAmount: 0 InvestmentStateId: 7 IsAuthorizedToFollow: true IsFollowAllowed: true IsFollowing: true IsOpenForFollowers: true IsReadyForTrading: false IsTradeFollowerReady: true IsWithdrawalInProgress: false MinimumFunding: 10000 PendingFunding: 10000 ReservedAmount: 0 StateName: Stopping StrategyName: Aggressive Portfolio (CHF) TradeLeaderId: '93' State: Active '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidModelState - NotConfiguredForService - RefreshRateMustBePositive - UnsupportedSubscriptionFormat type: string 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. NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. RefreshRateMustBePositive: Refresh rate must be positive. 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 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/InvestmentContractIEnumerable' /at/v3/investments/summaries: get: tags: - Investments description: "Gets the investment information for all clients under the given client combined with the investments of client itself and this information\r\n is grouped according to the leaders." operationId: InvestmentsV3GetInvestmentsummariesAsync responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TradeLeaderSummaryListResult' example: Data: - CategoryName: Balanced Portfolios Currency: GBP Investments: - AccountId: SAMGS*585220 ClientId: 2147279411 InitialFunding: 1000000 InvestmentStartDateTime: '2022-09-29T04:28:00.7609276Z' IsActive: true PendingFunding: 0 StateName: Ready SuitabilityLevel: VeryHigh TimeWhenStateModified: '2022-10-28T04:28:00.7609276Z' MinimumFundingAmount: 10000 MostRecentStart: AccountId: SAMGS*585220 ClientId: 2147279411 TimeWhenStateModified: '2022-10-28T04:28:00.7609276Z' NumberOfFollowers: 1 Products: CFDs ReturnPercentage: 0.95 StateOfLeader: Ready StrategyName: Moderate Portfolio (GBP) SuitabilityLevel: High TradeLeaderId: '77' TradeLeaderOptions: UsExchanges '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - NotConfiguredForService type: string x-enum-descriptions: NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '404': description: Not Found content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvestmentSummaryNotFound type: string x-enum-descriptions: InvestmentSummaryNotFound: Investment not found under given WLC 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 '/at/v3/investments/{InvestmentId}/maxWithdrawalAmount': get: tags: - Investments description: Get max amount currently available for withdrawal from an investment. operationId: InvestmentsV3GetMaxWithdrawalAmountAsync parameters: - name: InvestmentId in: path description: Id of the investment portfolio. required: true schema: type: string example: '1505' - name: TargetAccountId in: query description: max withdrawal amount returned to this account id required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WithdrawalAmountContract' example: MaxWithdrawalAmount: 10000 '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidInvestmentId - NotConfiguredForService - WithdrawalNotAllowed type: string x-enum-descriptions: NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidInvestmentId: Invalid investment Id. WithdrawalNotAllowed: Withdrawal not allowed Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '404': description: Not Found content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvestmentNotFound type: string x-enum-descriptions: InvestmentNotFound: Investment not found. 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 '/at/v3/investments/{InvestmentId}/withdraw': put: tags: - Investments description: Initiate partial or full amount withdrawal from an investment. operationId: InvestmentsV3PutInvestmentAsync parameters: - name: InvestmentId in: path description: Id of the investment portfolio to update required: true schema: type: integer format: int32 example: 1505 requestBody: content: application/json: schema: $ref: '#/components/schemas/InvestmentWithdraw' example: Amount: 10000 TargetAccountKey: nUAg42i1-LI7kgWmWfSoaw== responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidAmount - InvalidInvestmentId - InvalidTargetAccountKey - NotConfiguredForService - WithdrawalNotAllowed type: string x-enum-descriptions: InvalidInvestmentId: Invalid investment Id. NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidAmount: Amount is not valid InvalidTargetAccountKey: Target Account key is not valid WithdrawalNotAllowed: Withdrawal not allowed Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '404': description: Not Found content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - AccountNotFound - InvestmentNotFound type: string x-enum-descriptions: InvestmentNotFound: Investment not found. AccountNotFound: 'Account not found ' 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 '/at/v3/investments/{InvestmentId}': patch: tags: - Investments description: Update an investment. operationId: InvestmentsV3PatchInvestmentAsync parameters: - name: InvestmentId in: path description: Id of the investment to update required: true schema: type: string example: '1505' requestBody: content: application/json: schema: $ref: '#/components/schemas/InvestmentEdit' example: DisplayName: Investment Account FundingAccountKey: nUAg42i1-LI7kgWmWfSoaw== InvestmentShieldAmount: 80000 IsActive: true PendingFunding: 0 PositionsCloseOnDeactivation: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidEditParameters - InvalidFundingAccountKey - InvalidInvestmentId - InvestmentUpdateNotAllowed - NotConfiguredForService - SuitabilityExpired type: string x-enum-descriptions: NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidInvestmentId: Invalid investment Id. InvalidEditParameters: One or more edit parameters are invalid. InvestmentUpdateNotAllowed: Investment update not allowed InvalidFundingAccountKey: Funding Account key is not valid. SuitabilityExpired: Suitability has expired 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 /at/v3/investments: get: tags: - Investments description: Retrieve potential investment details for a specific leader. operationId: InvestmentsV3GetInvestmentByLeader parameters: - name: TradeLeaderId in: query description: Id of leader to retrieve data for required: true schema: type: string example: '8' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InvestmentContract' example: AccountId: SAMGS*585220 AccountKey: LLnUM8rL-9CVIKwZTZG96g== ClientId: 2147279411 Currency: EUR DisplayName: Investment Account DisplayState: 6 EntryGateResult: NA ErrorNumber: 0 InitialFunding: 1000000 InvestmentId: '1505' InvestmentProcessState: Starting InvestmentShieldAmount: 700000 InvestmentStateId: 31 IsAuthorizedToFollow: true IsFollowAllowed: true IsFollowing: true IsOpenForFollowers: false IsReadyForTrading: true IsTradeFollowerReady: true IsWithdrawalInProgress: false MinimumFunding: 20000 PendingFunding: 0 ReservedAmount: 0 StrategyName: Global StockPicker TradeLeaderId: '8' '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidTradeLeaderId - NotConfiguredForService type: string x-enum-descriptions: NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidTradeLeaderId: Invalid trade leader Id. Message: type: string ModelState: $ref: '#/components/schemas/ModelStateDictionary' '404': description: Not Found content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvestmentNotFound type: string x-enum-descriptions: InvestmentNotFound: Investment not found. 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 post: tags: - Investments description: Start an investment. operationId: InvestmentsV3PostInvestment requestBody: content: application/json: schema: $ref: '#/components/schemas/InvestmentCreate' example: DisplayName: Investment Account FundingAccountKey: nUAg42i1-LI7kgWmWfSoaw== InitialFunding: 0 InvestmentShieldAmount: 700000 IsDisclaimerAccepted: true TradeLeaderId: '8' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/InvestmentCreateResponse' example: AccountId: AccountId8f46f535-21d1-4155-a53c-33a47277891c AccountKey: AccountKeyf94d4c93-2e22-49e1-8abb-27329b124ed7 AutoTradingPartnerLeaderId: AutoTradingPartnerLeaderId437b8a5b-5cf8-4e15-b4d9-3da0c4a845b4 ClientId: 1347546923 Currency: Currency0b671c12-7803-4407-89be-a75f6d49b5c4 DisplayName: DisplayName6b7bb7fe-f67c-4869-9e4e-cd308d352911 DisplayState: 27 EntryGateResult: Passed ErrorCode: JointInactive ErrorNumber: 158 InitialFunding: 0.709488569623552 InvestmentId: InvestmentId07cbba71-a915-4e82-84e8-d68d9ef290ad InvestmentShieldAmount: 0.766601990334039 InvestmentStateId: 80 IsAuthorizedToFollow: true IsFollowAllowed: false IsFollowing: false IsOpenForFollowers: true IsReadyForTrading: true IsTradeFollowerReady: false IsWithdrawalInProgress: true MinimumFunding: 0.302201525914577 PendingFunding: 0.46164979807178 ReservedAmount: 0.876714622544458 ReturnPercentage: 0.715073600744397 StateName: StateName73f11d49-acf6-4449-80c5-e1ac47b2614e StrategyName: StrategyName6a5eef43-e4c6-414a-be77-b1f318df1ce0 TradeLeaderId: TradeLeaderIde5f498f6-3e5f-4333-a858-9f558a66fd4b '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidFundingAccountKey - InvalidTradeLeaderId - InvestmentRestrictionsNotPassed - NotConfiguredForService type: string x-enum-descriptions: NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidTradeLeaderId: Invalid trade leader Id. InvalidFundingAccountKey: Funding Account key is not valid. InvestmentRestrictionsNotPassed: Investment restrictions not 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 /at/v3/investments/me: get: tags: - Investments description: Retrieve all investments for the client. operationId: InvestmentsV3GetInvestments parameters: - name: TradeLeaderId in: query description: Id of trade leader schema: type: string example: '8' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InvestmentContractListResult' example: Data: - AccountId: SAMGS*585220 AccountKey: LLnUM8rL-9CVIKwZTZG96g== ClientId: 2147279411 Currency: EUR DisplayName: Investment Account DisplayState: 6 EntryGateResult: NA ErrorNumber: 0 InitialFunding: 1000000 InvestmentId: '1505' InvestmentProcessState: Starting InvestmentShieldAmount: 700000 InvestmentStateId: 31 IsAuthorizedToFollow: true IsFollowAllowed: true IsFollowing: true IsOpenForFollowers: false IsReadyForTrading: true IsTradeFollowerReady: true IsWithdrawalInProgress: false MinimumFunding: 20000 PendingFunding: 0 ReservedAmount: 0 StrategyName: Global StockPicker TradeLeaderId: '8' '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidTradeLeaderId - NotConfiguredForService type: string x-enum-descriptions: NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidTradeLeaderId: Invalid trade leader Id. 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 '/at/v3/tradeLeaders/public/customselection/{SelectionId}': get: tags: - Trade Leaders description: Retrieve all Trade Leaders mapped to custom portfolioID (public) operationId: TradeLeadersV3GetTradeLeadersCustomSelectionPublic parameters: - name: SelectionId in: path description: Id of custom portfolio selection required: true schema: 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: 5C736EB0-D605-4D92-8DA9-67D37F1A4473 - name: StandardPeriod in: query description: Period to fetch account performance data schema: $ref: '#/components/schemas/Public.StandardPeriodType' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TradeLeaderContract' example: AccountPerformance: AccountSummary: AverageTradeDurationInMinutes: 34260 AverageTradesPerWeek: 48.2325728770595 NumberOfDaysTraded: 1589 NumberOfLongTrades: 5434 NumberOfShortTrades: 5263 TopTradedInstruments: - DAX.I - DJI.I - EURUSD - GBPUSD - NAS100.I - NOKSEK - EURNOK - SP500.I TotalReturnFraction: -0.9999963956455 TradedInstruments: - FxSpot - Stock - FxVanillaOption - ContractFutures TradesTotalCount: 10697 TradesWonCount: 6499 WinFraction: 0.61 Allocation: TradesPerAssetType: ClosedTradesAllocations: - AssetClassType: Equity CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 1 TradeCount: 168 TradePct: 38.009049773755656 TradePercent: 0.38009049773755654 - AssetClassType: Currency CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 0.249937016456527 TradeCount: 112 TradePct: 25.339366515837103 TradePercent: 0.25339366515837103 - AssetClassType: Commodity CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 0.5628789450009563 TradeCount: 105 TradePct: 23.755656108597282 TradePercent: 0.23755656108597284 - AssetClassType: Fixed Income CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: -0.013150856136249162 TradeCount: 57 TradePct: 12.895927601809955 TradePercent: 0.12895927601809956 TradesPerInstrument: ClosedTradesAllocations: - AssetType: ContractFutures CalculationBasis: 0 CalculationDataType: 0 InstrumentDescription: 30-Year U.S. Treasury Bond - Sep 2016 InstrumentSymbol: ZBU6 InstrumentUic: 3626018 PortfolioAllocationType: 0 ReturnAttribution: -0.15987101005684304 TradeCount: 40 TradePct: 9.049773755656108 TradePercent: 0.09049773755656108 - AssetType: FxSpot CalculationBasis: 0 CalculationDataType: 0 InstrumentDescription: British Pound/US Dollar InstrumentSymbol: GBPUSD InstrumentUic: 31 PortfolioAllocationType: 0 ReturnAttribution: 0.14685155225185834 TradeCount: 37 TradePct: 8.3710407239819 TradePercent: 0.083710407239819 BalancePerformance: AccountBalanceTimeSeries: - Date: '2016-03-28' Value: 0 - Date: '2016-03-29' Value: 0 AccountValueTimeSeries: - Date: '2016-03-28' Value: 0 - Date: '2016-03-29' Value: 0 MonthlyProfitLossTimeSeries: - Date: '2015-11-30' Value: 0 - Date: '2015-12-31' Value: 0 SecurityTransferTimeSeries: - Date: '2016-03-28' Value: 0 - Date: '2016-03-29' Value: 0 YearlyProfitLossTimeSeries: - Date: '2015-12-31' Value: 0 - Date: '2016-12-31' Value: 0 - Date: '2017-12-31' Value: 0 BenchMark: AssetType: CfdOnIndex Description: Japan 225 DisplayHintType: None Uic: 16351 BenchmarkPerformance: - Date: '2018-05-31' Value: 0 - Date: '2018-06-01' Value: 0.0014689581211755269 - Date: '2018-06-04' Value: 0.014297558645674684 - Date: '2018-06-05' Value: 0.015536710435009869 - Date: '2018-06-06' Value: 0.020349125384137055 - Date: '2018-06-07' Value: 0.030226291646765137 - Date: '2018-06-08' Value: 0.02173697538819246 - Date: '2018-06-11' Value: 0.029834269080684553 - Date: '2018-06-12' Value: 0.03227201860079486 - Date: '2018-06-13' Value: 0.034308733541811236 - Date: '2018-06-14' Value: 0.02529221452195777 - Date: '2018-06-15' Value: 0.030685904310445825 - Date: '2018-06-18' Value: 0.02224164811693988 - Date: '2018-06-19' Value: 0.0028207600731775455 - Date: '2018-06-20' Value: 0.014617485107648496 - Date: '2018-06-21' Value: 0.020673557852617538 - Date: '2018-06-22' Value: 0.01429305263916801 - Date: '2018-06-25' Value: 0.00672746771446338 - Date: '2018-06-26' Value: 0.007971125510305236 - Date: '2018-06-27' Value: 0.003203770626244784 - Date: '2018-06-28' Value: 0.0029739642944044413 - Date: '2018-06-29' Value: 0.0028297720861908925 - Date: '2018-07-02' Value: 0.002604471760857223 From: '2016-03-28' InceptionDay: '2015-11-24' LastTradeDay: '2017-03-27' Thru: '2017-03-27' TimeWeightedPerformance: AccumulatedTimeWeightedTimeSeries: - Date: '2016-03-25' Value: 0 MonthlyReturnTimeSeries: - Date: '2016-03-25' Value: 0 PerformanceFraction: -1 PerformanceKeyFigures: ClosedTradesCount: 0 DrawdownReport: Drawdowns: - DaysCount: 3 DepthInPercent: 1 FromDate: '2016-08-05' ThruDate: '2016-08-08' MaxDaysInDrawdownFromTop10Drawdowns: 3 LosingDaysFraction: 0.03 MaxDrawDownFraction: 1 ReturnFraction: -1 SampledStandardDeviation: 0.0618018874919214 SharpeRatio: -0.952069751000777 SortinoRatio: -0.0591710418985739 YearlyReturnTimeSeries: - Date: '2016-03-25' Value: 0 TotalCashBalance: 20226.02 TotalCashBalancePerCurrency: - StringValue: CAD Value: -491.707122366824 TotalOpenPositionsValue: 29571.057 TotalPositionsValuePerCurrency: - StringValue: CAD Value: -491.707122366824 TotalPositionsValuePerProductPerSecurity: - Description: Abengoa SA - Warrants ProductName: Shares Symbol: LOCK - 1496:xxxx Value: 0 AllowMultipleInvestment: true AllowPartialWithdrawal: true Category: Balanced Portfolios Currency: GBP FollowerAmountRemaining: 1000 IsInvestmentShieldSupported: true IsOpenForFollowers: false LeaderPartnerOptions: 'PositionsCloseOnDeactivation, FeesAreExclusiveOfVat' ManagementFee: 0.95 MinimumFundingAmount: 10000 PerformanceFee: 0 Prospectus: CSPXJ: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvii-ishares-core-msci-pacific-ex-japan-ucits-etf-usd-acc-gb-ie00b52mjy50-en.pdf E20Y: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiv-ishares-govt-bond-20yr-target-duration-ucits-etf-eur-dist-gb-ie00bskrjx20-en.pdf EMIM: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ish-ishares-core-msci-em-imi-ucits-etf-usd-acc-gb-ie00bkm4gz66-en.pdf EMBE: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-jp-morgan-em-bond-eur-hedged-ucits-etf-dist-gb-ie00b9m6rs56-en.pdf EIMI: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ish-ishares-core-msci-em-imi-ucits-etf-usd-acc-gb-ie00bkm4gz66-en.pdf EXXY: https://www.blackrock.com/kiid/literature/kiid/kiid-munich-all-ishares-diversified-commodity-swap-ucits-etf-de-gb-de000a0h0728-en.pdf IBCX: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ish-ishares-corp-bond-large-cap-ucits-etf-eur-dist-gb-ie0032523478-en.pdf IEGA: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiii-ishares-core-govt-bond-ucits-etf-eur-dist-gb-ie00b4wxjj64-en.pdf IEGE: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiii-ishares-govt-bond-0-1yr-ucits-etf-eur-dist-gb-ie00b3fh7618-en.pdf IMEU: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-msci-europe-ucits-etf-eur-dist-gb-ie00b1yzsc51-en.pdf INFR: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-global-infrastructure-ucits-etf-usd-dist-gb-ie00b1fzs467-en.pdf IRCP: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishv-ishares-corp-bond-interest-rate-hedged-ucits-etf-eur-dist-gb-ie00b6x2vy59-en.pdf IUSE: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishv-ishares-sp-500-eur-hedged-ucits-etf-acc-gb-ie00b3zw0k18-en.pdf IWDP: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-developed-markets-property-yield-ucits-etf-usd-dist-gb-ie00b1fzs350-en.pdf MVEU: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-edge-msci-europe-minimum-volatility-ucits-etf-eur-acc-gb-ie00b86mwn23-en.pdf SHYU: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-high-yield-corp-bond-ucits-etf-usd-dist-gb-ie00b4py7y77-en.pdf SJPA: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiii-ishares-core-msci-japan-imi-ucits-etf-usd-acc-gb-ie00b4l5yx21-en.pdf CHDVD: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-dividend-ch-ch-ch0237935637-en.pdf CHCORP: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-core-chf-corporate-bond-ch-ch-ch0226976816-en.pdf CHSPI: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-core-spi-ch-ch-ch0237935652-en.pdf CSBGC0: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-domestic-government-bond-7-15-ch-ch-ch0016999861-en.pdf CSBGC3: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-domestic-government-bond-1-3-ch-ch-ch0102530786-en.pdf CSBGC7: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-domestic-government-bond-3-7-ch-ch-ch0016999846-en.pdf CSGLDC: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ishii-ishares-gold-chf-hedged-ch-ch-ch0104136285-en.pdf CSSMIM: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-smim-ch-ch-ch0019852802-en.pdf EMBC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-jp-morgan-em-bond-chf-hedged-ucits-etf-dist-ch-ie00b9m04v95-en.pdf EMUC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvii-ishares-msci-emu-chf-hedged-ucits-etf-acc-ch-ie00bwk1sp74-en.pdf GHYC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-global-high-yield-corp-bond-chf-hedged-ucits-etf-dist-ch-ie00b988c465-en.pdf IEMB: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-jp-morgan-em-bond-ucits-etf-usd-dist-ch-ie00b2npkv68-en.pdf IJPC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-msci-japan-chf-hedged-ucits-etf-acc-ch-ie00b8j37j31-en.pdf IUSC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-sp-500-chf-hedged-ucits-etf-acc-ch-ie00b88dz566-en.pdf RiskLevel: Moderate StrategyLegalAssetTypes: - Stock - Bond - Cash StrategyName: Moderate Portfolio (GBP) SuitabilityLevel: Medium TradeLeaderId: '77' TradeLeaderOptions: FixedInvestmentAmount '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - BadRequestError type: string x-enum-descriptions: BadRequestError: Bad request. 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 '/at/v3/tradeLeaders/public/{TradeLeaderId}': get: tags: - Trade Leaders description: Retrieve single trade leader (public). operationId: TradeLeadersV3GetTradeLeaderPublic parameters: - name: OwnerKey in: query description: Id of the owner Key of owner to that leaders are available to. schema: title: Id of the owner Key of owner to that leaders are available to. minLength: 1 type: string x-type-name: ClientKey example: 966bf8c8-7202-45c0-8b4f-0c4bf1a47c4d - name: StandardPeriod in: query description: Period to fetch account performance data. schema: title: Period to fetch account performance data. allOf: - $ref: '#/components/schemas/Public.StandardPeriodType' example: Quarter - name: TradeLeaderId in: path description: Id of the trade leader. required: true schema: title: Id of the trade leader. type: integer format: int32 example: 91 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TradeLeaderContract' example: AccountPerformance: AccountSummary: AverageTradeDurationInMinutes: 34260 AverageTradesPerWeek: 48.2325728770595 NumberOfDaysTraded: 1589 NumberOfLongTrades: 5434 NumberOfShortTrades: 5263 TopTradedInstruments: - DAX.I - DJI.I - EURUSD - GBPUSD - NAS100.I - NOKSEK - EURNOK - SP500.I TotalReturnFraction: -0.9999963956455 TradedInstruments: - FxSpot - Stock - FxVanillaOption - ContractFutures TradesTotalCount: 10697 TradesWonCount: 6499 WinFraction: 0.61 Allocation: TradesPerAssetType: ClosedTradesAllocations: - AssetClassType: Equity CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 1 TradeCount: 168 TradePct: 38.009049773755656 TradePercent: 0.38009049773755654 - AssetClassType: Currency CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 0.249937016456527 TradeCount: 112 TradePct: 25.339366515837103 TradePercent: 0.25339366515837103 - AssetClassType: Commodity CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 0.5628789450009563 TradeCount: 105 TradePct: 23.755656108597282 TradePercent: 0.23755656108597284 - AssetClassType: Fixed Income CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: -0.013150856136249162 TradeCount: 57 TradePct: 12.895927601809955 TradePercent: 0.12895927601809956 TradesPerInstrument: ClosedTradesAllocations: - AssetType: ContractFutures CalculationBasis: 0 CalculationDataType: 0 InstrumentDescription: 30-Year U.S. Treasury Bond - Sep 2016 InstrumentSymbol: ZBU6 InstrumentUic: 3626018 PortfolioAllocationType: 0 ReturnAttribution: -0.15987101005684304 TradeCount: 40 TradePct: 9.049773755656108 TradePercent: 0.09049773755656108 - AssetType: FxSpot CalculationBasis: 0 CalculationDataType: 0 InstrumentDescription: British Pound/US Dollar InstrumentSymbol: GBPUSD InstrumentUic: 31 PortfolioAllocationType: 0 ReturnAttribution: 0.14685155225185834 TradeCount: 37 TradePct: 8.3710407239819 TradePercent: 0.083710407239819 BalancePerformance: AccountBalanceTimeSeries: - Date: '2016-03-28' Value: 0 - Date: '2016-03-29' Value: 0 AccountValueTimeSeries: - Date: '2016-03-28' Value: 0 - Date: '2016-03-29' Value: 0 MonthlyProfitLossTimeSeries: - Date: '2015-11-30' Value: 0 - Date: '2015-12-31' Value: 0 SecurityTransferTimeSeries: - Date: '2016-03-28' Value: 0 - Date: '2016-03-29' Value: 0 YearlyProfitLossTimeSeries: - Date: '2015-12-31' Value: 0 - Date: '2016-12-31' Value: 0 - Date: '2017-12-31' Value: 0 BenchMark: AssetType: CfdOnIndex Description: Japan 225 DisplayHintType: None Uic: 16351 BenchmarkPerformance: - Date: '2018-05-31' Value: 0 - Date: '2018-06-01' Value: 0.0014689581211755269 - Date: '2018-06-04' Value: 0.014297558645674684 - Date: '2018-06-05' Value: 0.015536710435009869 - Date: '2018-06-06' Value: 0.020349125384137055 - Date: '2018-06-07' Value: 0.030226291646765137 - Date: '2018-06-08' Value: 0.02173697538819246 - Date: '2018-06-11' Value: 0.029834269080684553 - Date: '2018-06-12' Value: 0.03227201860079486 - Date: '2018-06-13' Value: 0.034308733541811236 - Date: '2018-06-14' Value: 0.02529221452195777 - Date: '2018-06-15' Value: 0.030685904310445825 - Date: '2018-06-18' Value: 0.02224164811693988 - Date: '2018-06-19' Value: 0.0028207600731775455 - Date: '2018-06-20' Value: 0.014617485107648496 - Date: '2018-06-21' Value: 0.020673557852617538 - Date: '2018-06-22' Value: 0.01429305263916801 - Date: '2018-06-25' Value: 0.00672746771446338 - Date: '2018-06-26' Value: 0.007971125510305236 - Date: '2018-06-27' Value: 0.003203770626244784 - Date: '2018-06-28' Value: 0.0029739642944044413 - Date: '2018-06-29' Value: 0.0028297720861908925 - Date: '2018-07-02' Value: 0.002604471760857223 From: '2016-03-28' InceptionDay: '2015-11-24' LastTradeDay: '2017-03-27' Thru: '2017-03-27' TimeWeightedPerformance: AccumulatedTimeWeightedTimeSeries: - Date: '2016-03-25' Value: 0 MonthlyReturnTimeSeries: - Date: '2016-03-25' Value: 0 PerformanceFraction: -1 PerformanceKeyFigures: ClosedTradesCount: 0 DrawdownReport: Drawdowns: - DaysCount: 3 DepthInPercent: 1 FromDate: '2016-08-05' ThruDate: '2016-08-08' MaxDaysInDrawdownFromTop10Drawdowns: 3 LosingDaysFraction: 0.03 MaxDrawDownFraction: 1 ReturnFraction: -1 SampledStandardDeviation: 0.0618018874919214 SharpeRatio: -0.952069751000777 SortinoRatio: -0.0591710418985739 YearlyReturnTimeSeries: - Date: '2016-03-25' Value: 0 TotalCashBalance: 20226.02 TotalCashBalancePerCurrency: - StringValue: CAD Value: -491.707122366824 TotalOpenPositionsValue: 29571.057 TotalPositionsValuePerCurrency: - StringValue: CAD Value: -491.707122366824 TotalPositionsValuePerProductPerSecurity: - Description: Abengoa SA - Warrants ProductName: Shares Symbol: LOCK - 1496:xxxx Value: 0 AllowMultipleInvestment: true AllowPartialWithdrawal: true Category: Balanced Portfolios Currency: GBP FollowerAmountRemaining: 1000 IsInvestmentShieldSupported: true IsOpenForFollowers: false LeaderPartnerOptions: 'PositionsCloseOnDeactivation, FeesAreExclusiveOfVat' ManagementFee: 0.95 MinimumFundingAmount: 10000 PerformanceFee: 0 Prospectus: CSPXJ: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvii-ishares-core-msci-pacific-ex-japan-ucits-etf-usd-acc-gb-ie00b52mjy50-en.pdf E20Y: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiv-ishares-govt-bond-20yr-target-duration-ucits-etf-eur-dist-gb-ie00bskrjx20-en.pdf EMIM: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ish-ishares-core-msci-em-imi-ucits-etf-usd-acc-gb-ie00bkm4gz66-en.pdf EMBE: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-jp-morgan-em-bond-eur-hedged-ucits-etf-dist-gb-ie00b9m6rs56-en.pdf EIMI: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ish-ishares-core-msci-em-imi-ucits-etf-usd-acc-gb-ie00bkm4gz66-en.pdf EXXY: https://www.blackrock.com/kiid/literature/kiid/kiid-munich-all-ishares-diversified-commodity-swap-ucits-etf-de-gb-de000a0h0728-en.pdf IBCX: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ish-ishares-corp-bond-large-cap-ucits-etf-eur-dist-gb-ie0032523478-en.pdf IEGA: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiii-ishares-core-govt-bond-ucits-etf-eur-dist-gb-ie00b4wxjj64-en.pdf IEGE: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiii-ishares-govt-bond-0-1yr-ucits-etf-eur-dist-gb-ie00b3fh7618-en.pdf IMEU: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-msci-europe-ucits-etf-eur-dist-gb-ie00b1yzsc51-en.pdf INFR: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-global-infrastructure-ucits-etf-usd-dist-gb-ie00b1fzs467-en.pdf IRCP: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishv-ishares-corp-bond-interest-rate-hedged-ucits-etf-eur-dist-gb-ie00b6x2vy59-en.pdf IUSE: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishv-ishares-sp-500-eur-hedged-ucits-etf-acc-gb-ie00b3zw0k18-en.pdf IWDP: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-developed-markets-property-yield-ucits-etf-usd-dist-gb-ie00b1fzs350-en.pdf MVEU: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-edge-msci-europe-minimum-volatility-ucits-etf-eur-acc-gb-ie00b86mwn23-en.pdf SHYU: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-high-yield-corp-bond-ucits-etf-usd-dist-gb-ie00b4py7y77-en.pdf SJPA: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishiii-ishares-core-msci-japan-imi-ucits-etf-usd-acc-gb-ie00b4l5yx21-en.pdf CHDVD: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-dividend-ch-ch-ch0237935637-en.pdf CHCORP: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-core-chf-corporate-bond-ch-ch-ch0226976816-en.pdf CHSPI: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-core-spi-ch-ch-ch0237935652-en.pdf CSBGC0: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-domestic-government-bond-7-15-ch-ch-ch0016999861-en.pdf CSBGC3: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-domestic-government-bond-1-3-ch-ch-ch0102530786-en.pdf CSBGC7: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-swiss-domestic-government-bond-3-7-ch-ch-ch0016999846-en.pdf CSGLDC: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ishii-ishares-gold-chf-hedged-ch-ch-ch0104136285-en.pdf CSSMIM: https://www.blackrock.com/kiid/literature/kiid/kiid-ch-ish-ishares-smim-ch-ch-ch0019852802-en.pdf EMBC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-jp-morgan-em-bond-chf-hedged-ucits-etf-dist-ch-ie00b9m04v95-en.pdf EMUC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvii-ishares-msci-emu-chf-hedged-ucits-etf-acc-ch-ie00bwk1sp74-en.pdf GHYC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-global-high-yield-corp-bond-chf-hedged-ucits-etf-dist-ch-ie00b988c465-en.pdf IEMB: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishii-ishares-jp-morgan-em-bond-ucits-etf-usd-dist-ch-ie00b2npkv68-en.pdf IJPC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-msci-japan-chf-hedged-ucits-etf-acc-ch-ie00b8j37j31-en.pdf IUSC: https://www.blackrock.com/kiid/literature/kiid/kiid-ir-ishvi-ishares-sp-500-chf-hedged-ucits-etf-acc-ch-ie00b88dz566-en.pdf RiskLevel: Moderate StrategyLegalAssetTypes: - Stock - Bond - Cash StrategyName: Moderate Portfolio (GBP) SuitabilityLevel: Medium TradeLeaderId: '77' TradeLeaderOptions: FixedInvestmentAmount '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - BadRequestError type: string x-enum-descriptions: BadRequestError: Bad request. 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 /at/v3/tradeLeaders/public: get: tags: - Trade Leaders description: Retrieve all trade leaders (internal). operationId: TradeLeadersV3GetAllTradeLeadersPublic parameters: - name: OwnerKey in: query description: Id of the owner Key of owner to that leaders are available to. schema: title: Id of the owner Key of owner to that leaders are available to. minLength: 1 type: string x-type-name: ClientKey example: 966bf8c8-7202-45c0-8b4f-0c4bf1a47c4d - name: StandardPeriod in: query description: Period to fetch account performance data. schema: title: Period to fetch account performance data. allOf: - $ref: '#/components/schemas/Public.StandardPeriodType' example: Quarter responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TradeLeaderContractListResult' example: Data: - AccountPerformance: Allocation: TradesPerAssetType: ClosedTradesAllocations: - AssetClassType: Equity CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 1 TradeCount: 168 TradePct: 38.009049773755656 TradePercent: 0.38009049773755654 - AssetClassType: Currency CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 0.249937016456527 TradeCount: 112 TradePct: 25.339366515837103 TradePercent: 0.25339366515837103 - AssetClassType: Commodity CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: 0.5628789450009563 TradeCount: 105 TradePct: 23.755656108597282 TradePercent: 0.23755656108597284 - AssetClassType: Fixed Income CalculationBasis: 0 CalculationDataType: 0 PortfolioAllocationType: 0 ReturnAttribution: -0.013150856136249162 TradeCount: 57 TradePct: 12.895927601809955 TradePercent: 0.12895927601809956 TradesPerInstrument: ClosedTradesAllocations: - AssetType: ContractFutures CalculationBasis: 0 CalculationDataType: 0 InstrumentDescription: 30-Year U.S. Treasury Bond - Sep 2016 InstrumentSymbol: ZBU6 InstrumentUic: 3626018 PortfolioAllocationType: 0 ReturnAttribution: -0.15987101005684304 TradeCount: 40 TradePct: 9.049773755656108 TradePercent: 0.09049773755656108 - AssetType: FxSpot CalculationBasis: 0 CalculationDataType: 0 InstrumentDescription: British Pound/US Dollar InstrumentSymbol: GBPUSD InstrumentUic: 31 PortfolioAllocationType: 0 ReturnAttribution: 0.14685155225185834 TradeCount: 37 TradePct: 8.3710407239819 TradePercent: 0.083710407239819 From: '2016-03-28' InceptionDay: '2011-01-03' LastTradeDay: '2017-03-27' Thru: '2017-03-27' TimeWeightedPerformance: PerformanceFraction: -1 PerformanceKeyFigures: ClosedTradesCount: 442 MaxDrawDownFraction: 1 SampledStandardDeviation: 0.0631775477103272 TotalCashBalance: 0 TotalOpenPositionsValue: 0 TotalPositionsValuePerProductPerSecurity: [ ] AllowMultipleInvestment: true AllowPartialWithdrawal: true Category: Equity Portfolios Currency: USD Description: 'A fully discretionary investment theme exploiting short-term price movements across asset-classes.

Discretionary Trading exploits short-term price movements and is fully discretionary (i.e. trading is not automated), generating absolute returns without reference to a benchmark.' FollowerAmountRemaining: 999997938427.28 IsInvestmentShieldSupported: true IsOpenForFollowers: true LeaderPartnerOptions: PositionsCloseOnDeactivation LogoUrl: https://red.openapi.sys.dom/openapi/at/v3/tradeLeaders/1/logo ManagementFee: 1.43 MinimumFundingAmount: 20000 PerformanceFee: 0 RiskLevel: Alpha StrategyLegalAssetTypes: - FxSpot - ContractFutures - CfdOnStock - Cash - CfdOnFutures StrategyName: Discretionary Trading SuitabilityLevel: High TradeLeaderId: '1' TradeLeaderOptions: JointExecutionModel '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - BadRequestError - InvalidStandardPeriod - NotConfiguredForService type: string x-enum-descriptions: BadRequestError: Bad request. NotConfiguredForService: You are not configured for this service. Please Contact Service Center for support. InvalidStandardPeriod: Valid Standard Period is 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 /at/v3/tradeFollowers/termsandconditions: get: tags: - Trade Followers summary: Gets the auto trading terms and conditions acceptance status of a client. description: Get the status of whether a client has accepted terms and conditions. operationId: GET_TradeFollowerV3GetTermsAndConditions responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AutoTradingTermsAndConditionsResponse' example: AutoTradingTermsAndConditionsStatus: Accepted '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string x-enum-descriptions: InvalidRequest: The request is 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 put: tags: - Trade Followers summary: Updates the auto trading terms and conditions acceptance status of a client. description: Updates the status of a client for terms and conditions. operationId: TradeFollowerV3UpdateTermsAndConditions responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string x-enum-descriptions: InvalidRequest: The request is 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: Write '/at/v3/tradeFollowers/{ClientKey}/termsandconditions': get: tags: - Trade Followers summary: Get the terms and conditions acceptance status of a client. description: Get the status of whether a client has accepted terms and conditions. operationId: TradeFollowerV3GetTermsAndConditions parameters: - name: ClientKey in: path description: The client key uniquely identifying a client. required: true schema: minLength: 1 type: string x-type-name: ClientKey responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetClientTermsAndConditionsResponse' example: Accepted: false '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string x-enum-descriptions: InvalidRequest: The request is 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 put: tags: - Trade Followers summary: Sets the terms and conditions acceptance status of a client. description: Set the status of whether a client has accepted terms and conditions. operationId: TradeFollowerV3PutClientTermsAndConditions parameters: - name: ClientKey in: path description: The client key uniquely identifying a client. required: true schema: minLength: 1 type: string x-type-name: ClientKey requestBody: content: application/json: schema: $ref: '#/components/schemas/PutClientTermsAndConditionsRequest' example: Accepted: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string x-enum-descriptions: InvalidRequest: The request is 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: Write '/at/v3/tradeFollowers/{ClientKey}/suitabilitystatus': get: tags: - Trade Followers summary: Get the suitability status of a client. description: 'Gets the suitability status of a client, which determines what product areas are suitable for the client, as well as the overall suitability of the client.' operationId: TradeFollowerV3GetSuitabilityStatus parameters: - name: ClientKey in: path description: The client key uniquely identifying a client. required: true schema: minLength: 1 type: string x-type-name: ClientKey responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClientSuitabilityStatusResponse' example: CanGiveSuitabilityTest: true LastSuitabilityCheckDate: '2013-01-01T00:00:00' OverallSuitability: Medium ProductAreaSuitability: - FXSpot - FXForwards - FXOptions - Futures - ContractOptions - CFDs - Stocks - Bonds - MutualFunds - CfdCommodities '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string x-enum-descriptions: InvalidRequest: The request is 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 put: tags: - Trade Followers summary: Update the suitability status of a client. description: 'Sets the suitability status of a client, to define what product areas are suitable for the client, as well as the overall suitability of the client.' operationId: TradeFollowerV3PutSuitabilityStatus parameters: - name: ClientKey in: path description: The client key uniquely identifying a client. required: true schema: minLength: 1 type: string x-type-name: ClientKey requestBody: content: application/json: schema: $ref: '#/components/schemas/PutClientSuitabilityStatusRequest' example: OverallSuitability: Medium ProductAreaSuitability: - FXSpot - FXForwards - FXOptions - Futures - ContractOptions - CFDs - Stocks - Bonds - MutualFunds - CfdCommodities responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: required: - ErrorCode - Message type: object properties: ErrorCode: enum: - InvalidRequest type: string x-enum-descriptions: InvalidRequest: The request is 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: Write /at/v3/tradeFollowers/me: get: tags: - Trade Followers description: Retrieve follower suitability information. operationId: TradeFollowerV3GetTradeFollowers responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TradeFollowerContract' example: ClientLegalAssetTypes: - FxSpot - FxForwards - FxVanillaOption - ContractFutures - FuturesOption - Stock - StockOption - CfdOnStock - Bond - ManagedFund - ManagedFund - CfdOnIndex - Cash - CfdOnFutures - FxKnockInOption - FxKnockOutOption - FxBinaryOption - FxOneTouchOption - FxNoTouchOption - FxVanillaOption - StockIndexOption - FuturesStrategy ClientSuitableAssetTypes: - FxSpot - FxForwards - FxVanillaOption - ContractFutures - FuturesOption - Stock - StockOption - CfdOnStock - Bond - ManagedFund - ManagedFund - CfdOnIndex - CfdOnFutures - FxKnockInOption - FxKnockOutOption - FxBinaryOption - FxOneTouchOption - FxNoTouchOption - FxVanillaOption - StockIndexOption - FuturesStrategy HasAcceptedTermsAndConditions: false HasAccess: true IsDisabled: false IsReady: true IsUSExchangesRestricted: false SuitabilityLevel: High '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 components: schemas: AccountPerformance: title: Account performance data model. type: object properties: AccountSummary: title: "The account summary consists performance metrics which is based on closed positions\r\n for an account over the entire lifespan of the account." allOf: - $ref: '#/components/schemas/AccountSummary' Allocation: title: The trades allocation. allOf: - $ref: '#/components/schemas/Allocation' BalancePerformance: title: Balance AccountPerformance metrics. allOf: - $ref: '#/components/schemas/BalancePerformance' BenchMark: title: The bench mark. allOf: - $ref: '#/components/schemas/BenchMark' BenchmarkPerformance: title: The benchmark performance. type: array items: $ref: '#/components/schemas/TimeValuePair' BenchmarkReturn: title: The Benchmark Return for the given period type: number Currency: title: The currency in which the data is calculated on. type: string From: title: "The start date is the offset date for all performance metrics that is a part\r\n of the 'AccountPerformance'." type: string format: date x-type-name: Date InceptionDay: title: The date where the first account deposit have been registred. type: string format: date x-type-name: Date LastTradeDay: title: "Performance data that is returned is limited to the be data that lies between\r\n the first trade day and the last trade day for the account. The last trade day\r\n is the last day that one or more trades have been registred." type: string format: date x-type-name: Date Thru: title: "The end date is the ending date for all returned performance metrics that is\r\n a part of the 'AccountPerformance'. The 'ActualThruDate' date is included." type: string format: date x-type-name: Date TimeWeightedPerformance: title: Time weighted performance metrics. allOf: - $ref: '#/components/schemas/TimeWeightedPerformance' TotalCashBalance: title: The total cash balance type: number TotalCashBalancePerCurrency: title: The total cash balance grouped by currency. type: array items: $ref: '#/components/schemas/StringValuePair' TotalOpenPositionsValue: title: The total value of client's open positions type: number TotalPositionsValuePerCurrency: title: The total position value grouped by currency. type: array items: $ref: '#/components/schemas/StringValuePair' TotalPositionsValuePerProductPerSecurity: title: The total position value grouped by product. type: array items: $ref: '#/components/schemas/PositionOnSecurityAndProduct' TradeActivity: title: The trade activity. allOf: - $ref: '#/components/schemas/TradeActivity' additionalProperties: false AccountSummary: title: "OpenApi account summary performance metrics. The summary is the performance metrics\r\n that is related to closed positions over the entire lifespan of an account." type: object properties: AverageTradeDurationInMinutes: title: Average trade duration in minutes. type: number AverageTradesPerWeek: title: The average trades per week. type: number NumberOfDaysTraded: title: Number of days traded. type: number NumberOfLongTrades: title: The number of long trades. type: number NumberOfShortTrades: title: The number of short trades. type: number TopHoldings: title: A list of top holdings with this account type: array items: type: string TopTradedInstruments: title: "A list of the most traded instrument in an ordered list where the single most\r\n traded instruments is located at index 0." type: array items: type: string TotalReturnFraction: title: The total return fraction. type: number TradedInstruments: title: A list of instruments traded with this account. type: array items: $ref: '#/components/schemas/AssetType' TradesTotalCount: title: Total trades. type: number TradesWonCount: title: The total count of winning trades. type: number WinFraction: title: The fraction of trades with positive profit/loss. type: number additionalProperties: false Allocation: title: Provides an overview of how performance is allocated across asset types and instruments. type: object properties: TradesPerAssetType: title: The allocation of trades grouped by trade asset type. allOf: - $ref: '#/components/schemas/TradesPerAssetType' TradesPerETFCategoryType: title: 'The allocation trades grouped by ETF category type: Developed Equity, Emerging Equity etc.' allOf: - $ref: '#/components/schemas/TradesPerAssetType' TradesPerInstrument: title: The allocation trades grouped by instrument id. allOf: - $ref: '#/components/schemas/TradesPerInstrument' additionalProperties: false AllocationItem: title: Defindes a model for an allocation item. type: object properties: AssetClassType: title: The type of the asset class. type: string AssetType: title: The asset type. allOf: - $ref: '#/components/schemas/AssetType' CalculationBasis: title: Basis of calulation used to calculate percentage allOf: - $ref: '#/components/schemas/CalculationBasis' CalculationDataType: title: 'Type of data used for calculation : OpenPositions, ClosedPositions etc.' allOf: - $ref: '#/components/schemas/CalculationDataType' ETFCategoryType: title: ETC Category Type. allOf: - $ref: '#/components/schemas/ETFCategoryType' InstrumentDescription: title: The instrument description. type: string InstrumentSymbol: title: The instrument symbol. type: string InstrumentUic: title: The instrument UIC which is the unique instrument identifier. type: integer format: int32 PortfolioAllocationType: title: Defines the type on which Portfolio composition is based allOf: - $ref: '#/components/schemas/PortfolioAllocationType' ReturnAttribution: title: "The return attribution for a collection allocation items.\r\n Remarks:\r\n The return attribution is a number in the range [-1 ; 1]. The return attribution\r\n is a measure of return relative to the allocation item in the collection with\r\n the numerical largest value" type: number TradeCount: title: The count of trades for the instrument asset type. type: integer format: int32 TradePct: title: The percent of trades calculated as per type: number TradePercent: title: "The percent for trades calculated as per \r\n This property is obsolete. Please use" type: number TradeVolume: title: Aggregated volume of trades. type: number additionalProperties: false 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 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. AutoTradingTermsAndConditionsResponse: title: AutoTradingTermsAndConditionsResponse type: object properties: AutoTradingTermsAndConditionsStatus: title: Accepted terms and conditions status for the client. allOf: - $ref: '#/components/schemas/AutoTradingTermsAndConditionsStatus' additionalProperties: false AutoTradingTermsAndConditionsStatus: title: Enumeration AutoTradingTermsAndConditionsStatus. enum: - Accepted - NotAccepted - Unknown type: string x-enum-descriptions: Unknown: The status is unknown Accepted: Your request has been accepted NotAccepted: Your request has not been accepted BalancePerformance: title: OpenApi balance performance data contract. type: object properties: AccountBalanceTimeSeries: title: The account balance time series. type: array items: $ref: '#/components/schemas/TimeValuePair' AccountValueTimeSeries: title: The account value time series. type: array items: $ref: '#/components/schemas/TimeValuePair' AccumulatedProfitLoss: title: The accumulated Profit / Loss for the account over the period as a value. type: number CashTransferTimeSeries: title: The cash transfer time series. type: array items: $ref: '#/components/schemas/TimeValuePair' MonthlyProfitLossTimeSeries: title: The monthly profit / loss time series. type: array items: $ref: '#/components/schemas/TimeValuePair' SecurityTransferTimeSeries: title: The security transfer time series. type: array items: $ref: '#/components/schemas/TimeValuePair' YearlyProfitLossTimeSeries: title: The yearly profit / loss time series. type: array items: $ref: '#/components/schemas/TimeValuePair' additionalProperties: false BenchMark: title: Class BenchMark. type: object properties: AssetType: title: The type of the asset. allOf: - $ref: '#/components/schemas/AssetType' Description: title: Description of instrument. type: string DisplayHintType: title: Display hint type of instrument allOf: - $ref: '#/components/schemas/DisplayHintType' Uic: title: The uic. type: integer format: int32 additionalProperties: false CalculationBasis: title: Defines the basis for percentage calculation enum: - MarketValue - NumberOfTrades type: string x-enum-descriptions: NumberOfTrades: Number of Trades MarketValue: Market value CalculationDataType: title: Defines the type of data on which portfolio composition is calculated enum: - ClosedPositions - OpenPositions type: string x-enum-descriptions: OpenPositions: Open Positions Data Type ClosedPositions: Closed Positions Data Type ClientSuitabilityStatusResponse: title: Response type used suitability status. type: object properties: CanGiveSuitabilityTest: title: Field will reflect whether user is allowed to give suitability test or not. type: boolean EsgPriority: title: 'ESG Priority to select e.g. Low, Medium, High' allOf: - $ref: '#/components/schemas/EsgPriority' EsgType: title: 'ESG Type for investment e.g. Environmental,Science,Governance etc' allOf: - $ref: '#/components/schemas/EsgType' ForcedIgnoreESGPreference: title: A boolean to indicate ignore ESG score type: boolean LastSuitabilityCheckDate: title: Last Suitability Check Date And Time type: string OverallSuitability: title: The overall suitablity score for the client. allOf: - $ref: '#/components/schemas/SuitabilityLevel' ProductAreaSuitability: title: The list of product areas for which the client has passed suitability test. type: array items: $ref: '#/components/schemas/ProductArea' additionalProperties: false DisplayHintType: title: Display Hint Type. enum: - Continuous - CryptoCurrencies - Etc - Etf - Etn - Forex - Fund - Interests - None - PreciousMetal - Rights - StockIndices - Warrant type: string 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. Drawdown: title: Drawdown type: object properties: DaysCount: title: Days Count type: integer format: int32 DepthInPercent: title: Depth in Percnt type: number FromDate: title: From Date type: string format: date x-type-name: Date RecoveryDaysCount: title: Recovery Days Count type: integer format: int32 ThruDate: title: Thru Date type: string format: date x-type-name: Date additionalProperties: false DrawdownReport: title: Drawdown report type: object properties: CurrentDrawdownDepthInPercent: title: CurrentDrawdownDepthInPercent type: number Drawdowns: title: Drawdowns type: array items: $ref: '#/components/schemas/Drawdown' MaxDaysInDrawdownFromTop10Drawdowns: title: MaxDaysInDrawdownFromTop10Drawdowns type: integer format: int32 additionalProperties: false ETFCategoryType: title: ETF Category Type enum: - DevelopedEquity - EmergingEquity - FixedIncome - NonTraditional - Other type: string x-enum-descriptions: Other: Other FixedIncome: Fixed Income DevelopedEquity: Developed Equity EmergingEquity: Emerging Equity NonTraditional: Non-Traditional EntryGateResult: title: Defines the values of entry gate test result for a Saxo Select Strategy. enum: - Failed - NA - Passed type: string x-enum-descriptions: NA: Entry gate test not applicable Passed: Entry gate test is passed Failed: Entry gate test is failed. ErrorCode: title: Error Code enum: - JointInactive - NotSuitable type: string x-enum-descriptions: NotSuitable: Not Suitable JointInactive: Joint Inactive EsgPriority: enum: - High - Low - Medium type: string EsgType: title: ESG Type enum: - All - Any - Environmental - Governance - None - Social type: string x-enum-descriptions: None: no ESG Environmental: Only specific esg environmental Social: Only specific esg social Governance: Only specific esg governance Any: any esg type All: should be all FileResult: title: "Creates a IHttpActionResult from image file\r\n See http://stackoverflow.com/questions/23768596/why-is-my-file-not-being-returned-by-a-get-request-from-my-web-api-function/23768883#23768883" type: object additionalProperties: false GetClientTermsAndConditionsResponse: title: Response to getting the terms and conditions status of a client. type: object properties: Accepted: title: 'Accepted is true if the client has accepted terms and conditions, and false otherwise.' type: boolean additionalProperties: false InvestmentContract: title: "An Investment represents the relationship between leaders and followers.\r\n An investment can either be active, historic or a potential investment opportunity" required: - InvestmentId type: object properties: AccountId: title: Account Id of this type: string AccountKey: title: Account Key of this type: string AutoTradingPartnerLeaderId: title: Unique Identifier for Partner Leader Combination type: string ClientId: title: Gets the client id of the investment. minimum: 1 type: integer x-type-name: ClientId Currency: title: Account currency type: string DisplayName: title: User defined name of investment. If not specified then it defaults to type: string DisplayState: title: "SaxoInternal - States are bundled in DisplayStates for UI guidance.\r\n Only relevant for Saxo applications" type: integer format: int32 EntryGateResult: title: Entry Gate Test Result allOf: - $ref: '#/components/schemas/EntryGateResult' ErrorCode: title: Error Code allOf: - $ref: '#/components/schemas/ErrorCode' ErrorNumber: title: "Error number if this is in error state\r\n This property is obsolete, please use" type: integer format: int32 InitialFunding: title: The initial funding amount. type: number InvestmentId: title: Investment Item identifier type: string InvestmentProcessState: title: Investment process state allOf: - $ref: '#/components/schemas/InvestmentProcessState' InvestmentShieldAmount: title: Investment shield amount (drawdown protection level). type: number InvestmentStateId: title: State Id of this type: integer format: int32 IsAuthorizedToFollow: title: Reflects legal aspects of client (suitability and terms/conditions) type: boolean IsAutoFundsTransfer: title: Information about whether the funds would be auto transferred in case of investment stop. type: boolean IsFollowAllowed: title: "Indicates whether user is allowed to follow current leaders instrument types and instruments.\r\n Also evaluates if follower passes any applied country filter or client group restrictions on leader.\r\n And verifies leader is enabled for any of followers owner(s)." type: boolean IsFollowing: title: Indicates if this is actively following. type: boolean IsOpenForFollowers: title: Indicates if additional followers can join. type: boolean description: Expresses if follower amount has exceeded limit. IsReadyForTrading: title: Indictes if this is ready for trading. type: boolean IsTradeFollowerReady: title: 'Indicates Trade Follower created, active and passed suitability test' type: boolean IsWithdrawalInProgress: title: Indicates if cash wtihdrawal is in progress. type: boolean LeaderLogoUrl: title: Logo Url of the respective trade leader type: string MinimumFunding: title: The minimum funding amount. type: number PendingFunding: title: Any pending funding. type: number PositionsCloseOnDeactivation: title: Information about whether to close or keep related positions open on the investment deactivation (not available to all) type: boolean ReservedAmount: title: Any amount marked as reserved for withdrawl type: number ReturnPercentage: title: Account Performance return fraction type: number StateName: title: Description of the state this is in type: string StrategyName: title: Name of the strategy. type: string TradeLeaderId: title: identifier. type: string additionalProperties: false InvestmentContractIEnumerable: type: array items: $ref: '#/components/schemas/InvestmentContract' InvestmentContractInvestmentsSubscriptionResponse: type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string 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 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' type: array items: $ref: '#/components/schemas/InvestmentContract' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string additionalProperties: false InvestmentContractListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/InvestmentContract' 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 InvestmentCreate: title: Reperesents Investment's start parameters. required: - InitialFunding - InvestmentShieldAmount - FundingAccountKey - TradeLeaderId - IsDisclaimerAccepted type: object properties: DisplayName: title: The displayName for the investment type: string FundingAccountKey: title: The account from where to withdraw the initial funding amount. minLength: 1 type: string x-type-name: AccountKey InitialFunding: title: The initial funding amount. type: number InvestmentShieldAmount: title: Investment shield amount (drawdown protection level). type: number IsDisclaimerAccepted: title: A value indicating whether user has accepted disclaimer before following a trade leader or not. type: boolean TradeLeaderId: title: The id of the trade leader to invest in. type: string additionalProperties: false InvestmentCreateResponse: title: "An Investment represents the relationship between leaders and followers.\r\n An investment can either be active, historic or a potential investment opportunity" required: - InvestmentId type: object properties: AccountId: title: "Account Id of this \r\n This property is obsolete." type: string deprecated: true AccountKey: title: "Account Key of this \r\n This property is obsolete." type: string deprecated: true AutoTradingPartnerLeaderId: title: Unique Identifier for Partner Leader Combination type: string ClientId: title: Gets the client id of the investment. minimum: 1 type: integer x-type-name: ClientId Currency: title: Account currency type: string DisplayName: title: User defined name of investment. If not specified then it defaults to type: string DisplayState: title: "SaxoInternal - States are bundled in DisplayStates for UI guidance.\r\n Only relevant for Saxo applications" type: integer format: int32 EntryGateResult: title: Entry Gate Test Result allOf: - $ref: '#/components/schemas/EntryGateResult' ErrorCode: title: Error Code allOf: - $ref: '#/components/schemas/ErrorCode' ErrorNumber: title: "Error number if this is in error state\r\n This property is obsolete, please use" type: integer format: int32 InitialFunding: title: The initial funding amount. type: number InvestmentId: title: Investment Item identifier type: string InvestmentProcessState: title: Investment process state allOf: - $ref: '#/components/schemas/InvestmentProcessState' InvestmentShieldAmount: title: Investment shield amount (drawdown protection level). type: number InvestmentStateId: title: State Id of this type: integer format: int32 IsAuthorizedToFollow: title: Reflects legal aspects of client (suitability and terms/conditions) type: boolean IsFollowAllowed: title: "Indicates whether user is allowed to follow current leaders instrument types and instruments.\r\n Also evaluates if follower passes any applied country filter or client group restrictions on leader.\r\n And verifies leader is enabled for any of followers owner(s)." type: boolean IsFollowing: title: Indicates if this is actively following. type: boolean IsOpenForFollowers: title: Indicates if additional followers can join. type: boolean description: Expresses if follower amount has exceeded limit. IsReadyForTrading: title: Indictes if this is ready for trading. type: boolean IsTradeFollowerReady: title: 'Indicates Trade Follower created, active and passed suitability test' type: boolean IsWithdrawalInProgress: title: Indicates if cash wtihdrawal is in progress. type: boolean MinimumFunding: title: The minimum funding amount. type: number PendingFunding: title: Any pending funding. type: number ReservedAmount: title: Any amount marked as reserved for withdrawl type: number ReturnPercentage: title: Account Performance return fraction type: number StateName: title: Description of the state this is in type: string StrategyName: title: Name of the strategy. type: string TradeLeaderId: title: identifier. type: string additionalProperties: false InvestmentEdit: title: Reperesents Investment's Edit parameters. type: object properties: DisplayName: title: The Display name for investment type: string FundingAccountKey: title: The account from where to withdraw any additional funding amount. minLength: 1 type: string x-type-name: AccountKey InvestmentShieldAmount: title: Investment shield amount (drawdown protection level). type: number IsActive: title: Set the investment active or inactive. type: boolean IsAutoFundsTransfer: title: Auto Funds transfer value in case of investment stop type: boolean PendingFunding: title: Any pending funding amount. type: number PositionsCloseOnDeactivation: title: Option to close or keep positions on deactivation (not available to all) type: boolean additionalProperties: false InvestmentProcessState: title: Investment process state. enum: - Active - Error - Processing - Retry - Starting - Stopped - Stopping type: string x-enum-descriptions: Active: Ready. Processing: Processing - Intermediate state. Retry: Recoverable error - User can Retry. Error: FatalError - User cannot proceed. Stopped: Portfolio item is Inactive. Starting: Starting. Stopping: Stopping. InvestmentSuggestionContract: title: An investment suggestion represents a potential investment in a tradeleader. required: - TradeLeaderId type: object properties: AutoTradingPartnerLeaderId: title: Unique Identifier for Partner Leader Combination type: string ClientId: title: The Client Identifier minimum: 1 type: integer x-type-name: ClientId Currency: title: Account currency type: string IsAuthorizedToFollow: title: Reflects legal aspects of client (suitability and terms/conditions) type: boolean IsFollowAllowed: title: "Indicates whether user is allowed to follow current leaders instrument types and instruments.\r\n Also evaluates if follower passes any applied country filter or client group restrictions on leader.\r\n And verifies leader is enabled for any of followers owner(s)." type: boolean IsFollowing: title: Indicates if this is actively following. type: boolean IsOpenForFollowers: title: Indicates if additional followers can join. type: boolean description: Expresses if follower amount has exceeded limit. IsReadyForTrading: title: Indictes if this is ready for trading. type: boolean IsTradeFollowerReady: title: 'Indicates Trade Follower created, active and passed suitability test' type: boolean MinimumFunding: title: The minimum funding amount. type: number StrategyName: title: Name of the strategy. type: string TradeLeaderId: title: identifier. type: string additionalProperties: false InvestmentSuggestionContractIEnumerable: type: array items: $ref: '#/components/schemas/InvestmentSuggestionContract' InvestmentSuggestionContractInvestmentsSubscriptionResponse: type: object properties: ContextId: title: The streaming context id that this response is associated with. type: string 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 x-display-order: 2 Format: title: 'The media type (RFC 2046), of the serialized data updates that are streamed to the client.' type: string InactivityTimeout: title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid. type: integer format: int32 RefreshRate: title: Actual refresh rate assigned to the subscription according to the customers SLA. type: integer format: int32 Snapshot: title: 'Snapshot of the current data on hand, when subscription was created.' type: array items: $ref: '#/components/schemas/InvestmentSuggestionContract' State: title: The value "Active". type: string description: This property is kept for backwards compatibility. Tag: title: 'Client specified tag assigned to the subscription, if specified in the request.' type: string additionalProperties: false InvestmentSummary: title: Returns the investment brief information under a leader type: object properties: AccountId: title: Follower Account ID type: string AccountValue: title: Follower Account value. type: number ClientId: title: Gets the client id of the investment. minimum: 1 type: integer x-type-name: ClientId Currency: title: Account currency type: string InitialFunding: title: The initial funding amount. type: number InvestmentStartDateTime: title: Date on which the given investment was created. type: string IsActive: title: Tells if the given investment is active. type: boolean PendingFunding: title: Any pending funding. type: number StateName: title: Description of the state this is in. type: string SuitabilityLevel: title: Gives the suitability level of the follower who made this investment. allOf: - $ref: '#/components/schemas/SuitabilityLevel' TimeWhenStateModified: title: Tells the time when state was last modified. type: string additionalProperties: false InvestmentTimestamp: title: Tells about the time of state of the investment type: object properties: AccountId: title: Account Id of this investment. type: string ClientId: title: Gets the client id of the investment. minimum: 1 type: integer x-type-name: ClientId TimeWhenStateModified: title: Tells the time when state was last modified. type: string additionalProperties: false InvestmentWithdraw: title: Represnts Investment withdraw parameters. required: - Amount - TargetAccountKey type: object properties: Amount: title: The withdrawal amount type: number TargetAccountKey: title: The target account for transfer of amount withdrawn. minLength: 1 type: string x-type-name: AccountKey additionalProperties: false InvestmentsSubscriptionArguments: title: The arugments for the session wide subscription request (none at the moment). type: object additionalProperties: false InvestmentsSubscriptionRequest: title: The request object required to setup a investments subscription. required: - ContextId - ReferenceId type: object properties: ContextId: title: "The streaming context id that this request is associated with.\r\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 x-display-order: 1 ReferenceId: title: "Mandatory client specified reference id for the subscription.\r\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 x-display-order: 2 Arguments: title: Arguments for the subscription request. allOf: - $ref: '#/components/schemas/InvestmentsSubscriptionArguments' Format: title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\r\n Currently only application/json and application/x-protobuf is supported.\r\n If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format." type: string RefreshRate: title: "Optional custom refresh rate, measured in milliseconds, between each data update.\r\n Note that it is not possible to get a refresh rate lower than the rate specified in the\r\n customer service level agreement (SLA)." maximum: 2147483647 minimum: 0 type: integer format: int32 ReplaceReferenceId: title: Reference id of the subscription that should be replaced. pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$' type: string Tag: title: Optional client specified tag used for grouping subscriptions. type: string additionalProperties: false LeaderState: title: Enum for the state of leader enum: - Disabled - Ready - Suspended - Unknown type: string x-enum-descriptions: Unknown: Unknown state Ready: Ready State Suspended: Suspended State Disabled: Disabled State Link: title: Represents a link to some web resource. type: object properties: Relation: title: The type of link. This adds semantic meaning to the link. type: string Type: title: Corresponds to media type for HTTP. type: string Uri: title: The URI to the resource. type: string additionalProperties: false ModelStateDictionary: type: object additionalProperties: type: array items: type: string PerformanceKeyFigures: title: OpenApi time weighted data contract type: object properties: ClosedTradesCount: title: The number of closed trades for the period. type: integer format: int32 DrawdownReport: title: The drawdown report for a time weighted time series. allOf: - $ref: '#/components/schemas/DrawdownReport' LosingDaysFraction: title: "The losing days fraction is the fraction of days with negative returns where\r\n both realized and unrealized profits are taken into account." type: number MaxDrawDownFraction: title: "The maximum draw down as fraction is the largest drop in the time series as a\r\n fraction." type: number ReturnFraction: title: The return fraction. type: number SampledStandardDeviation: title: "The unbiased sampled standard deviation which means that the standard deviation\r\n estimator has been corrected by applying the Bessel's correction." type: number SharpeRatio: title: The sharpe ratio. type: number SortinoRatio: title: The sortino ratio. type: number WinningFraction: title: The fraction of closed positions that has been won. type: number additionalProperties: false PortfolioAllocationType: title: Defines the type on which Portfolio composition is based enum: - Asset - EtfCategory - Instrument type: string x-enum-descriptions: Asset: Asset Based Allocation Type Instrument: Instrument based Allocation Type EtfCategory: Etf Category based Allocation Type PositionOnSecurityAndProduct: title: Details of Position on Securuty and Product type: object properties: Description: title: The product description. type: string ProductName: title: The product name. type: string Symbol: title: The symbol value. type: string Value: title: Value type: number additionalProperties: false ProductArea: title: Product areas are groupings of asset types (products) areas as needed by Mifid classifications and client suitability evaluations. enum: - Bonds - CFDs - CfdCommodities - ContractOptions - FXForwards - FXOptions - FXSpot - Futures - MutualFunds - Stocks type: string x-enum-descriptions: FXSpot: Forex Spot. The Forex Spot product area includes the asset type FxSpot. FXForwards: Forex Forwards. The FXForwards product area includes the asset type FxForwards. FXOptions: "Forex Options. The Forex Options product area includes the asset types FxVanillaOption,\r\n FxKnockInOption, FxKnockOutOption, FxBinaryOption, FxOneTouchOption and FxNoTouchOption." Futures: Futures. The Futures product area includes the asset types FuturesStrategy and ContractFutures. ContractOptions: 'Contract Options. The Contract Options product area includes the asset types FuturesOption, StockOption and StockIndexOption.' CFDs: CFDs. The CFDs product area includes the asset types CfdOnStock and CfdOnIndex. Stocks: Stocks. The Stocks product area includes the asset type Stock. Bonds: Bonds. The Bonds product area includes the asset type Bond. MutualFunds: Mutual Funds. The Mutual Funds product area include the asset type MutualFund. CfdCommodities: Cfds on Commodities. The Cfds on Commodities include the asset types CfdOnFutures and CfdOnIndex. Public.StandardPeriodType: enum: - AllTime - Invalid - Month - None - Quarter - Year type: string PutClientSuitabilityStatusRequest: title: The suitability status of a client. required: - OverallSuitability - ProductAreaSuitability type: object properties: OverallSuitability: title: The overall suitability level of a client. allOf: - $ref: '#/components/schemas/SuitabilityLevel' ProductAreaSuitability: title: The list of product areas for which the client is suitable. type: array items: $ref: '#/components/schemas/ProductArea' additionalProperties: false PutClientTermsAndConditionsRequest: title: Request to update the terms and conditions status of a client. required: - Accepted type: object properties: Accepted: title: 'Set Accepted to true if the client has accepted terms and conditions, and false otherwise.' type: boolean additionalProperties: false RiskLevel: title: Defines risk level. enum: - Aggressive - Alpha - Defensive - Moderate type: string x-enum-descriptions: Alpha: Alpha risk level Defensive: Defensive risk level Moderate: Moderate risk level Aggressive: Aggressive risk level StandardPeriodType: title: Defines types of standard periods. enum: - AllTime - Month - Quarter - Year type: string x-enum-descriptions: AllTime: "Defines a value for a (from, thru) request that maps to an all time account performance\r\n request." Year: "Defines a value a (from, thru) request that maps to the last year account performance\r\n request." Quarter: "Defines a value a (from, thru) request that maps to the last quater account performance\r\n request." Month: "Defines a value a (from, thru) request that maps to the last month account performance\r\n request." StringStringKeyValuePair: type: object properties: Key: type: string Value: type: string additionalProperties: false StringValuePair: title: Dto used for storing string/decimal value pairs type: object properties: StringValue: title: The string value. type: string Value: title: The decimal value type: number additionalProperties: false SuitabilityLevel: title: SuitabilityLevel - used by AutoTrading enum: - High - Low - Medium - Unknown - VeryHigh type: string x-enum-descriptions: Unknown: Not specified VeryHigh: '10: Very high risk / suitability required' High: '20: High risk / suitability required' Medium: '30: Medium risk / suitability required' Low: '40: Low risk / suitability required' TimeValuePair: title: Implementation of a time and value pair. type: object properties: Date: title: Date and time of the occurrence. type: string format: date x-type-name: Date Value: title: The value at the given date and time type: number additionalProperties: false TimeWeightedPerformance: title: OpenApi time weighted data contract type: object properties: AccumulatedPerformanceSparklineImageLinks: title: A collection of links to sparkline images for this performance calculatin. type: array items: $ref: '#/components/schemas/Link' AccumulatedTimeWeightedTimeSeries: title: The accumulated time weighted time series. type: array items: $ref: '#/components/schemas/TimeValuePair' MonthlyReturnTimeSeries: title: The monthly return time series. type: array items: $ref: '#/components/schemas/TimeValuePair' PerformanceFraction: title: The accumulated performance fraction that is associated with the time series. type: number PerformanceKeyFigures: title: Key performance figures for the account. allOf: - $ref: '#/components/schemas/PerformanceKeyFigures' YearlyReturnTimeSeries: title: The yearly time weighted return time series. type: array items: $ref: '#/components/schemas/TimeValuePair' additionalProperties: false TradeActivity: title: Defines a data contract for closed trades activity. type: object properties: TradesPerDay: title: The trades per day. type: array items: $ref: '#/components/schemas/TradesPerDayItem' additionalProperties: false TradeFollowerContract: title: Reperesents information of a Follower. type: object properties: AlertOnEverySaxoSelectAction: title: indicates value (true) based on if client has not retaken the test before suitability test deadline else false. type: boolean ClientLegalAssetTypes: title: Returns the list of client legal asset types. type: array items: $ref: '#/components/schemas/AssetType' ClientSuitableAssetTypes: title: Returns the list of client suitable asset types. type: array items: $ref: '#/components/schemas/AssetType' EsgPriority: title: 'ESG Priority to select e.g. Low, Medium, High' allOf: - $ref: '#/components/schemas/EsgPriority' EsgType: title: 'ESG Type for investment e.g. Environmental,Science,Governance etc' allOf: - $ref: '#/components/schemas/EsgType' ForcedIgnoreESGPreference: title: A boolean to indicate ignore ESG score type: boolean HasAcceptedTermsAndConditions: title: A value indicating whether current follower has accepted Terms and Conditions. type: boolean HasAccess: title: A value indicating whether current follower can use service. type: boolean IsDisabled: title: A value indicating whether current follower is active or not. type: boolean IsReady: title: A value indicating whether current follower is Ready for the service. type: boolean IsSuitabilityAlertRequired: title: indicates value (true) based on last suitability test before suitability test deadline else false. type: boolean IsSuitabilityExpired: title: indicates value (true) based on if client has not retaken the test before suitability test deadline else false. type: boolean IsUSExchangesRestricted: title: A value indicating whether current follower has access to US Exchange. type: boolean SuitabilityLevel: title: A value indicating current followers overall suitability level. allOf: - $ref: '#/components/schemas/SuitabilityLevel' additionalProperties: false TradeLeaderContract: title: Represents TradeLeader contract. type: object properties: AccountPerformance: title: Account performance numbers. allOf: - $ref: '#/components/schemas/AccountPerformance' AllowMultipleInvestment: title: Indicates if follower is allowed to have multiple investments for this tradeLeader type: boolean AllowPartialWithdrawal: title: Indicates if partial withdrawal is allowed for this tradeleader. type: boolean AllowRegularInvestment: title: Tells if regular investment is allowed or not type: boolean AutoTradingPartnerLeaderId: title: Unique Identifier for Partner Leader Combination type: string Category: title: Category this strategy belongs in. type: string Currency: title: Strategy currency. type: string Description: title: 'Strategy description, translated if requested and translation exists. Defaults to description in English.' type: string EsgPriority: title: 'ESG Priority to select e.g. Low, Medium, High' allOf: - $ref: '#/components/schemas/EsgPriority' EsgType: title: 'ESG Type for investment e.g. Environmental,Science,Governance etc' allOf: - $ref: '#/components/schemas/EsgType' FollowerAmountRemaining: title: Amount remaining before this strategy is fully invested. type: number IsInvestmentShieldSupported: title: Indicates if this strategy support investment shield. type: boolean IsOpenForFollowers: title: Indicates if additional followers can join. type: boolean description: Expresses if follower amount has exceeded limit. LeaderPartnerOptions: title: 'Trade leader partner options, see' allOf: - $ref: '#/components/schemas/TradeLeaderPartnerOptions' LogoUrl: title: URL path to leader logo. type: string ManagementFee: title: Strategy management fee. type: number MaxInvestmentAmount: title: Gives the maximum amount available for investment type: number MaxInvestmentAmountDescription: title: Gives the maximum amount description for investment type: string MinimumFundingAmount: title: Minimum amount requried to invest in this strategy. type: number PerformanceFee: title: Strategy performance fee. type: number Products: title: Translated products description for trade leader. type: string Prospectus: title: Links to prospectus documents for this strategy. type: array items: $ref: '#/components/schemas/StringStringKeyValuePair' RiskLevel: title: Strategy Risk level. allOf: - $ref: '#/components/schemas/RiskLevel' StrategyLegalAssetTypes: title: Returns the list of client legal asset types. type: array items: $ref: '#/components/schemas/AssetType' StrategyLegalProductAreas: title: Returns the list of client product areas. type: array items: $ref: '#/components/schemas/ProductArea' StrategyName: title: Name of the strategy. type: string SuitabilityLevel: title: Strategy required suitability level. allOf: - $ref: '#/components/schemas/SuitabilityLevel' TradeLeaderId: title: Trade leader identifier. type: string TradeLeaderOptions: title: 'Trade leader options, see' allOf: - $ref: '#/components/schemas/TradeLeaderOptions' additionalProperties: false TradeLeaderContractListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/TradeLeaderContract' 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 TradeLeaderOptions: title: "Defines options specific for a Saxo Select strategy\r\n values in Mits AutoTradingLeaders table" enum: - FixedInvestmentAmount - FutureToCfd - JointExecutionModel - None - UsExchanges type: string x-enum-descriptions: None: No special options should be used on this strategy FutureToCfd: Trade Leaders future trades are mapped to equivalent CFD trades on Follower accounts FixedInvestmentAmount: Trade Leader may only be followed with a fixed investment amount JointExecutionModel: Trade Leader order is executed in the same block as followers UsExchanges: Access to US exchange instruments x-type-warning: FlaggableEnum TradeLeaderPartnerOptions: title: "Defines options specific for a Saxo Select strategy when configured for a partner hierarchy\r\n values in Mits AutoTradingLeaderPartner table" enum: - EntryGateTestRequired - FeesAreExclusiveOfVat - None - PositionsCloseOnDeactivation type: string x-enum-descriptions: None: No special options should be used PositionsCloseOnDeactivation: "When Follower stops should all positions be closed?\r\n If set removes possibility for clients to keep positions" FeesAreExclusiveOfVat: Fees i.e. service- and performancefee are exclusive of VAT EntryGateTestRequired: if entry check is applicable for Trade Leader x-type-warning: FlaggableEnum TradeLeaderSummary: title: Brief leader information under which clients of a given WLC have invested type: object properties: CategoryName: title: The category this strategy belongs in. type: string Currency: title: Account currency of this type: string Investments: title: Existing investments under this leader. type: array items: $ref: '#/components/schemas/InvestmentSummary' MinimumFundingAmount: title: Minimum amount required to invest in this type: number MostRecentStart: title: Investment which was recently started under this given leader. allOf: - $ref: '#/components/schemas/InvestmentTimestamp' MostRecentStop: title: Investment which was recently stopped under this given leader. allOf: - $ref: '#/components/schemas/InvestmentTimestamp' NumberOfFollowers: title: Number of followers who made investements. type: integer format: int32 Products: title: Translated products description for trade leader. type: string ReturnPercentage: title: Percentage return of this leader. type: number StateOfLeader: title: State of the given leader. allOf: - $ref: '#/components/schemas/LeaderState' StrategyName: title: Name of the strategy of given leader. type: string SuitabilityLevel: title: Strategy required suitability level. allOf: - $ref: '#/components/schemas/SuitabilityLevel' TickerName: title: Ticker name of this . type: string TradeLeaderId: title: identifier. type: string TradeLeaderOptions: title: 'Trade leader options, see' allOf: - $ref: '#/components/schemas/TradeLeaderOptions' additionalProperties: false TradeLeaderSummaryListResult: type: object properties: Data: type: array items: $ref: '#/components/schemas/TradeLeaderSummary' 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 TradesPerAssetType: title: "Defines a data contract for trades allocation where the trades are grouped by\r\n the asset type of positions." type: object properties: ClosedTradesAllocations: title: The closed trades allocations type: array items: $ref: '#/components/schemas/AllocationItem' OpenTradesAllocations: title: The Open trades allocations type: array items: $ref: '#/components/schemas/AllocationItem' additionalProperties: false TradesPerDayItem: title: Defines a data contract for closed trades count on a single day. type: object properties: Date: title: The date. type: string format: date x-type-name: Date TradeCount: title: The trade count. type: integer format: int32 additionalProperties: false TradesPerInstrument: title: "Defines a data contract for trades allocation where the trades are grouped by\r\n the instrument." type: object properties: ClosedTradesAllocations: title: The closed trades allocations type: array items: $ref: '#/components/schemas/AllocationItem' OpenTradesAllocations: title: The Open trades allocations type: array items: $ref: '#/components/schemas/AllocationItem' additionalProperties: false WithdrawalAmountContract: title: Represents max amount currently available for withdrawal type: object properties: MaxWithdrawalAmount: title: Max amount currently available for withdrawal type: number additionalProperties: false 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 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: Investments description: End points for fetching and updating investment items. - name: Trade Followers description: End points for fetching follower information. - name: Trade Leaders description: End points for fetching tradeLeader information.