@invinite-org/data-api-client 0.1.0 → 0.1.1

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.
@@ -35,7 +35,7 @@ async function example() {
35
35
 
36
36
  const body = {
37
37
  // 7 | 30 | 90 | Window in UTC days ending today (inclusive): 7, 30 or 90 (optional)
38
- days: 56,
38
+ days: 30,
39
39
  } satisfies AccountUsageRequest;
40
40
 
41
41
  try {
@@ -37,15 +37,15 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Ticker symbol or CIK
40
- identifier: identifier_example,
40
+ identifier: AAPL,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
44
- sort: sort_example,
44
+ sort: desc,
45
45
  // number | Maximum number of periods per ticker (optional)
46
- limit: 56,
46
+ limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
- offset: 56,
48
+ offset: 0,
49
49
  } satisfies AsReportedBalanceSheetRequest;
50
50
 
51
51
  try {
@@ -124,17 +124,17 @@ async function example() {
124
124
 
125
125
  const body = {
126
126
  // string | Ticker symbol or CIK
127
- identifier: identifier_example,
127
+ identifier: AAPL,
128
128
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
129
- fiscalPeriodType: fiscalPeriodType_example,
129
+ fiscalPeriodType: annual,
130
130
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
131
- sort: sort_example,
131
+ sort: desc,
132
132
  // number | Maximum number of periods per ticker (optional)
133
- limit: 56,
133
+ limit: 5,
134
134
  // number | Number of periods to skip for pagination (optional)
135
- offset: 56,
135
+ offset: 0,
136
136
  // 'true' | 'false' | Include formula in response (optional)
137
- withFormula: withFormula_example,
137
+ withFormula: true,
138
138
  } satisfies AsReportedBalanceSheetDetailedRequest;
139
139
 
140
140
  try {
@@ -214,15 +214,15 @@ async function example() {
214
214
 
215
215
  const body = {
216
216
  // string | Ticker symbol or CIK
217
- identifier: identifier_example,
217
+ identifier: AAPL,
218
218
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
219
- fiscalPeriodType: fiscalPeriodType_example,
219
+ fiscalPeriodType: annual,
220
220
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
221
- sort: sort_example,
221
+ sort: desc,
222
222
  // number | Maximum number of periods per ticker (optional)
223
- limit: 56,
223
+ limit: 5,
224
224
  // number | Number of periods to skip for pagination (optional)
225
- offset: 56,
225
+ offset: 0,
226
226
  } satisfies AsReportedBalanceSheetPresentationRequest;
227
227
 
228
228
  try {
@@ -37,15 +37,15 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Ticker symbol or CIK
40
- identifier: identifier_example,
40
+ identifier: AAPL,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
44
- sort: sort_example,
44
+ sort: desc,
45
45
  // number | Maximum number of periods per ticker (optional)
46
- limit: 56,
46
+ limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
- offset: 56,
48
+ offset: 0,
49
49
  } satisfies AsReportedCashFlowStatementRequest;
50
50
 
51
51
  try {
@@ -124,17 +124,17 @@ async function example() {
124
124
 
125
125
  const body = {
126
126
  // string | Ticker symbol or CIK
127
- identifier: identifier_example,
127
+ identifier: AAPL,
128
128
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
129
- fiscalPeriodType: fiscalPeriodType_example,
129
+ fiscalPeriodType: annual,
130
130
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
131
- sort: sort_example,
131
+ sort: desc,
132
132
  // number | Maximum number of periods per ticker (optional)
133
- limit: 56,
133
+ limit: 5,
134
134
  // number | Number of periods to skip for pagination (optional)
135
- offset: 56,
135
+ offset: 0,
136
136
  // 'true' | 'false' | Include formula in response (optional)
137
- withFormula: withFormula_example,
137
+ withFormula: true,
138
138
  } satisfies AsReportedCashFlowStatementDetailedRequest;
139
139
 
140
140
  try {
@@ -214,15 +214,15 @@ async function example() {
214
214
 
215
215
  const body = {
216
216
  // string | Ticker symbol or CIK
217
- identifier: identifier_example,
217
+ identifier: AAPL,
218
218
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
219
- fiscalPeriodType: fiscalPeriodType_example,
219
+ fiscalPeriodType: annual,
220
220
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
221
- sort: sort_example,
221
+ sort: desc,
222
222
  // number | Maximum number of periods per ticker (optional)
223
- limit: 56,
223
+ limit: 5,
224
224
  // number | Number of periods to skip for pagination (optional)
225
- offset: 56,
225
+ offset: 0,
226
226
  } satisfies AsReportedCashFlowStatementPresentationRequest;
227
227
 
228
228
  try {
@@ -37,15 +37,15 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Ticker symbol or CIK
40
- identifier: identifier_example,
40
+ identifier: AAPL,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
44
- sort: sort_example,
44
+ sort: desc,
45
45
  // number | Maximum number of periods per ticker (optional)
46
- limit: 56,
46
+ limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
- offset: 56,
48
+ offset: 0,
49
49
  } satisfies AsReportedIncomeStatementRequest;
50
50
 
51
51
  try {
@@ -124,17 +124,17 @@ async function example() {
124
124
 
125
125
  const body = {
126
126
  // string | Ticker symbol or CIK
127
- identifier: identifier_example,
127
+ identifier: AAPL,
128
128
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
129
- fiscalPeriodType: fiscalPeriodType_example,
129
+ fiscalPeriodType: annual,
130
130
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
131
- sort: sort_example,
131
+ sort: desc,
132
132
  // number | Maximum number of periods per ticker (optional)
133
- limit: 56,
133
+ limit: 5,
134
134
  // number | Number of periods to skip for pagination (optional)
135
- offset: 56,
135
+ offset: 0,
136
136
  // 'true' | 'false' | Include formula in response (optional)
137
- withFormula: withFormula_example,
137
+ withFormula: true,
138
138
  } satisfies AsReportedIncomeStatementDetailedRequest;
139
139
 
140
140
  try {
@@ -214,15 +214,15 @@ async function example() {
214
214
 
215
215
  const body = {
216
216
  // string | Ticker symbol or CIK
217
- identifier: identifier_example,
217
+ identifier: AAPL,
218
218
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
219
- fiscalPeriodType: fiscalPeriodType_example,
219
+ fiscalPeriodType: annual,
220
220
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
221
- sort: sort_example,
221
+ sort: desc,
222
222
  // number | Maximum number of periods per ticker (optional)
223
- limit: 56,
223
+ limit: 5,
224
224
  // number | Number of periods to skip for pagination (optional)
225
- offset: 56,
225
+ offset: 0,
226
226
  } satisfies AsReportedIncomeStatementPresentationRequest;
227
227
 
228
228
  try {
@@ -37,13 +37,13 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
40
- identifiers: identifiers_example,
40
+ identifiers: AAPL,MSFT,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
44
- calendarYear: 56,
44
+ calendarYear: 2024,
45
45
  // number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
46
- calendarQuarter: 56,
46
+ calendarQuarter: 4,
47
47
  } satisfies AsReportedSnapshotRequest;
48
48
 
49
49
  try {
@@ -121,15 +121,15 @@ async function example() {
121
121
 
122
122
  const body = {
123
123
  // string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
124
- identifiers: identifiers_example,
124
+ identifiers: AAPL,MSFT,
125
125
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
126
- fiscalPeriodType: fiscalPeriodType_example,
126
+ fiscalPeriodType: annual,
127
127
  // number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
128
- calendarYear: 56,
128
+ calendarYear: 2024,
129
129
  // number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
130
- calendarQuarter: 56,
130
+ calendarQuarter: 4,
131
131
  // 'true' | 'false' | Include formula in response (optional)
132
- withFormula: withFormula_example,
132
+ withFormula: true,
133
133
  } satisfies AsReportedSnapshotDetailedRequest;
134
134
 
135
135
  try {
@@ -208,13 +208,13 @@ async function example() {
208
208
 
209
209
  const body = {
210
210
  // string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
211
- identifiers: identifiers_example,
211
+ identifiers: AAPL,MSFT,
212
212
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
213
- fiscalPeriodType: fiscalPeriodType_example,
213
+ fiscalPeriodType: annual,
214
214
  // number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
215
- calendarYear: 56,
215
+ calendarYear: 2024,
216
216
  // number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
217
- calendarQuarter: 56,
217
+ calendarQuarter: 4,
218
218
  } satisfies AsReportedSnapshotPresentationRequest;
219
219
 
220
220
  try {
@@ -105,7 +105,7 @@ async function example() {
105
105
 
106
106
  const body = {
107
107
  // string | Ticker symbol or CIK
108
- identifier: identifier_example,
108
+ identifier: AAPL,
109
109
  } satisfies CompanyDetailsRequest;
110
110
 
111
111
  try {
@@ -180,17 +180,17 @@ async function example() {
180
180
 
181
181
  const body = {
182
182
  // string | Ticker symbol or CIK
183
- identifier: identifier_example,
183
+ identifier: AAPL,
184
184
  // Date | Filter dividends with ex_dividend_date on or after this date (YYYY-MM-DD) (optional)
185
- startDate: 2013-10-20,
185
+ startDate: 2025-01-01,
186
186
  // Date | Filter dividends with ex_dividend_date on or before this date (YYYY-MM-DD) (optional)
187
- endDate: 2013-10-20,
187
+ endDate: 2025-12-31,
188
188
  // 'asc' | 'desc' | Sort direction for dividends by ex_dividend_date (optional)
189
- sort: sort_example,
189
+ sort: desc,
190
190
  // number | Maximum number of dividends to return (optional)
191
- limit: 56,
191
+ limit: 5,
192
192
  // number | Number of dividends to skip for pagination (optional)
193
- offset: 56,
193
+ offset: 0,
194
194
  } satisfies CompanyDividendsRequest;
195
195
 
196
196
  try {
@@ -270,13 +270,13 @@ async function example() {
270
270
 
271
271
  const body = {
272
272
  // string | Ticker symbol or CIK
273
- identifier: identifier_example,
273
+ identifier: AAPL,
274
274
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
275
- sort: sort_example,
275
+ sort: desc,
276
276
  // number | Maximum number of periods per company (optional)
277
- limit: 56,
277
+ limit: 5,
278
278
  // number | Number of periods to skip for pagination (optional)
279
- offset: 56,
279
+ offset: 0,
280
280
  } satisfies CompanyFiscalPeriodsRequest;
281
281
 
282
282
  try {
@@ -354,11 +354,11 @@ async function example() {
354
354
 
355
355
  const body = {
356
356
  // string | Search text to match against ticker (prefix) or name (contains)
357
- query: query_example,
357
+ query: apple,
358
358
  // number | Maximum number of companies to return (optional)
359
- limit: 56,
359
+ limit: 5,
360
360
  // number | Pagination offset (optional)
361
- offset: 56,
361
+ offset: 0,
362
362
  } satisfies CompanySearchRequest;
363
363
 
364
364
  try {
@@ -434,13 +434,13 @@ async function example() {
434
434
 
435
435
  const body = {
436
436
  // string | Ticker symbol or CIK
437
- identifier: identifier_example,
437
+ identifier: AAPL,
438
438
  // 'asc' | 'desc' | Sort direction for splits by execution_date (optional)
439
- sort: sort_example,
439
+ sort: desc,
440
440
  // number | Maximum number of splits to return (optional)
441
- limit: 56,
441
+ limit: 5,
442
442
  // number | Number of splits to skip for pagination (optional)
443
- offset: 56,
443
+ offset: 0,
444
444
  } satisfies CompanySplitsRequest;
445
445
 
446
446
  try {