asset-profiles/schema/etf.schema.json at main · wealthfolio/asset-profiles · 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/wealthfolio/asset-profiles/schema/etf.schema.json",
  "title": "ETF Profile",
  "type": "object",
  "required": ["schema_version", "kind", "primary_symbol", "listings", "name", "provenance"],
  "additionalProperties": false,
  "properties": {
    "schema_version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+$"
    },
    "kind": { "const": "etf" },
    "isin": {
      "type": "string",
      "pattern": "^[A-Z]{2}[A-Z0-9]{9}[0-9]$"
    },
    "primary_symbol": { "type": "string", "minLength": 1 },
    "listings": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["symbol"],
        "additionalProperties": false,
        "properties": {
          "symbol":       { "type": "string", "minLength": 1 },
          "exchange_mic": { "type": "string", "pattern": "^[A-Z0-9]{4}$" },
          "currency":     { "type": "string", "pattern": "^[A-Z]{3}$" }
        }
      }
    },
    "name": { "type": "string", "minLength": 1 },
    "issuer": { "type": "string" },
    "category_group": { "type": "string" },
    "category": { "type": "string" },
    "expense_ratio": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "aum_usd": {
      "type": "number",
      "minimum": 0
    },
    "inception_date": {
      "type": "string",
      "format": "date"
    },
    "as_of_date": {
      "type": "string",
      "format": "date"
    },
    "sector_weights": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["sector", "weight"],
        "additionalProperties": false,
        "properties": {
          "sector": { "type": "string", "minLength": 1 },
          "weight": { "type": "number", "minimum": 0, "maximum": 1 }
        }
      }
    },
    "country_weights": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["country", "weight"],
        "additionalProperties": false,
        "properties": {
          "country":      { "type": "string", "minLength": 1 },
          "country_code": {
            "anyOf": [
              { "type": "string", "pattern": "^[A-Z]{2}$" },
              { "type": "null" }
            ]
          },
          "weight":       { "type": "number", "minimum": 0, "maximum": 1 }
        }
      }
    },
    "asset_class_weights": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["asset_class", "weight"],
        "additionalProperties": false,
        "properties": {
          "asset_class": { "type": "string", "minLength": 1 },
          "weight":      { "type": "number", "minimum": 0, "maximum": 1 }
        }
      }
    },
    "top_holdings": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["weight"],
        "additionalProperties": false,
        "properties": {
          "symbol": { "type": "string" },
          "isin":   { "type": "string", "pattern": "^[A-Z]{2}[A-Z0-9]{9}[0-9]$" },
          "cusip":  { "type": "string", "pattern": "^[A-Z0-9]{9}$" },
          "name":   { "type": "string" },
          "weight": { "type": "number", "minimum": 0, "maximum": 1 }
        }
      }
    },
    "holdings_count": {
      "type": "integer",
      "minimum": 0
    },
    "identifiers": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "isin":  { "type": "string", "pattern": "^[A-Z]{2}[A-Z0-9]{9}[0-9]$" },
        "cusip": { "type": "string", "pattern": "^[A-Z0-9]{9}$" }
      }
    },
    "provenance": {
      "type": "object",
      "required": ["source", "fetched_at"],
      "additionalProperties": false,
      "properties": {
        "source":     { "type": "string", "minLength": 1 },
        "source_url": { "type": "string", "format": "uri" },
        "fetched_at": { "type": "string", "format": "date-time" },
        "license":    { "type": "string" }
      }
    }
  }
}