Skip to content

@livefolio/sdk / Fundamentals

Type Alias: Fundamentals

Fundamentals = Readonly<Record<string, number | string | null>>

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

A flat record of fundamental data points for an asset at a point in time. Values may be numeric (e.g. P/E ratio), string (e.g. sector name), or null when a data provider does not carry that field.

Example

ts
import type { Fundamentals } from '@livefolio/sdk';

const f: Fundamentals = {
  peRatio:    28.5,
  sector:     'Technology',
  debtEquity: null, // not available for this provider
};

Released under the MIT License.