@invinite-org/data-api-client 5.9.0 → 5.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +16 -0
- package/dist/apis/HoldingsApi.d.ts +57 -2
- package/dist/apis/HoldingsApi.js +142 -3
- package/dist/esm/apis/HoldingsApi.d.ts +57 -2
- package/dist/esm/apis/HoldingsApi.js +141 -2
- package/dist/esm/models/EtfHolding.d.ts +167 -0
- package/dist/esm/models/EtfHolding.js +97 -0
- package/dist/esm/models/EtfWeight.d.ts +92 -0
- package/dist/esm/models/EtfWeight.js +85 -0
- package/dist/esm/models/ListEtfHoldings200Response.d.ts +52 -0
- package/dist/esm/models/ListEtfHoldings200Response.js +57 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMeta.js +72 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.js +50 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +59 -0
- package/dist/esm/models/ListEtfWeights200Response.d.ts +52 -0
- package/dist/esm/models/ListEtfWeights200Response.js +57 -0
- package/dist/esm/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
- package/dist/esm/models/ListEtfWeights200ResponseMeta.js +79 -0
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/models/EtfHolding.d.ts +167 -0
- package/dist/models/EtfHolding.js +105 -0
- package/dist/models/EtfWeight.d.ts +92 -0
- package/dist/models/EtfWeight.js +93 -0
- package/dist/models/ListEtfHoldings200Response.d.ts +52 -0
- package/dist/models/ListEtfHoldings200Response.js +64 -0
- package/dist/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
- package/dist/models/ListEtfHoldings200ResponseMeta.js +80 -0
- package/dist/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
- package/dist/models/ListEtfHoldings200ResponseMetaComposition.js +57 -0
- package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
- package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +67 -0
- package/dist/models/ListEtfWeights200Response.d.ts +52 -0
- package/dist/models/ListEtfWeights200Response.js +64 -0
- package/dist/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
- package/dist/models/ListEtfWeights200ResponseMeta.js +87 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/docs/EtfHolding.md +76 -0
- package/docs/EtfWeight.md +48 -0
- package/docs/HoldingsApi.md +196 -1
- package/docs/ListEtfHoldings200Response.md +41 -0
- package/docs/ListEtfHoldings200ResponseMeta.md +47 -0
- package/docs/ListEtfHoldings200ResponseMetaComposition.md +43 -0
- package/docs/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.md +41 -0
- package/docs/ListEtfWeights200Response.md +41 -0
- package/docs/ListEtfWeights200ResponseMeta.md +45 -0
- package/package.json +1 -1
- package/src/apis/HoldingsApi.ts +192 -2
- package/src/models/EtfHolding.ts +248 -0
- package/src/models/EtfWeight.ts +150 -0
- package/src/models/ListEtfHoldings200Response.ts +108 -0
- package/src/models/ListEtfHoldings200ResponseMeta.ts +151 -0
- package/src/models/ListEtfHoldings200ResponseMetaComposition.ts +105 -0
- package/src/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.ts +103 -0
- package/src/models/ListEtfWeights200Response.ts +108 -0
- package/src/models/ListEtfWeights200ResponseMeta.ts +148 -0
- package/src/models/index.ts +8 -0
package/docs/HoldingsApi.md
CHANGED
|
@@ -4,19 +4,214 @@ All URIs are relative to *https://api.data.invinite.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**listEtfHoldings**](HoldingsApi.md#listetfholdings) | **GET** /v1/etf-holdings | List ETF holdings (daily issuer files or N-PORT) |
|
|
8
|
+
| [**listEtfWeights**](HoldingsApi.md#listetfweights) | **GET** /v1/etf-weights | List ETF sector, country and asset-class weights |
|
|
7
9
|
| [**listFundHoldings**](HoldingsApi.md#listfundholdings) | **GET** /v1/fund-holdings | List N-PORT fund holdings |
|
|
8
10
|
| [**listHoldingChanges**](HoldingsApi.md#listholdingchanges) | **GET** /v1/holding-changes | List 13F position changes |
|
|
9
11
|
| [**listHoldings**](HoldingsApi.md#listholdings) | **GET** /v1/holdings | List 13F holdings |
|
|
10
12
|
|
|
11
13
|
|
|
12
14
|
|
|
15
|
+
## listEtfHoldings
|
|
16
|
+
|
|
17
|
+
> ListEtfHoldings200Response listEtfHoldings(etf, company, asOf, sort, fields, limit, cursor)
|
|
18
|
+
|
|
19
|
+
List ETF holdings (daily issuer files or N-PORT)
|
|
20
|
+
|
|
21
|
+
The holdings of US ETFs from the freshest source per ETF, always named: the issuer\'s own daily (or monthly) holdings file where the store reads one, else the fund\'s latest public N-PORT report (quarter end, about 60 days later). `etf=` lists one ETF\'s positions (`meta.source`, `meta.as_of`; `as_of=` reads a stored earlier date, `meta.composition.stored_dates` lists them), order `-weight_pct`; `company=` lists the ETFs whose newest issuer file holds the company (one row per ETF, its lines of the company summed; ETFs known only from N-PORT are listed by `/v1/fund-holdings?company=`), order `-market_value_usd`. Exactly one of `etf` or `company`. A single-asset trust (GLD) has no rows by design (`meta.reason: single_asset_trust`). `EtfHolding` is not `FundHolding` (R16): `/v1/fund-holdings` serves filed N-PORT rows per report (with `accession_number` and `report_date`); this collection is the current composition of a listed ETF by ticker and falls back to N-PORT only where no issuer file is read.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import {
|
|
27
|
+
Configuration,
|
|
28
|
+
HoldingsApi,
|
|
29
|
+
} from '@invinite-org/data-api-client';
|
|
30
|
+
import type { ListEtfHoldingsRequest } from '@invinite-org/data-api-client';
|
|
31
|
+
|
|
32
|
+
async function example() {
|
|
33
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
34
|
+
const config = new Configuration({
|
|
35
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
36
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
37
|
+
});
|
|
38
|
+
const api = new HoldingsApi(config);
|
|
39
|
+
|
|
40
|
+
const body = {
|
|
41
|
+
// string | ETF ticker: the fund\'s freshest composition (one ETF) (optional)
|
|
42
|
+
etf: SPY,
|
|
43
|
+
// string | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. (optional)
|
|
44
|
+
company: NVDA,
|
|
45
|
+
// Date | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest (optional)
|
|
46
|
+
asOf: 2026-11-12,
|
|
47
|
+
// '-weight_pct' | '-market_value_usd' | Sort field: `-weight_pct` with etf= (default), `-market_value_usd` with company= (default); the only orders the store serves (optional)
|
|
48
|
+
sort: -weight_pct,
|
|
49
|
+
// string | Comma list of root-level fields to keep (R7) (optional)
|
|
50
|
+
fields: fiscal_year,period_end,
|
|
51
|
+
// number | Rows per page (default 25, max 1 000 on 13F rows) (optional)
|
|
52
|
+
limit: 100,
|
|
53
|
+
// string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
|
|
54
|
+
cursor: eyJ2IjoyfQ,
|
|
55
|
+
} satisfies ListEtfHoldingsRequest;
|
|
56
|
+
|
|
57
|
+
try {
|
|
58
|
+
const data = await api.listEtfHoldings(body);
|
|
59
|
+
console.log(data);
|
|
60
|
+
} catch (error) {
|
|
61
|
+
console.error(error);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// Run the test
|
|
66
|
+
example().catch(console.error);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
| Name | Type | Description | Notes |
|
|
73
|
+
|------------- | ------------- | ------------- | -------------|
|
|
74
|
+
| **etf** | `string` | ETF ticker: the fund\'s freshest composition (one ETF) | [Optional] [Defaults to `undefined`] |
|
|
75
|
+
| **company** | `string` | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. | [Optional] [Defaults to `undefined`] |
|
|
76
|
+
| **asOf** | `Date` | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest | [Optional] [Defaults to `undefined`] |
|
|
77
|
+
| **sort** | `-weight_pct`, `-market_value_usd` | Sort field: `-weight_pct` with etf= (default), `-market_value_usd` with company= (default); the only orders the store serves | [Optional] [Defaults to `undefined`] [Enum: -weight_pct, -market_value_usd] |
|
|
78
|
+
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
79
|
+
| **limit** | `number` | Rows per page (default 25, max 1 000 on 13F rows) | [Optional] [Defaults to `25`] |
|
|
80
|
+
| **cursor** | `string` | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
|
|
81
|
+
|
|
82
|
+
### Return type
|
|
83
|
+
|
|
84
|
+
[**ListEtfHoldings200Response**](ListEtfHoldings200Response.md)
|
|
85
|
+
|
|
86
|
+
### Authorization
|
|
87
|
+
|
|
88
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
89
|
+
|
|
90
|
+
### HTTP request headers
|
|
91
|
+
|
|
92
|
+
- **Content-Type**: Not defined
|
|
93
|
+
- **Accept**: `application/json`, `application/problem+json`
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### HTTP response details
|
|
97
|
+
| Status code | Description | Response headers |
|
|
98
|
+
|-------------|-------------|------------------|
|
|
99
|
+
| **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
|
|
100
|
+
| **304** | 304: the `If-None-Match` ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
|
|
101
|
+
| **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
|
|
102
|
+
| **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
|
|
103
|
+
| **402** | 402: insufficient_credits | * X-Request-Id - <br> |
|
|
104
|
+
| **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
|
|
105
|
+
| **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
|
|
106
|
+
| **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
|
|
107
|
+
| **500** | 500: internal | * X-Request-Id - <br> |
|
|
108
|
+
| **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
|
|
109
|
+
|
|
110
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
## listEtfWeights
|
|
114
|
+
|
|
115
|
+
> ListEtfWeights200Response listEtfWeights(etf, dimension, asOf, fields, limit, cursor)
|
|
116
|
+
|
|
117
|
+
List ETF sector, country and asset-class weights
|
|
118
|
+
|
|
119
|
+
Sector, country and asset-class weights of one US ETF, from the same composition `/v1/etf-holdings?etf=` answers from (`meta.source`, `meta.as_of`): sector = the issuer\'s stated sector, else the SEC SIC sector of the holding\'s issuer; country = the stated location, else the N-PORT country / ISIN prefix / registrant country (each bucket names its `basis`, `mixed` when its positions differ); weights in percent of the fund. `dimension=` one or several of sector, country, asset_class (default all). An ETF without buckets for the chosen source answers `data: []` with `meta.reason: weights_unavailable`; a single-asset trust `meta.reason: single_asset_trust`. Positions themselves: `/v1/etf-holdings`; filed N-PORT rows: `/v1/fund-holdings`.
|
|
120
|
+
|
|
121
|
+
### Example
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
import {
|
|
125
|
+
Configuration,
|
|
126
|
+
HoldingsApi,
|
|
127
|
+
} from '@invinite-org/data-api-client';
|
|
128
|
+
import type { ListEtfWeightsRequest } from '@invinite-org/data-api-client';
|
|
129
|
+
|
|
130
|
+
async function example() {
|
|
131
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
132
|
+
const config = new Configuration({
|
|
133
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
134
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
135
|
+
});
|
|
136
|
+
const api = new HoldingsApi(config);
|
|
137
|
+
|
|
138
|
+
const body = {
|
|
139
|
+
// string | ETF ticker
|
|
140
|
+
etf: SPY,
|
|
141
|
+
// string | sector, country or asset_class; a comma list for several (default all three) (optional)
|
|
142
|
+
dimension: sector,
|
|
143
|
+
// Date | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest (optional)
|
|
144
|
+
asOf: 2026-11-12,
|
|
145
|
+
// string | Comma list of root-level fields to keep (R7) (optional)
|
|
146
|
+
fields: fiscal_year,period_end,
|
|
147
|
+
// number | Rows per page (default 25, max 200) (optional)
|
|
148
|
+
limit: 25,
|
|
149
|
+
// string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
|
|
150
|
+
cursor: eyJ2IjoyfQ,
|
|
151
|
+
} satisfies ListEtfWeightsRequest;
|
|
152
|
+
|
|
153
|
+
try {
|
|
154
|
+
const data = await api.listEtfWeights(body);
|
|
155
|
+
console.log(data);
|
|
156
|
+
} catch (error) {
|
|
157
|
+
console.error(error);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
// Run the test
|
|
162
|
+
example().catch(console.error);
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Parameters
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
| Name | Type | Description | Notes |
|
|
169
|
+
|------------- | ------------- | ------------- | -------------|
|
|
170
|
+
| **etf** | `string` | ETF ticker | [Defaults to `undefined`] |
|
|
171
|
+
| **dimension** | `string` | sector, country or asset_class; a comma list for several (default all three) | [Optional] [Defaults to `undefined`] |
|
|
172
|
+
| **asOf** | `Date` | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest | [Optional] [Defaults to `undefined`] |
|
|
173
|
+
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
174
|
+
| **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
|
|
175
|
+
| **cursor** | `string` | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
|
|
176
|
+
|
|
177
|
+
### Return type
|
|
178
|
+
|
|
179
|
+
[**ListEtfWeights200Response**](ListEtfWeights200Response.md)
|
|
180
|
+
|
|
181
|
+
### Authorization
|
|
182
|
+
|
|
183
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
184
|
+
|
|
185
|
+
### HTTP request headers
|
|
186
|
+
|
|
187
|
+
- **Content-Type**: Not defined
|
|
188
|
+
- **Accept**: `application/json`, `application/problem+json`
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
### HTTP response details
|
|
192
|
+
| Status code | Description | Response headers |
|
|
193
|
+
|-------------|-------------|------------------|
|
|
194
|
+
| **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
|
|
195
|
+
| **304** | 304: the `If-None-Match` ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
|
|
196
|
+
| **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
|
|
197
|
+
| **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
|
|
198
|
+
| **402** | 402: insufficient_credits | * X-Request-Id - <br> |
|
|
199
|
+
| **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
|
|
200
|
+
| **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
|
|
201
|
+
| **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
|
|
202
|
+
| **500** | 500: internal | * X-Request-Id - <br> |
|
|
203
|
+
| **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
|
|
204
|
+
|
|
205
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
206
|
+
|
|
207
|
+
|
|
13
208
|
## listFundHoldings
|
|
14
209
|
|
|
15
210
|
> ListFundHoldings200Response listFundHoldings(company, filer, series, accession, periodEnd, sort, fields, limit, cursor)
|
|
16
211
|
|
|
17
212
|
List N-PORT fund holdings
|
|
18
213
|
|
|
19
|
-
N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
|
|
214
|
+
N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers. ETFs\' current composition (daily issuer files, falling back to N-PORT): `/v1/etf-holdings`.
|
|
20
215
|
|
|
21
216
|
### Example
|
|
22
217
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# ListEtfHoldings200Response
|
|
3
|
+
|
|
4
|
+
A page of EtfHolding rows (the list envelope, R3)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`data` | [Array<EtfHolding>](EtfHolding.md)
|
|
11
|
+
`has_more` | boolean
|
|
12
|
+
`next_cursor` | string
|
|
13
|
+
`meta` | [ListEtfHoldings200ResponseMeta](ListEtfHoldings200ResponseMeta.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ListEtfHoldings200Response } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"data": null,
|
|
23
|
+
"has_more": null,
|
|
24
|
+
"next_cursor": null,
|
|
25
|
+
"meta": null,
|
|
26
|
+
} satisfies ListEtfHoldings200Response
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200Response
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
|
|
2
|
+
# ListEtfHoldings200ResponseMeta
|
|
3
|
+
|
|
4
|
+
Page metadata
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`coverage` | [MetaCoverage](MetaCoverage.md)
|
|
11
|
+
`source` | string
|
|
12
|
+
`as_of` | Date
|
|
13
|
+
`reason` | string
|
|
14
|
+
`composition` | [ListEtfHoldings200ResponseMetaComposition](ListEtfHoldings200ResponseMetaComposition.md)
|
|
15
|
+
`issuer_sourced_etfs` | number
|
|
16
|
+
`snapshot_changed` | boolean
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { ListEtfHoldings200ResponseMeta } from '@invinite-org/data-api-client'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"coverage": null,
|
|
26
|
+
"source": null,
|
|
27
|
+
"as_of": null,
|
|
28
|
+
"reason": null,
|
|
29
|
+
"composition": null,
|
|
30
|
+
"issuer_sourced_etfs": null,
|
|
31
|
+
"snapshot_changed": null,
|
|
32
|
+
} satisfies ListEtfHoldings200ResponseMeta
|
|
33
|
+
|
|
34
|
+
console.log(example)
|
|
35
|
+
|
|
36
|
+
// Convert the instance to a JSON string
|
|
37
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
38
|
+
console.log(exampleJSON)
|
|
39
|
+
|
|
40
|
+
// Parse the JSON string back to an object
|
|
41
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200ResponseMeta
|
|
42
|
+
console.log(exampleParsed)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
46
|
+
|
|
47
|
+
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
|
|
2
|
+
# ListEtfHoldings200ResponseMetaComposition
|
|
3
|
+
|
|
4
|
+
What the store holds for the ETF (etf=); null with company=
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`newest_issuer_as_of` | Date
|
|
11
|
+
`nport_report_date` | Date
|
|
12
|
+
`stored_from` | Date
|
|
13
|
+
`stored_to` | Date
|
|
14
|
+
`stored_dates` | [Array<ListEtfHoldings200ResponseMetaCompositionStoredDatesInner>](ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.md)
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { ListEtfHoldings200ResponseMetaComposition } from '@invinite-org/data-api-client'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"newest_issuer_as_of": null,
|
|
24
|
+
"nport_report_date": null,
|
|
25
|
+
"stored_from": null,
|
|
26
|
+
"stored_to": null,
|
|
27
|
+
"stored_dates": null,
|
|
28
|
+
} satisfies ListEtfHoldings200ResponseMetaComposition
|
|
29
|
+
|
|
30
|
+
console.log(example)
|
|
31
|
+
|
|
32
|
+
// Convert the instance to a JSON string
|
|
33
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
34
|
+
console.log(exampleJSON)
|
|
35
|
+
|
|
36
|
+
// Parse the JSON string back to an object
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200ResponseMetaComposition
|
|
38
|
+
console.log(exampleParsed)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
42
|
+
|
|
43
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
3
|
+
|
|
4
|
+
One stored composition date of the ETF
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`as_of` | Date
|
|
11
|
+
`source` | string
|
|
12
|
+
`status` | string
|
|
13
|
+
`positions_count` | number
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ListEtfHoldings200ResponseMetaCompositionStoredDatesInner } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"as_of": null,
|
|
23
|
+
"source": null,
|
|
24
|
+
"status": null,
|
|
25
|
+
"positions_count": null,
|
|
26
|
+
} satisfies ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# ListEtfWeights200Response
|
|
3
|
+
|
|
4
|
+
A page of EtfWeight rows (the list envelope, R3)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`data` | [Array<EtfWeight>](EtfWeight.md)
|
|
11
|
+
`has_more` | boolean
|
|
12
|
+
`next_cursor` | string
|
|
13
|
+
`meta` | [ListEtfWeights200ResponseMeta](ListEtfWeights200ResponseMeta.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ListEtfWeights200Response } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"data": null,
|
|
23
|
+
"has_more": null,
|
|
24
|
+
"next_cursor": null,
|
|
25
|
+
"meta": null,
|
|
26
|
+
} satisfies ListEtfWeights200Response
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListEtfWeights200Response
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
|
|
2
|
+
# ListEtfWeights200ResponseMeta
|
|
3
|
+
|
|
4
|
+
Page metadata
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`coverage` | [MetaCoverage](MetaCoverage.md)
|
|
11
|
+
`source` | string
|
|
12
|
+
`as_of` | Date
|
|
13
|
+
`reason` | string
|
|
14
|
+
`weight_pct_sum` | number
|
|
15
|
+
`weight_basis` | string
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { ListEtfWeights200ResponseMeta } from '@invinite-org/data-api-client'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"coverage": null,
|
|
25
|
+
"source": null,
|
|
26
|
+
"as_of": null,
|
|
27
|
+
"reason": null,
|
|
28
|
+
"weight_pct_sum": null,
|
|
29
|
+
"weight_basis": null,
|
|
30
|
+
} satisfies ListEtfWeights200ResponseMeta
|
|
31
|
+
|
|
32
|
+
console.log(example)
|
|
33
|
+
|
|
34
|
+
// Convert the instance to a JSON string
|
|
35
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
36
|
+
console.log(exampleJSON)
|
|
37
|
+
|
|
38
|
+
// Parse the JSON string back to an object
|
|
39
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListEtfWeights200ResponseMeta
|
|
40
|
+
console.log(exampleParsed)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
44
|
+
|
|
45
|
+
|