market-data-sanity-checker - v1.2.0
    Preparing search index...

    Interface Connector

    interface Connector {
        name: string;
        requires: string;
        available(): boolean;
        fetchDaily(
            symbol: string,
            options?: FetchOptions,
        ): Promise<
            {
                symbol: string;
                exchange?: string;
                currency?: string;
                source: string;
                identifiers?: { isin?: string; cusip?: string; figi?: string };
                bars: {
                    timestamp: string;
                    open: number;
                    high: number;
                    low: number;
                    close: number;
                    volume?: number;
                    adjustmentFactor?: number;
                }[];
                dividends?: {
                    exDate: string;
                    payDate?: string;
                    amount: number;
                    currency?: string;
                    type?: "regular"
                    | "special";
                }[];
                splits?: { exDate: string; numerator: number; denominator: number }[];
                fundamentals?: {
                    marketCap?: number;
                    sharesOutstanding?: number;
                    eps?: number;
                    pe?: number;
                    dividendYield?: number;
                    payoutRatio?: number;
                };
            },
        >;
    }
    Index
    name: string

    Provider name, also used as the dataset's source.

    requires: string

    Human-readable note on what this connector needs (shown in errors/help).

    • Whether the connector can be used right now (e.g. API key present).

      Returns boolean

    • Fetches daily OHLCV (+ dividends/splits if the provider offers them) normalized to the schema.

      Parameters

      Returns Promise<
          {
              symbol: string;
              exchange?: string;
              currency?: string;
              source: string;
              identifiers?: { isin?: string; cusip?: string; figi?: string };
              bars: {
                  timestamp: string;
                  open: number;
                  high: number;
                  low: number;
                  close: number;
                  volume?: number;
                  adjustmentFactor?: number;
              }[];
              dividends?: {
                  exDate: string;
                  payDate?: string;
                  amount: number;
                  currency?: string;
                  type?: "regular"
                  | "special";
              }[];
              splits?: { exDate: string; numerator: number; denominator: number }[];
              fundamentals?: {
                  marketCap?: number;
                  sharesOutstanding?: number;
                  eps?: number;
                  pe?: number;
                  dividendYield?: number;
                  payoutRatio?: number;
              };
          },
      >