quants/docs/schema.json at main · valuein/quants · GitHub

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
{
  "version": "1.0.0",
  "project": "Valuein SEC Data Warehouse",
  "tables": {
    "entity": {
      "description": "Legal structure and profile of reporting companies.",
      "columns": {
        "cik": { "type": "VARCHAR(10)", "primary_key": true },
        "name": { "type": "TEXT" },
        "lei": { "type": "VARCHAR(20)" },
        "industry": { "type": "TEXT" },
        "sector": { "type": "VARCHAR(100)" },
        "sic_code": { "type": "VARCHAR(4)" },
        "fiscal_year_end": { "type": "VARCHAR(5)" },
        "location": { "type": "TEXT" },
        "website": { "type": "TEXT" },
        "ceo": { "type": "TEXT" },
        "founded_year": { "type": "SMALLINT" },
        "description": { "type": "TEXT" },
        "status": { "type": "VARCHAR(20)" },
        "entity_type": { "type": "TEXT" },
        "ein": { "type": "TEXT" },
        "owner_org": { "type": "TEXT" },
        "investor_website": { "type": "TEXT" },
        "category": { "type": "TEXT" },
        "state_of_incorporation": { "type": "TEXT" },
        "phone": { "type": "TEXT" },
        "address": { "type": "TEXT" },
        "last_seen_at": { "type": "DATE" },
        "ingested_at": { "type": "TIMESTAMPTZ" }
      }
    },
    "security": {
      "description": "Ticker symbols and tradeable instrument metadata.",
      "columns": {
        "id": { "type": "SERIAL", "primary_key": true },
        "entity_id": { "type": "VARCHAR(10)", "references": "entity.cik" },
        "symbol": { "type": "VARCHAR(12)" },
        "exchange": { "type": "TEXT" },
        "mic": { "type": "VARCHAR(4)" },
        "valid_from": { "type": "DATE" },
        "valid_to": { "type": "DATE" },
        "is_active": { "type": "BOOLEAN" },
        "figi": { "type": "VARCHAR(12)" },
        "composite_figi": { "type": "VARCHAR(12)" },
        "share_class_figi": { "type": "VARCHAR(12)" },
        "security_type": { "type": "VARCHAR(50)" },
        "market_sector": { "type": "VARCHAR(20)" },
        "figi_ticker": { "type": "VARCHAR(20)" },
        "figi_name": { "type": "TEXT" },
        "figi_exch_code": { "type": "VARCHAR(10)" },
        "ingested_at": { "type": "TIMESTAMPTZ" }
      }
    },
    "filing": {
      "description": "Metadata for all SEC filings processed.",
      "columns": {
        "accession_id": { "type": "VARCHAR(20)", "primary_key": true },
        "entity_id": { "type": "VARCHAR(10)", "references": "entity.cik" },
        "filing_date": { "type": "DATE" },
        "form_type": { "type": "VARCHAR(10)" },
        "filing_url": { "type": "TEXT" },
        "is_amendment": { "type": "BOOLEAN" },
        "amendment_no": { "type": "SMALLINT" },
        "report_date": { "type": "DATE" },
        "items": { "type": "TEXT[]" },
        "accepted_at": { "type": "TIMESTAMPTZ" },
        "ingested_at": { "type": "TIMESTAMPTZ" }
      }
    },
    "fact": {
      "description": "Standardized financial data points (US-GAAP mapped).",
      "columns": {
        "entity_id": { "type": "VARCHAR(10)" },
        "accession_id": { "type": "VARCHAR(20)" },
        "concept": { "type": "TEXT" },
        "standard_concept": { "type": "VARCHAR(100)" },
        "priority": { "type": "SMALLINT" },
        "label": { "type": "TEXT" },
        "value": { "type": "TEXT" },
        "numeric_value": { "type": "DOUBLE PRECISION" },
        "unit": { "type": "VARCHAR(10)" },
        "period_start": { "type": "DATE" },
        "period_end": { "type": "DATE" },
        "fiscal_year": { "type": "SMALLINT" },
        "fiscal_period": { "type": "VARCHAR(10)" },
        "frame": { "type": "VARCHAR(20)" },
        "statement_type": { "type": "VARCHAR(20)" },
        "confidence_score": { "type": "DOUBLE PRECISION" },
        "is_negative": { "type": "BOOLEAN" },
        "is_audited": { "type": "BOOLEAN" },
        "is_estimated": { "type": "BOOLEAN" },
        "data_quality": { "type": "TEXT" },
        "knowledge_at": { "type": "TIMESTAMPTZ" },
        "ingested_at": { "type": "TIMESTAMPTZ" }
      }
    },
    "index_membership": {
      "description": "Historical constituents of major indices (e.g., S&P 500).",
      "columns": {
        "id": { "type": "SERIAL", "primary_key": true },
        "security_id": { "type": "INTEGER", "references": "security.id" },
        "index_name": { "type": "VARCHAR(50)" },
        "start_date": { "type": "DATE" },
        "end_date": { "type": "DATE" }
      }
    },
    "taxonomy_guide": {
      "description": "The 'Source of Truth' for standard concepts and their definitions.",
      "columns": {
        "standard_concept": { "type": "TEXT", "primary_key": true },
        "human_name": { "type": "TEXT" },
        "definition": { "type": "TEXT" },
        "unit_type": { "type": "VARCHAR(20)" },
        "balance_type": { "type": "VARCHAR(10)", "description": "Debit or Credit" },
        "source_reference": { "type": "TEXT" }
      }
    }
  }
}