Table of Contents

Struct EventSubType

Namespace
DatabentoDotNet.Reference
Assembly
DatabentoDotNet.Reference.dll

A corporate-action event sub-type.

[JsonConverter(typeof(ReferenceCodeJsonConverter<EventSubType>))]
public readonly record struct EventSubType : IReferenceCode<EventSubType>, IEquatable<EventSubType>
Implements
Inherited Members

Remarks

An open set: a code this library does not know is carried, not lost. Upstream ends this enum in an Unknown(String) variant (enums.rs:2365) so a code Databento adds next month round-trips untouched, and a C# enum cannot hold a payload. See IReferenceCode<TSelf> for the shape this takes instead and why.

The members come from the EVENTSUBTYPE group of the vendored corporate_actions.list_enums response, which is the oracle rather than a count typed into an issue.

The dictionary carries 80 entries for 67 distinct codes: six codes appear more than once with a description that depends on the parent event, and seven entries carry no code at all. The members here are deduplicated by code, and a member whose code has more than one description names all of them — the description belongs to the event, not to the sub-type.

Constructors

EventSubType(string)

Wraps a wire code, known or not. Prefer a named member such as Agm where one exists, and From(string?) where the value came from the server.

public EventSubType(string code)

Parameters

code string

The wire code.

Exceptions

ArgumentException

code is null or empty. A blank code is the absence of a value, which is default.

Properties

Agm

Annual General Meeting (AGM).

public static EventSubType Agm { get; }

Property Value

EventSubType

Amt

Amortisation (AMT).

public static EventSubType Amt { get; }

Property Value

EventSubType

Bb

Buyback (BB).

public static EventSubType Bb { get; }

Property Value

EventSubType

Bbed

Buyback Early Deadline (BBED).

public static EventSubType Bbed { get; }

Property Value

EventSubType

Bbrd

Buyback Regular Deadline (BBRD).

public static EventSubType Bbrd { get; }

Property Value

EventSubType

Bhm

Bond Holder Meeting (BHM).

public static EventSubType Bhm { get; }

Property Value

EventSubType

Bon

Bonus (BON).

public static EventSubType Bon { get; }

Property Value

EventSubType

Call

Call Option Exercised (CALL).

public static EventSubType Call { get; }

Property Value

EventSubType

Capdist

Capital Distribution (CAPDIST).

public static EventSubType Capdist { get; }

Property Value

EventSubType

Capgain

Capital Gain (CAPGAIN).

public static EventSubType Capgain { get; }

Property Value

EventSubType

Caprd

Capital Reduction (CAPRD).

public static EventSubType Caprd { get; }

Property Value

EventSubType

Cgm

Court Ordered General Meeting (CGM).

public static EventSubType Cgm { get; }

Property Value

EventSubType

Claimset

Claim Settled (CLAIMSET).

public static EventSubType Claimset { get; }

Property Value

EventSubType

Code

The wire code, or null when this names no value.

public string? Code { get; }

Property Value

string

Consd

Reverse Split, currently only used in US events / Consolidation (CONSD).

public static EventSubType Consd { get; }

Property Value

EventSubType

Corr

Correction (CORR).

public static EventSubType Corr { get; }

Property Value

EventSubType

Cu

Clean Up (CU).

public static EventSubType Cu { get; }

Property Value

EventSubType

Defpy

Default Payment (DEFPY).

public static EventSubType Defpy { get; }

Property Value

EventSubType

Dist

Spin-Off, currently only used in US events / Distribution (DIST).

public static EventSubType Dist { get; }

Property Value

EventSubType

Div

Forward Split, currently only used in US events / Dividend (DIV).

public static EventSubType Div { get; }

Property Value

EventSubType

Divacc

Dividend Accumulation (DIVACC).

public static EventSubType Divacc { get; }

Property Value

EventSubType

Divinc

Dividend Income (DIVINC).

public static EventSubType Divinc { get; }

Property Value

EventSubType

Dmrgr

Spin-Off, currently only used in US events / Demerger (DMRGR).

public static EventSubType Dmrgr { get; }

Property Value

EventSubType

Dprcpdiv

Depository Receipt Dividend (DPRCPDIV).

public static EventSubType Dprcpdiv { get; }

Property Value

EventSubType

Dr

Drawings (DR).

public static EventSubType Dr { get; }

Property Value

EventSubType

Drl

Drawings by lottery (DRL).

public static EventSubType Drl { get; }

Property Value

EventSubType

Dt

Tax Free Dividend Component (DT).

public static EventSubType Dt { get; }

Property Value

EventSubType

Dutchauct

Dutch Auction (DUTCHAUCT).

public static EventSubType Dutchauct { get; }

Property Value

EventSubType

Econv

Early Conversion (ECONV).

public static EventSubType Econv { get; }

Property Value

EventSubType

Egm

Extraordinary General Meeting (EGM).

public static EventSubType Egm { get; }

Property Value

EventSubType

Er

Early Redemption (ER).

public static EventSubType Er { get; }

Property Value

EventSubType

F

Fully franked (F).

public static EventSubType F { get; }

Property Value

EventSubType

Gm

General Meeting (GM).

public static EventSubType Gm { get; }

Property Value

EventSubType

HasValue

true when this names a code — known or not.

public bool HasValue { get; }

Property Value

bool

Int

Interest Basis Unknown (INT).

public static EventSubType Int { get; }

Property Value

EventSubType

Intacc

Interest Accumulation (INTACC).

public static EventSubType Intacc { get; }

Property Value

EventSubType

Intdiv

Derived from Interest Payment (INTDIV).

public static EventSubType Intdiv { get; }

Property Value

EventSubType

Intinc

Interest Income (INTINC).

public static EventSubType Intinc { get; }

Property Value

EventSubType

IsKnown

true when Code is one of KnownCodes.

public bool IsKnown { get; }

Property Value

bool

Remarks

false is not an error. It means the server sent something newer than the table this library shipped with, and the code is still in Code to be read, logged, or sent back in a filter.

KnownCodes

Every code the reference API reported for this type when the fixture was captured — 67 of them.

public static IReadOnlySet<string> KnownCodes { get; }

Property Value

IReadOnlySet<string>

Liq

Liquidation (LIQ).

public static EventSubType Liq { get; }

Property Value

EventSubType

Mat

Maturity (MAT).

public static EventSubType Mat { get; }

Property Value

EventSubType

Mrgr

Merger (MRGR).

public static EventSubType Mrgr { get; }

Property Value

EventSubType

Mwc

Make Whole Call (MWC).

public static EventSubType Mwc { get; }

Property Value

EventSubType

N

Not known (N).

public static EventSubType N { get; }

Property Value

EventSubType

Nrenrts

Non Renounceable Rights (NRENRTS).

public static EventSubType Nrenrts { get; }

Property Value

EventSubType

Opoff

Open Offer (OPOFF).

public static EventSubType Opoff { get; }

Property Value

EventSubType

Ord

Ordinary (ORD).

public static EventSubType Ord { get; }

Property Value

EventSubType

P

Partially franked (P).

public static EventSubType P { get; }

Property Value

EventSubType

Pf

Purchase Fund (PF).

public static EventSubType Pf { get; }

Property Value

EventSubType

Poff

Priority Offer (POFF).

public static EventSubType Poff { get; }

Property Value

EventSubType

Pro

Property Basis Unknown (PRO).

public static EventSubType Pro { get; }

Property Value

EventSubType

Proacc

Property Accumulation (PROACC).

public static EventSubType Proacc { get; }

Property Value

EventSubType

Proinc

Property Income (PROINC).

public static EventSubType Proinc { get; }

Property Value

EventSubType

Put

Put Option Exercised (PUT).

public static EventSubType Put { get; }

Property Value

EventSubType

Rcap

Return of Capital Component (RCAP).

public static EventSubType Rcap { get; }

Property Value

EventSubType

Redemclaim

Redemption Claim (REDEMCLAIM).

public static EventSubType Redemclaim { get; }

Property Value

EventSubType

Res

Reserves (RES).

public static EventSubType Res { get; }

Property Value

EventSubType

Rm

Residual Maturity (RM).

public static EventSubType Rm { get; }

Property Value

EventSubType

Rod

Repayment of Debt Component (ROD).

public static EventSubType Rod { get; }

Property Value

EventSubType

Sd

Subdivision / Forward Split, currently only used in US events (SD).

public static EventSubType Sd { get; }

Property Value

EventSubType

Sgm

Special General Meeting (SGM).

public static EventSubType Sgm { get; }

Property Value

EventSubType

Soa

Sale of Assets (SOA).

public static EventSubType Soa { get; }

Property Value

EventSubType

Spa

Share Premium Account (SPA).

public static EventSubType Spa { get; }

Property Value

EventSubType

Spp

Share Purchase Plan (SPP).

public static EventSubType Spp { get; }

Property Value

EventSubType

Tend

Tender Offer (TEND).

public static EventSubType Tend { get; }

Property Value

EventSubType

Tendmrgr

Tender resulting in Merger (TENDMRGR).

public static EventSubType Tendmrgr { get; }

Property Value

EventSubType

Tkovrmini

Mini-Takeover (TKOVRMINI).

public static EventSubType Tkovrmini { get; }

Property Value

EventSubType

U

Unfranked (U).

public static EventSubType U { get; }

Property Value

EventSubType

Ukwnsubtyp

Insufficient data to assign a TKOVR event subtype (UKWNSUBTYP).

public static EventSubType Ukwnsubtyp { get; }

Property Value

EventSubType

Wrtdn

Write Down (WRTDN).

public static EventSubType Wrtdn { get; }

Property Value

EventSubType

Methods

From(string?)

Reads a wire code, mapping null and the empty string to default — the absence of a value.

public static EventSubType From(string? code)

Parameters

code string

The wire code, or null.

Returns

EventSubType

The value.

ToString()

The wire code, or the empty string when this names no value.

public override string ToString()

Returns

string

The wire code.

Edit this page