@livefolio/sdk / DataEvent

Type Alias: DataEvent

DataEvent = object

Defined in: interfaces/data-feed.ts:49

A single corporate event affecting an asset.

The payload shape is event-kind-specific and defined by the data provider. Callers should narrow on kind before reading payload fields.

Example

import type { DataEvent } from '@livefolio/sdk';

const event: DataEvent = {
  kind:    'dividend',
  t:       new Date('2024-02-09'),
  asset:   { kind: 'equity', id: 'AAPL', symbol: 'AAPL' },
  payload: { amount: 0.24, currency: 'USD', exDate: '2024-02-09' },
};

Properties

asset

asset: Asset

Defined in: interfaces/data-feed.ts:53

---

kind

kind: EventKind

Defined in: interfaces/data-feed.ts:50

---

payload

payload: Readonly<Record<string, unknown>>

Defined in: interfaces/data-feed.ts:55

Event-kind-specific fields. Shape is defined by the data provider.

---

t

t: Date

Defined in: interfaces/data-feed.ts:52

Effective date of the event (ex-date for dividends, announcement date for earnings).