openapi: 3.0.1
info:
title: Services.AutoTrading Account Values Events API
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.<div class=well style=''border: 1px solid rgb(204, 82, 0); border-image: none; background-color: rgb(255, 209, 179);padding:1px;''><strong> Note:</strong> </br>This service is subject to special licensing agreements and not generally available to all OpenAPI applications.</div>'
version: 2.4.138+710c760591
x-framework-version: 38.0.2+439c5b0ec3
x-machine: SIMOAWEB11-DK2
servers:
- url: https://gateway.saxobank.com/sim/openapi
tags:
- name: Events
description: Find Corporate action voluntary events.
paths:
/ca/v2/events/{EventId}:
get:
tags:
- Events
summary: Get corporate action event
description: Get specified event, if event is not cancelled, where client holds position on corresponding instrument.
operationId: EventsGetEventAsync
parameters:
- name: ClientKey
in: query
description: Client identifier
schema:
minLength: 1
type: string
x-type-name: ClientKey
example: 5DG7K1P5cqYBZ77tl7Af4w==
- name: EventId
in: path
description: Corporate action identifier
required: true
schema:
type: string
example: '875684'
- name: IncludeSubAccounts
in: query
description: Indicate whether to include events from sub-clients.
schema:
type: boolean
example: false
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
example:
AssetType: Stock
BidIntervalRate:
Currency: EUR
Value: 1
ClaimPeriod:
End:
Status: Ongoing
Start:
Status: Ongoing
CorporateActionType: Voluntary
DisplayAndFormat:
Description: Chargeurs SA
IsinCode: FR0000130692
Symbol: CRI:xpar
Effective:
Date: '2021-02-12'
Electable: Electable
ElectionStatus: PartialElected
EventId: '9652429'
EventIndicators:
- Indicator: AdditionalBusinessProcess
Values:
- Code: NPLE
Description: The issuer only allows a single option to be selected per designated holding.
Name: No Split Election
- Indicator: Change
Values:
- Code: BERE
Description: Change from bearer into registered form.
Name: Bearer to Registered
- Indicator: Consent
Values:
- Code: CTRM
Description: This is a change in the terms and conditions of the bond.
Name: Change in Terms
- Indicator: Dividend
Values:
- Code: FINL
Description: Payment of a dividend, less the amounts already paid through interim dividends.
Name: Final
EventState: Preliminary
EventStatus: Past
EventType:
Code: DVCA
Description: Distribution of cash to shareholders, in proportion to their equity holding. Ordinary dividends are recurring and regular. Shareholder must take cash and may be offered a choice of currency.
Name: Cash Dividend
Ex:
Date: '2021-02-12'
Holdings:
- AccountId: 123INET
Amount: 100
CashReserved:
Currency: USD
Value: 2583.62
ClientId: '906869'
ClientName: John
ElectedAmount: 20
EventId: '9652429'
Options:
- ElectedAmount: 20
ElectionType: Manual
Instruction:
Status: Accepted
OptionId: '1'
Remarks: Remarks by client...
OwnerId: '532'
InformationToComply: RestrictionsMayApply
InterestPeriod:
End:
Status: Ongoing
Start:
Status: Ongoing
MaxPrice:
Currency: EUR
Type: Actual
Value: 60
MaxQuantitySought: 1000
MinPrice:
Currency: EUR
Type: Actual
Value: 5
MinQuantitySought: 4
Narrative: '<b>ADTX</b><p>Rights issue trading period of rights: ______________ terms: you may apply for _____ new share for every ______ rights held at _________ per share.<br/>Client must ensure that they instruct in the multiple/s advised in the notification.<br/>Failure to comply will result in the rejection of instruction/s and client/s will not be notified of the rejection.<br/>Option 1: exercise (receive shares) option 2: oversubscribe (please state the number of additional shares you wish to oversubscribe for).<br/>Option 3: lapse (default) should the client wish to oversubscribe, kindly ensure to exercise full quantity of rights.<br/>Oversubscription may be subject to scaleback based at the account level.<br/>For clients who elect to exercise and oversubscribe, please ensure your account is funded on the same day of instructions submission; failure to do so will result in your instruction being rejected.<br/>Total subscription cost/s including oversubscription will be debited on the next business day after the instruction deadline date.<br/>A potential future resultant entitlement will be booked to a dummy security and may be subject to a proration factor being applied where oversubscription has been elected.<br/>Note that any reduction or change in this position may be a result of this factor.<br/>The final resultant entitlement will be booked on the market identifier upon receipt from agent.<br/>In the case where scaleback of subscription/oversubscription occurs, cost will be refunded without interest as soon as practical upon receipt from the agent.<br/>We will attempt to sell any tradeable rights position left uninstructed or instructed to lapse on the last rights trading date if the value of the client position is worth more than eur 30 or equivalent to the currency of the security.<br/>For non tradeable rights, rights not exercised will be lapsed worthless.<br/>We hereby informs the client that, according to the laws of the country of its incorporation or the laws of the country of residence of its customers and the laws applicable to an issuer of securities which are subject to corporate actions, the client, will decide to participate or not to such corporate actions upon its sole and exclusive discretion and judgment.<br/>The client will bear any detrimental consequence arising out of or connected to such instruction.<br/>For the avoidance of doubt, any information in relation to the corporate actions sent to the client may have been obtained from sources which are not under the bank''s control and accordingly, the bank shall not be held responsible for the truth and the accuracy of this information.<br/>Please refer to the prospectus of the event for any further details.<br/><br/></p><b>ADTX</b><p>Rights issue trading period of rights: ______________ terms: you may apply for _____ new share for every ______ rights held at _________ per share.<br/>Client must ensure that they instruct in the multiple/s advised in the notification.<br/>Failure to comply will result in the rejection of instruction/s and client/s will not be notified of the rejection.<br/>Option 1: exercise (receive shares) option 2: oversubscribe (please state the number of additional shares you wish to oversubscribe for).<br/>Option 3: lapse (default) should the client wish to oversubscribe, kindly ensure to exercise full quantity of rights.<br/>Oversubscription may be subject to scaleback based at the account level.<br/>For clients who elect to exercise and oversubscribe, please ensure your account is funded on the same day of instructions submission; failure to do so will result in your instruction being rejected.<br/>Total subscription cost/s including oversubscription will be debited on the next business day after the instruction deadline date.<br/>A potential future resultant entitlement will be booked to a dummy security and may be subject to a proration factor being applied where oversubscription has been elected.<br/>Note that any reduction or change in this position may be a result of this factor.<br/>The final resultant entitlement will be booked on the market identifier upon receipt from agent.<br/>In the case where scaleback of subscription/oversubscription occurs, cost will be refunded without interest as soon as practical upon receipt from the agent.<br/>We will attempt to sell any tradeable rights position left uninstructed or instructed to lapse on the last rights trading date if the value of the client position is worth more than eur 30 or equivalent to the currency of the security.<br/>For non tradeable rights, rights not exercised will be lapsed worthless.<br/>We hereby informs the client that, according to the laws of the country of its incorporation or the laws of the country of residence of its customers and the laws applicable to an issuer of securities which are subject to corporate actions, the client, will decide to participate or not to such corporate actions upon its sole and exclusive discretion and judgment.<br/>The client will bear any detrimental consequence arising out of or connected to such instruction.<br/>For the avoidance of doubt, any information in relation to the corporate actions sent to the client may have been obtained from sources which are not under the bank''s control and accordingly, the bank shall not be held responsible for the truth and the accuracy of this information.<br/>Please refer to the prospectus of the event for any further details.<br/><br/></p>'
NewBoardLotQuantity: 20
NewDenominationQuantity: 100
NumberofDaysAccrued: 23
Options:
- BidIntervalRate:
Currency: EUR
Value: 1
CashMovements:
- CashMovementType: Credit
Currency: USD
PriceType: Actual
SubscriptionPrice: 11.9623
CashRequired: false
Deadline:
Date: '2021-02-23T08:30:00Z'
IsDefault: false
IsGross: false
IsTaxable: true
MaxPrice:
Currency: EUR
Type: Actual
Value: 60
MinPrice:
Currency: EUR
Type: Actual
Value: 5
OptionId: '1'
OptionIndicators:
- Indicator: BidRange
Values:
- Code: DIVI
Description: All values (including minimum and maximum prices) are divisible by the bid interval.
Name: Divisible
OptionType:
Code: CASH
Name: Cash
Payment:
Date: '2021-02-12'
PayoutBreakdown:
- Amount: 5.9623
Component:
Code: INTRT
Description: Interest
Name: Interest
Currency: USD
- Amount: 6
Component:
Code: LTCG
Description: Long term capital gain
Name: Long term capital gain
Currency: USD
- CashRequired: false
Deadline:
Date: '2021-02-23T08:30:00Z'
IsDefault: true
IsGross: false
IsTaxable: true
NetRate: 0.08
OptionId: '2'
OptionIndicators:
- Indicator: CertificationBreakdown
Values:
- Code: DOMI
Description: The holder of the security has to certify his domicile.
Name: Country of Domicile
OptionType:
Code: SECU
Description: Securities Option
Payment:
Date: '2021-02-12'
SecurityMovements:
- Currency: AUD
DisplayAndFormat:
Description: Telstra Corp. Ltd
IsinCode: AU000000TLS2
Symbol: TLS:xasx
SecurityMovementType: Credit
Uic: 5081
Record:
Status: Ongoing
StrikePrice:
Currency: EUR
Type: Actual
Value: 25
TradingSuspended:
Status: Ongoing
Uic: 13126
'404':
description: Requested resource not found.
'400':
description: Request contains invalid parameters.
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'
'401':
$ref: '#/components/responses/Unauthorized'
'503':
$ref: '#/components/responses/ServiceUnavailable'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- OpenApiOAuthSecurityScheme: []
- OpenApiJWTSecurityScheme: []
x-required-permissions:
confidential: Read
/ca/v2/events:
get:
tags:
- Events
summary: Get corporate action events
description: Get list of Mandatory and Voluntary events, excluding cancelled events, if specified client holds position on corresponding instrument.
operationId: EventsGetEventsAsync
parameters:
- name: $skip
in: query
description: The number of entries to skip from the beginning of the collection
schema:
minimum: 0
type: integer
format: int32
example: 1
- name: $top
in: query
description: The number of entries to return from the beginning of the collection
schema:
minimum: 0
type: integer
format: int32
default: 100
example: 1
- name: AccountGroupKey
in: query
description: Account group to get the events for.
schema:
minLength: 1
type: string
x-type-name: AccountGroupKey
example: BxS0VWLta8lJ3SBpjGBQjw==
- name: AccountKey
in: query
description: Account to get the events for.
schema:
minLength: 1
type: string
x-type-name: AccountKey
example: 2y0tX0m9ZH7MH8HK38qM9g==
- name: AssetTypes
in: query
description: Asset type filter for events.
schema:
type: array
items:
$ref: '#/components/schemas/AssetType'
example: Stock,Bond
- name: ClientKey
in: query
description: Client to get the events for.
schema:
minLength: 1
type: string
x-type-name: ClientKey
example: 7m4I|vtYLUnEGg77o9uQhw==
- name: CorporateActionTypes
in: query
description: Corporate action type filter for events.
schema:
type: array
items:
$ref: '#/components/schemas/Model.CorporateActionType'
example: Mandatory,Voluntary
- name: ElectionStatuses
in: query
description: Election status filter for events.
schema:
type: array
items:
$ref: '#/components/schemas/ElectionStatus'
example: Elected,PartialElected
- name: EventStatus
in: query
description: Event status filter.
schema:
$ref: '#/components/schemas/EventStatus'
example: Active
- name: EventTypes
in: query
description: Event type filter. Use event type codes to filter.
schema:
type: array
items:
type: string
example: DVCA,DVOP
- name: FromDeadlineDate
in: query
description: Events on or after specified deadline date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-06-16'
- name: FromExDate
in: query
description: Events on or after specified ex date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-06-16'
- name: FromPayDate
in: query
description: Events on or after specified pay date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-06-16'
- name: FromRecordDate
in: query
description: Events on or after specified record date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-06-16'
- name: IncludeSubAccounts
in: query
description: Indicate whether to include events from sub-clients.
schema:
type: boolean
example: false
- name: Keywords
in: query
description: Looks for keywords in instrument description, ISIN code, and instrument symbol.
schema:
type: string
example: Appl
- name: SortColumn
in: query
description: Specify a column to sort on. Default sort will be provided on Date.
schema:
$ref: '#/components/schemas/Model.SortColumn'
example: Date
- name: SortType
in: query
description: Specify ascending or descending sort. Default sort type will be Descending.
schema:
$ref: '#/components/schemas/SortType'
example: Desc
- name: ToDeadlineDate
in: query
description: Events on or before specified deadline date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-10-15'
- name: ToExDate
in: query
description: Events on or before specified ex date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-10-15'
- name: ToPayDate
in: query
description: Events on or before specified pay date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-10-15'
- name: ToRecordDate
in: query
description: Events on or before specified record date.
schema:
type: string
format: date
x-type-name: Date
example: '2020-10-15'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/EventListResult'
example:
__count: 1
Data:
- AssetType: Stock
BidIntervalRate:
Currency: EUR
Value: 1
ClaimPeriod:
End:
Status: Ongoing
Start:
Status: Ongoing
CorporateActionType: Voluntary
DisplayAndFormat:
Description: Chargeurs SA
IsinCode: FR0000130692
Symbol: CRI:xpar
Effective:
Date: '2021-02-12'
Electable: Electable
ElectionStatus: PartialElected
EventId: '9652429'
EventIndicators:
- Indicator: AdditionalBusinessProcess
Values:
- Code: NPLE
Description: The issuer only allows a single option to be selected per designated holding.
Name: No Split Election
- Indicator: Change
Values:
- Code: BERE
Description: Change from bearer into registered form.
Name: Bearer to Registered
- Indicator: Consent
Values:
- Code: CTRM
Description: This is a change in the terms and conditions of the bond.
Name: Change in Terms
- Indicator: Dividend
Values:
- Code: FINL
Description: Payment of a dividend, less the amounts already paid through interim dividends.
Name: Final
EventState: Preliminary
EventStatus: Past
EventType:
Code: DVCA
Description: Distribution of cash to shareholders, in proportion to their equity holding. Ordinary dividends are recurring and regular. Shareholder must take cash and may be offered a choice of currency.
Name: Cash Dividend
Ex:
Date: '2021-02-12'
Holdings:
- AccountId: 123INET
Amount: 100
CashReserved:
Currency: USD
Value: 2583.62
ClientId: '906869'
ClientName: John
ElectedAmount: 20
EventId: '9652429'
Options:
- ElectedAmount: 20
ElectionType: Manual
Instruction:
Status: Accepted
OptionId: '1'
Remarks: Remarks by client...
OwnerId: '532'
InformationToComply: RestrictionsMayApply
InterestPeriod:
End:
Status: Ongoing
Start:
Status: Ongoing
MaxPrice:
Currency: EUR
Type: Actual
Value: 60
MaxQuantitySought: 1000
MinPrice:
Currency: EUR
Type: Actual
Value: 5
MinQuantitySought: 4
Narrative: '<b>ADTX</b><p>Rights issue trading period of rights: ______________ terms: you may apply for _____ new share for every ______ rights held at _________ per share.<br/>Client must ensure that they instruct in the multiple/s advised in the notification.<br/>Failure to comply will result in the rejection of instruction/s and client/s will not be notified of the rejection.<br/>Option 1: exercise (receive shares) option 2: oversubscribe (please state the number of additional shares you wish to oversubscribe for).<br/>Option 3: lapse (default) should the client wish to oversubscribe, kindly ensure to exercise full quantity of rights.<br/>Oversubscription may be subject to scaleback based at the account level.<br/>For clients who elect to exercise and oversubscribe, please ensure your account is funded on the same day of instructions submission; failure to do so will result in your instruction being rejected.<br/>Total subscription cost/s including oversubscription will be debited on the next business day after the instruction deadline date.<br/>A potential future resultant entitlement will be booked to a dummy security and may be subject to a proration factor being applied where oversubscription has been elected.<br/>Note that any reduction or change in this position may be a result of this factor.<br/>The final resultant entitlement will be booked on the market identifier upon receipt from agent.<br/>In the case where scaleback of subscription/oversubscription occurs, cost will be refunded without interest as soon as practical upon receipt from the agent.<br/>We will attempt to sell any tradeable rights position left uninstructed or instructed to lapse on the last rights trading date if the value of the client position is worth more than eur 30 or equivalent to the currency of the security.<br/>For non tradeable rights, rights not exercised will be lapsed worthless.<br/>We hereby informs the client that, according to the laws of the country of its incorporation or the laws of the country of residence of its customers and the laws applicable to an issuer of securities which are subject to corporate actions, the client, will decide to participate or not to such corporate actions upon its sole and exclusive discretion and judgment.<br/>The client will bear any detrimental consequence arising out of or connected to such instruction.<br/>For the avoidance of doubt, any information in relation to the corporate actions sent to the client may have been obtained from sources which are not under the bank''s control and accordingly, the bank shall not be held responsible for the truth and the accuracy of this information.<br/>Please refer to the prospectus of the event for any further details.<br/><br/></p><b>ADTX</b><p>Rights issue trading period of rights: ______________ terms: you may apply for _____ new share for every ______ rights held at _________ per share.<br/>Client must ensure that they instruct in the multiple/s advised in the notification.<br/>Failure to comply will result in the rejection of instruction/s and client/s will not be notified of the rejection.<br/>Option 1: exercise (receive shares) option 2: oversubscribe (please state the number of additional shares you wish to oversubscribe for).<br/>Option 3: lapse (default) should the client wish to oversubscribe, kindly ensure to exercise full quantity of rights.<br/>Oversubscription may be subject to scaleback based at the account level.<br/>For clients who elect to exercise and oversubscribe, please ensure your account is funded on the same day of instructions submission; failure to do so will result in your instruction being rejected.<br/>Total subscription cost/s including oversubscription will be debited on the next business day after the instruction deadline date.<br/>A potential future resultant entitlement will be booked to a dummy security and may be subject to a proration factor being applied where oversubscription has been elected.<br/>Note that any reduction or change in this position may be a result of this factor.<br/>The final resultant entitlement will be booked on the market identifier upon receipt from agent.<br/>In the case where scaleback of subscription/oversubscription occurs, cost will be refunded without interest as soon as practical upon receipt from the agent.<br/>We will attempt to sell any tradeable rights position left uninstructed or instructed to lapse on the last rights trading date if the value of the client position is worth more than eur 30 or equivalent to the currency of the security.<br/>For non tradeable rights, rights not exercised will be lapsed worthless.<br/>We hereby informs the client that, according to the laws of the country of its incorporation or the laws of the country of residence of its customers and the laws applicable to an issuer of securities which are subject to corporate actions, the client, will decide to participate or not to such corporate actions upon its sole and exclusive discretion and judgment.<br/>The client will bear any detrimental consequence arising out of or connected to such instruction.<br/>For the avoidance of doubt, any information in relation to the corporate actions sent to the client may have been obtained from sources which are not under the bank''s control and accordingly, the bank shall not be held responsible for the truth and the accuracy of this information.<br/>Please refer to the prospectus of the event for any further details.<br/><br/></p>'
NewBoardLotQuantity: 20
NewDenominationQuantity: 100
NumberofDaysAccrued: 23
Options:
- BidIntervalRate:
Currency: EUR
Value: 1
CashMovements:
- CashMovementType: Credit
Currency: USD
PriceType: Actual
SubscriptionPrice: 11.9623
CashRequired: false
Deadline:
Date: '2021-02-23T08:30:00Z'
IsDefault: false
IsGross: false
IsTaxable: true
MaxPrice:
Currency: EUR
Type: Actual
Value: 60
MinPrice:
Currency: EUR
Type: Actual
Value: 5
OptionId: '1'
OptionIndicators:
- Indicator: BidRange
Values:
- Code: DIVI
Description: All values (including minimum and maximum prices) are divisible by the bid interval.
Name: Divisible
OptionType:
Code: CASH
Name: Cash
Payment:
Date: '2021-02-12'
PayoutBreakdown:
- Amount: 5.9623
Component:
Code: INTRT
Description: Interest
Name: Interest
Currency: USD
- Amount: 6
Component:
Code: LTCG
Description: Long term capital gain
Name: Long term capital gain
Currency: USD
- CashRequired: false
Deadline:
Date: '2021-02-23T08:30:00Z'
IsDefault: true
IsGross: false
IsTaxable: true
NetRate: 0.08
OptionId: '2'
OptionIndicators:
- Indicator: CertificationBreakdown
Values:
- Code: DOMI
Description: The holder of the security has to certify his domicile.
Name: Country of Domicile
OptionType:
Code: SECU
Description: Securities Option
Payment:
Date: '2021-02-12'
SecurityMovements:
- Currency: AUD
DisplayAndFormat:
Description: Telstra Corp. Ltd
IsinCode: AU000000TLS2
Symbol: TLS:xasx
SecurityMovementType: Credit
Uic: 50
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/saxo/refs/heads/main/openapi/saxo-events-api-openapi.yml