summaryrefslogtreecommitdiff
path: root/frontend/types/api.ts
blob: 3cc93e4ddcadc2b03dc17e3e3f0853bfa08c680b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
export type SearchResult = {
  symbol: string;
  name: string;
  exchange?: string | null;
};

export type Quote = {
  price?: number | null;
  prev_close?: number | null;
  change?: number | null;
  change_pct?: number | null;
};

export type MarketIndex = {
  name: string;
  price?: number | null;
  change_pct?: number | null;
};

export type Signal = {
  key: string;
  state: "pos" | "warn" | "neg" | "neu";
  value: string;
  description: string;
};

export type TickerOverview = {
  profile: {
    symbol: string;
    name: string;
    sector?: string | null;
    industry?: string | null;
    exchange?: string | null;
    website?: string | null;
    summary?: string | null;
  };
  quote: Quote;
  signals: Signal[];
  stats: {
    market_cap?: number | null;
    trailing_pe?: number | null;
    trailing_eps?: number | null;
    volume?: number | null;
    average_volume?: number | null;
    beta?: number | null;
  };
  ratios: {
    price_to_book?: number | null;
    price_to_sales?: number | null;
    ev_to_sales?: number | null;
    ev_to_ebitda?: number | null;
    gross_margin_ttm?: number | null;
    operating_margin_ttm?: number | null;
    net_margin_ttm?: number | null;
    roe_ttm?: number | null;
    roa_ttm?: number | null;
    roic_ttm?: number | null;
    debt_to_equity?: number | null;
    current_ratio?: number | null;
    dividend_yield_ttm?: number | null;
    dividend_payout_ratio_ttm?: number | null;
  };
  range_52w: {
    low?: number | null;
    high?: number | null;
    price?: number | null;
  };
  short_interest: {
    short_percent_of_float?: number | null;
    short_ratio?: number | null;
    shares_short?: number | null;
    shares_short_prior_month?: number | null;
    shares_short_delta_pct?: number | null;
  };
  meta: {
    status: "complete" | "partial";
    is_partial: boolean;
    field_availability: Record<string, boolean>;
    sources: Record<string, string>;
  };
};

export type HistoryPoint = {
  date: string;
  open?: number | null;
  high?: number | null;
  low?: number | null;
  close?: number | null;
  volume?: number | null;
};

export type WatchlistItem = {
  symbol: string;
  created_at: string;
  quote?: Quote | null;
};

export type WatchlistResponse = {
  items: WatchlistItem[];
  limit: number;
};

export type FinancialRow = {
  label: string;
  indent: number;
  is_total: boolean;
  is_section: boolean;
  is_margin: boolean;
  values: (number | null)[];
};

export type FinancialStatement = {
  columns: string[];
  rows: FinancialRow[];
};

export type FinancialsResponse = {
  period: "annual" | "quarterly";
  income: FinancialStatement;
  balance: FinancialStatement;
  cash_flow: FinancialStatement;
};