# Get Corporate Actions Detail
Retrieves detailed information for corporate action events.
# OpenAPI definition
```json
{
"info": {
"title": "Webull Open API Reference",
"description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
"contact": {
"name": "",
"url": "",
"email": ""
},
"version": "2.0",
"x-logo": {
"url": "static/png/logo.png"
}
},
"servers": [
{
"url": "https://broker-api.sandbox.webull.hk"
}
],
"path": "/broker/instruments/stocks/corporate-actions/get",
"method": "get",
"tags": [
"Instrument"
],
"description": "Retrieves detailed information for corporate action events.",
"operationId": "brokerCorporateActionsDetail",
"parameters": [
{
"name": "event_id",
"in": "query",
"description": "Corporate Event Action ID",
"required": true,
"schema": {
"type": "string"
},
"example": "CA123456789"
},
{
"name": "x-app-key",
"in": "header",
"description": "A unique identifier issued to a developer for accessing an application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-app-secret",
"in": "header",
"description": "A unique key issued to developers to access the application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-timestamp",
"in": "header",
"description": "Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-signature-version",
"in": "header",
"description": "Signature algorithm version, default is 1.0.",
"required": true,
"schema": {
"type": "string",
"default": "1.0"
},
"examples": {
"1.0": {
"value": "1.0"
}
}
},
{
"name": "x-signature-algorithm",
"in": "header",
"description": "Signature algorithm, default is HMAC-SHA1.",
"required": true,
"schema": {
"type": "string",
"default": "HMAC-SHA1"
},
"examples": {
"HMAC-SHA1": {
"value": "HMAC-SHA1"
}
}
},
{
"name": "x-signature-nonce",
"in": "header",
"description": "Signature unique random number.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-version",
"in": "header",
"description": "API interface version. Supported values: `v2`, `v3`.",
"required": true,
"schema": {
"type": "string",
"default": "v3"
},
"examples": {
"v3": {
"value": "v3"
}
}
},
{
"name": "x-signature",
"in": "header",
"description": "A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"event_id": {
"type": "string",
"description": "Company Event ID",
"example": "1234567890"
},
"event_type": {
"type": "string",
"description": "Corporate Event Type
IDENTIFIER_CHANGE - Identifier-related changes to a security without economic impact, including symbol, exchange, ISIN, CUSIP, or instrument name changes
DIVIDEND - Dividend and distribution events, including cash dividend, stock dividend, optional dividend, and return of capital
REVERSE_SPLIT - Reverse stock split that consolidates shares and reduces the number of outstanding shares
FORWARD_SPLIT - Forward stock split that increases the number of outstanding shares
BONUS_ISSUE - Bonus issue of additional shares distributed to existing shareholders at no cost
RIGHTS_OFFERING - Rights offering allowing shareholders to subscribe for additional shares
DISTRIBUTION - Distribution of cash, securities, or other assets to shareholders
SPIN_OFF - Spin-off event where shares of a subsidiary or new entity are distributed to existing shareholders
UNIT_SPLIT - Unit split event affecting composite or unit-based securities
MERGER - Merger or acquisition event involving the combination of two or more entities
FULL_CALL - Full call redemption of the entire outstanding security issue
PARTIAL_CALL - Partial call redemption affecting only a portion of the outstanding issue
EXCHANGE - Exchange event where existing securities are exchanged for new securities or other consideration
DTC_EXIT - Event indicating a security is no longer eligible for DTC settlement or custody
LIQUIDATION - Liquidation event involving the winding up of an issuer and asset distribution
WORTHLESS - Worthless security event indicating the security has no residual value
ADR_GDR_TERMINATION - Termination of an ADR or GDR program
MATURITY - Maturity event where a security reaches its contractual maturity date
ADR_FEE - ADR fee charged to holders of American Depositary Receipts
CONVERSION - Conversion event where securities are converted into another class or form
OPEN_OFFER - Open offer allowing shareholders to subscribe for additional securities
PREFERENTIAL_OFFER - Preferential offer made to selected shareholders under specific terms
PERFORMANCE_COMPENSATION - Performance compensation event related to performance commitments, commonly in A-share markets
DELISTING - Delisting event where a security is removed from exchange trading",
"example": "DIVIDEND",
"enum": [
"IDENTIFIER_CHANGE",
"DIVIDEND",
"REVERSE_SPLIT",
"FORWARD_SPLIT",
"BONUS_ISSUE",
"RIGHTS_OFFERING",
"DISTRIBUTION",
"SPIN_OFF",
"UNIT_SPLIT",
"MERGER",
"FULL_CALL",
"PARTIAL_CALL",
"EXCHANGE",
"DTC_EXIT",
"LIQUIDATION",
"WORTHLESS",
"ADR_GDR_TERMINATION",
"MATURITY",
"ADR_FEE",
"CONVERSION",
"OPEN_OFFER",
"PREFERENTIAL_OFFER",
"PERFORMANCE_COMPENSATION",
"DELISTING"
]
},
"event_version": {
"type": "string",
"description": "Event Version",
"example": "1"
},
"instrument_id": {
"type": "string",
"description": "Instrument ID",
"example": "943a9802f6c14983b3b4755c69c01717"
},
"category": {
"type": "string",
"description": "Instrument Stock Category
US_STOCK - US stock,
HK_STOCK - HK stock,
CN_STOCK - China A share
",
"example": "HK_STOCK",
"enum": [
"US_STOCK",
"HK_STOCK",
"CN_STOCK"
]
},
"record_date": {
"type": "string",
"description": "Record Date (YYYY-MM-DD)",
"example": "2024-12-31"
},
"ex_date": {
"type": "string",
"description": "Ex Date (YYYY-MM-DD)",
"example": "2024-12-30"
},
"payment_date": {
"type": "string",
"description": "Payment Date (YYYY-MM-DD)",
"example": "2025-01-15"
},
"final_pay_date": {
"type": "string",
"description": "Final Payment Date (YYYY-MM-DD)",
"example": "2025-02-15"
},
"country_code": {
"type": "string",
"description": "Country Code, ISO 3166-1 alpha-2 format",
"example": "HK"
},
"listing_country_of_code": {
"type": "string",
"description": "Listing Country Code, ISO 3166-1 alpha-2 format",
"example": "HK"
},
"issuer_country_code": {
"type": "string",
"description": "Issuer Country Code, ISO 3166-1 alpha-2 format",
"example": "HK"
},
"from": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the instrument",
"example": "01029"
},
"name": {
"type": "string",
"description": "Name of the instrument",
"example": "IRC Limited"
},
"exchange": {
"type": "string",
"description": "Exchange code",
"example": "CCC"
}
},
"description": "Event From Info. Position's instrument information",
"title": "EventFromInfo"
},
"to": {
"type": "array",
"description": "Event To Info. Corporate action's target instrument information",
"items": {
"type": "object",
"properties": {
"option_number": {
"type": "string",
"description": "Option Number. Identifier for the payout option",
"example": "1"
},
"description": {
"type": "string",
"description": "Description of the payout option",
"example": "Securities"
},
"default_option_flag": {
"type": "string",
"description": "Default Option Flag. Indicates if the default payout option is exposed",
"example": "true"
},
"payouts": {
"type": "array",
"description": "Payouts associated with this option",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payout Nature Type
DV - Dividend: Cash or stock distribution paid to shareholders
FR - Franked Dividend: Dividend paid with franking credits attached
IN - Interest: Interest income distribution
L2 - Long Term Capital Gains: Gains from disposal of assets held longer than one year
OT - Other: Other types of income or entitlement (see extended terms)
C - Cash: Cash payment (only applicable to events created prior to release 2)
PC - Cash/Principal/Return of Capital: Cash returned as principal or capital
PM - Premium: Additional amount paid over base entitlement
S - Securities: Distribution of securities instead of cash
ST - Short Term Capital Gains: Gains from disposal of assets held less than one year
SI - Sundry Income: Miscellaneous income distributions
UF - Unfranked Dividend: Dividend paid without franking credits
PI - Property Income Distribution: Income derived from property assets
TD - Tax Deferred: Income deferred for tax purposes
TE - Tax Exempted: Income exempted from taxation
FI - Foreign Income: Income sourced from foreign jurisdictions
CD - Capital gain on disposal of taxable property - Discounted
CO - Capital gain on disposal of taxable property - Other
CC - Capital gain on disposal of taxable property - Concessional
CN - Capital gain on disposal of non-taxable property
RT - Royalties: Payment received for intellectual property usage
TX - Tax Credit: Credit applied against tax liability
BP - Buy Permitted: Security is eligible for purchase under corporate action
CL - Cash in Lieu of Fractional Share: Cash payment for fractional share entitlement
DF - Drop Fraction: Fractional shares are dropped without compensation
EX - Extend and Retain Fractions: Fractional shares are retained and adjusted
NC - Round to Nearest Cent: Monetary amounts rounded to the nearest cent
NW - Round to Nearest Whole Number if .5 or above: Rounding rule for fractional shares
PR - Purchase Required: Mandatory purchase of securities as part of corporate action
RD - Round Down to Nearest Whole Number: Fractional shares rounded down
RU - Round Up to Nearest Whole Number: Fractional shares rounded up
SR - Sale Required: Mandatory sale of securities as part of corporate action
BU - Round up: Generic rounding up rule
BC - Beneficial Owner Cash in Lieu: Cash payment to beneficial owner for fractional share
BD - Beneficial Owner Round Down: Fractional shares of beneficial owner rounded down
CT - Security Convert To Cash: Conversion of security into cash (used for tokenized assets)",
"example": "DV",
"enum": [
"DV",
"FR",
"IN",
"L2",
"OT",
"C",
"PC",
"PM",
"S",
"ST",
"SI",
"UF",
"PI",
"TD",
"TE",
"FI",
"CD",
"CO",
"CC",
"CN",
"RT",
"TX",
"BP",
"CL",
"DF",
"EX",
"NC",
"NW",
"PR",
"RD",
"RU",
"SR",
"BU",
"BC",
"BD",
"CT"
]
},
"pay_type": {
"type": "string",
"description": "Payout Delivery Type
CASH - Cash settlement
SECURITY - Security settlement (stock, right, warrant, etc.)
SCRIP - Scrip dividend (dividend paid in shares instead of cash)
SECURITY_AND_CASH - Combination of security and cash (logical type, not for persistence)",
"example": "CASH",
"enum": [
"CASH",
"SECURITY",
"SCRIP",
"SECURITY_AND_CASH"
]
},
"payout_number": {
"type": "integer",
"description": "Sequence number of the payout within the same option. Used for ordering and identification.",
"format": "int32",
"example": 1
},
"adr_fee_rate": {
"type": "string",
"description": "ADR fee rate applied to this payout, if applicable.",
"example": "0.02"
},
"fraction_share_rule": {
"type": "string",
"description": "Fraction Share Rule
NONE - No special handling for fractional shares
ROUND_DOWN - Round down fractional shares
ROUND_UP - Round up fractional shares
CASH_IN_LIEU - Cash in lieu for fractional shares
DISTRIBUTION - Fractional share distribution
STANDARD - Standard rounding for fractional shares",
"example": "ROUND_DOWN",
"enum": [
"NONE",
"ROUND_DOWN",
"ROUND_UP",
"CASH_IN_LIEU",
"DISTRIBUTION",
"STANDARD"
]
},
"cancellation_fee": {
"type": "string",
"description": "Cancellation fee rate applied if the corporate action is cancelled.",
"example": "0"
},
"issuance_fee": {
"type": "string",
"description": "Issuance fee rate applied for newly issued securities.",
"example": "0"
},
"tax_status": {
"type": "string",
"description": "IRS income classification for tax reporting purposes.",
"example": "0001"
},
"currency": {
"type": "string",
"description": "Currency of the cash payout. Applicable only when payType involves CASH.",
"example": "USD"
},
"amount": {
"type": "string",
"description": "Cash amount paid per share held. Applicable only when payType involves CASH.",
"example": "0.85"
},
"withholding_tax_rate": {
"type": "string",
"description": "Withholding tax rate applied to the cash payout.",
"example": "0.15"
},
"symbol": {
"type": "string",
"description": "Trading symbol of the distributed security.",
"example": "AAPL"
},
"name": {
"type": "string",
"description": "Name of the distributed security.",
"example": "Apple Inc."
},
"exchange": {
"type": "string",
"description": "Exchange where the distributed security is listed.",
"example": "CCC"
},
"from_ratio": {
"type": "string",
"description": "Original holding quantity used as the base for ratio calculation.",
"example": "10"
},
"to_ratio": {
"type": "string",
"description": "Distributed quantity received for the given base holding.",
"example": "1"
},
"cash_in_lieu_price": {
"type": "string",
"description": "Cash-in-lieu price used to settle fractional shares.",
"example": "125.3"
},
"reinvest_price": {
"type": "string",
"description": "Reinvestment price used for scrip dividend calculation.",
"example": "132.5"
}
},
"description": "Corporate Action Payout Detail. Represents a single payout rule applied per unit holding under a specific corporate action option.",
"title": "EventPayout"
}
}
},
"description": "Event To Info. Corporate action's target instrument information",
"title": "EventToInfo"
}
}
},
"description": "Corporate Action Result",
"title": "CorporateActionResult"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Insufficient permission"
}
}
}
}
}
},
"417": {
"description": "A business logic error triggered when the request cannot be processed due to domain-specific constraints.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "INVALID_PARAMETER"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Parameter error, phone"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "SYSTEM_ERROR"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"postman": {
"name": "Get Corporate Actions Detail",
"description": {
"content": "Retrieves detailed information for corporate action events.",
"type": "text/plain"
},
"url": {
"path": [
"broker",
"instruments",
"stocks",
"corporate-actions",
"get"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "(Required) Corporate Event Action ID",
"type": "text/plain"
},
"key": "event_id",
"value": ""
}
],
"variable": []
},
"header": [
{
"disabled": false,
"description": {
"content": "(Required) A unique identifier issued to a developer for accessing an application's API.",
"type": "text/plain"
},
"key": "x-app-key",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A unique key issued to developers to access the application's API.",
"type": "text/plain"
},
"key": "x-app-secret",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"type": "text/plain"
},
"key": "x-timestamp",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm version, default is 1.0.",
"type": "text/plain"
},
"key": "x-signature-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm, default is HMAC-SHA1.",
"type": "text/plain"
},
"key": "x-signature-algorithm",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature unique random number.",
"type": "text/plain"
},
"key": "x-signature-nonce",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) API interface version. Supported values: `v2`, `v3`.",
"type": "text/plain"
},
"key": "x-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"type": "text/plain"
},
"key": "x-signature",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET"
}
}
```