Skip to content

Commit 9683c0b

Browse files
committed
feat(context): add instrument classification property
This adds an experimental optional classification field to the instrument context. For use in categorizing different types of financial instruments. Fixes #1615
1 parent 523b816 commit 9683c0b

File tree

2 files changed

+84
-2
lines changed

2 files changed

+84
-2
lines changed

packages/fdc3-context/schemas/context/instrument.schema.json

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,47 @@
9696
"unevaluatedProperties": {
9797
"type": "string"
9898
}
99+
},
100+
"classification": {
101+
"title": "Instrument Classification",
102+
"description": "@experimental classification of the instrument by type or category. SHOULD be one of the standardized values, although other string values are permitted.",
103+
"anyOf": [
104+
{
105+
"type": "string",
106+
"enum": [
107+
"commodity",
108+
"commodityIndex",
109+
"corporateDebt",
110+
"creditDefaultSwapIndex",
111+
"deal",
112+
"debt",
113+
"debtIndex",
114+
"etf",
115+
"fixedIncome",
116+
"future",
117+
"governmentBenchmarkDebt",
118+
"loan",
119+
"mortgageBackedSecurity",
120+
"municipalDebt",
121+
"mutualFund",
122+
"mutualFundIndex",
123+
"option",
124+
"otherDebt",
125+
"ownershipPrivateCompany",
126+
"pevcFirm",
127+
"pevcFund",
128+
"privateCompany",
129+
"publicCompany",
130+
"publicCompanyIndex",
131+
"sovereignDebt",
132+
"structuredProduct",
133+
"unknown"
134+
]
135+
},
136+
{
137+
"type": "string"
138+
}
139+
]
99140
}
100141
},
101142
"required": [
@@ -115,7 +156,8 @@
115156
},
116157
"market": {
117158
"MIC": "XNAS"
118-
}
159+
},
160+
"classification": "publicCompany"
119161
}
120162
]
121163
}

website/docs/context/ref/Instrument.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,45 @@ The `market` map can be used to further specify the instrument and help achieve
171171

172172
</details>
173173

174+
<details>
175+
<summary><code>classification</code></summary>
176+
177+
**Any of:**
178+
179+
- **type**: `string` with values:
180+
- `commodity`,
181+
- `commodityIndex`,
182+
- `corporateDebt`,
183+
- `creditDefaultSwapIndex`,
184+
- `deal`,
185+
- `debt`,
186+
- `debtIndex`,
187+
- `etf`,
188+
- `fixedIncome`,
189+
- `future`,
190+
- `governmentBenchmarkDebt`,
191+
- `loan`,
192+
- `mortgageBackedSecurity`,
193+
- `municipalDebt`,
194+
- `mutualFund`,
195+
- `mutualFundIndex`,
196+
- `option`,
197+
- `otherDebt`,
198+
- `ownershipPrivateCompany`,
199+
- `pevcFirm`,
200+
- `pevcFund`,
201+
- `privateCompany`,
202+
- `publicCompany`,
203+
- `publicCompanyIndex`,
204+
- `sovereignDebt`,
205+
- `structuredProduct`,
206+
- `unknown`
207+
- **type**: `string`
208+
209+
[@experimental](/docs/fdc3-compliance#experimental-features) classification of the instrument by type or category. SHOULD be one of the standardized values, although other string values are permitted.
210+
211+
</details>
212+
174213
## Example
175214

176215
```json
@@ -184,7 +223,8 @@ The `market` map can be used to further specify the instrument and help achieve
184223
},
185224
"market": {
186225
"MIC": "XNAS"
187-
}
226+
},
227+
"classification": "publicCompany"
188228
}
189229
```
190230

0 commit comments

Comments
 (0)