@invinite-org/data-api-client 0.1.0 → 0.2.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 +0 -1
- package/dist/apis/EarningsCallsApi.d.ts +20 -6
- package/dist/apis/EarningsCallsApi.js +34 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +20 -6
- package/dist/esm/apis/EarningsCallsApi.js +33 -6
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +46 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +25 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +25 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +47 -3
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +26 -1
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +26 -1
- package/docs/AccountApi.md +1 -1
- package/docs/AsReportedBalanceSheetApi.md +16 -16
- package/docs/AsReportedCashFlowStatementApi.md +16 -16
- package/docs/AsReportedIncomeStatementApi.md +16 -16
- package/docs/AsReportedSnapshotApi.md +13 -13
- package/docs/CompanyApi.md +18 -18
- package/docs/EarningsCallsApi.md +210 -189
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +8 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +6 -0
- package/docs/FinancialMetricsApi.md +17 -17
- package/docs/IPOsApi.md +5 -5
- package/docs/InsiderTradesApi.md +7 -7
- package/docs/InstitutionalOwnershipApi.md +23 -23
- package/docs/MarketApi.md +3 -3
- package/docs/SECFilingsApi.md +15 -15
- package/docs/SegmentedFinancialsApi.md +12 -12
- package/docs/StandardizedBalanceSheetApi.md +16 -16
- package/docs/StandardizedCashFlowStatementApi.md +16 -16
- package/docs/StandardizedIncomeStatementApi.md +16 -16
- package/docs/StandardizedSnapshotApi.md +13 -13
- package/package.json +4 -4
- package/src/apis/EarningsCallsApi.ts +48 -6
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +75 -7
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +42 -0
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +42 -0
|
@@ -7,10 +7,14 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`document_id` | string
|
|
10
|
+
`source` | string
|
|
10
11
|
`section` | string
|
|
11
12
|
`kind` | string
|
|
12
13
|
`year` | number
|
|
13
14
|
`period` | string
|
|
15
|
+
`group` | string
|
|
16
|
+
`group_label` | string
|
|
17
|
+
`category` | string
|
|
14
18
|
`event_id` | string
|
|
15
19
|
`event_type` | string
|
|
16
20
|
`event_date` | Date
|
|
@@ -41,10 +45,14 @@ import type { EarningsCallsCompanyDocuments200ResponseDocumentsInner } from '@in
|
|
|
41
45
|
// TODO: Update the object below with actual values
|
|
42
46
|
const example = {
|
|
43
47
|
"document_id": null,
|
|
48
|
+
"source": null,
|
|
44
49
|
"section": null,
|
|
45
50
|
"kind": null,
|
|
46
51
|
"year": null,
|
|
47
52
|
"period": null,
|
|
53
|
+
"group": null,
|
|
54
|
+
"group_label": null,
|
|
55
|
+
"category": null,
|
|
48
56
|
"event_id": null,
|
|
49
57
|
"event_type": null,
|
|
50
58
|
"event_date": null,
|
|
@@ -20,6 +20,9 @@ Name | Type
|
|
|
20
20
|
`heading` | string
|
|
21
21
|
`text` | string
|
|
22
22
|
`title` | string
|
|
23
|
+
`group` | string
|
|
24
|
+
`group_label` | string
|
|
25
|
+
`category` | string
|
|
23
26
|
`url` | string
|
|
24
27
|
`expires_at` | Date
|
|
25
28
|
|
|
@@ -44,6 +47,9 @@ const example = {
|
|
|
44
47
|
"heading": null,
|
|
45
48
|
"text": null,
|
|
46
49
|
"title": null,
|
|
50
|
+
"group": null,
|
|
51
|
+
"group_label": null,
|
|
52
|
+
"category": null,
|
|
47
53
|
"url": null,
|
|
48
54
|
"expires_at": null,
|
|
49
55
|
} satisfies EarningsCallsDocumentSearch200ResponseHitsInner
|
|
@@ -21,6 +21,9 @@ Name | Type
|
|
|
21
21
|
`bytes` | number
|
|
22
22
|
`pages` | number
|
|
23
23
|
`trust_tier` | string
|
|
24
|
+
`group` | string
|
|
25
|
+
`group_label` | string
|
|
26
|
+
`category` | string
|
|
24
27
|
`body_text` | string
|
|
25
28
|
|
|
26
29
|
## Example
|
|
@@ -45,6 +48,9 @@ const example = {
|
|
|
45
48
|
"bytes": null,
|
|
46
49
|
"pages": null,
|
|
47
50
|
"trust_tier": null,
|
|
51
|
+
"group": null,
|
|
52
|
+
"group_label": null,
|
|
53
|
+
"category": null,
|
|
48
54
|
"body_text": null,
|
|
49
55
|
} satisfies EarningsCallsDocuments200ResponseDocumentsInner
|
|
50
56
|
|
|
@@ -37,15 +37,15 @@ async function example() {
|
|
|
37
37
|
|
|
38
38
|
const body = {
|
|
39
39
|
// string | Ticker symbol or CIK
|
|
40
|
-
identifier:
|
|
40
|
+
identifier: AAPL,
|
|
41
41
|
// '3' | '5' | '10' | CAGR calculation period in years: 3, 5, 10 (optional)
|
|
42
|
-
periodYears:
|
|
42
|
+
periodYears: 5,
|
|
43
43
|
// 'asc' | 'desc' | Sort direction for periods by period_end: \'asc\' (oldest first), \'desc\' (newest first) (optional)
|
|
44
|
-
sort:
|
|
44
|
+
sort: desc,
|
|
45
45
|
// number | Maximum number of periods per ticker (1-100) (optional)
|
|
46
|
-
limit:
|
|
46
|
+
limit: 5,
|
|
47
47
|
// number | Number of periods to skip for pagination (optional)
|
|
48
|
-
offset:
|
|
48
|
+
offset: 0,
|
|
49
49
|
} satisfies FinancialMetricsCagrRequest;
|
|
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:
|
|
127
|
+
identifier: AAPL,
|
|
128
128
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period: \'quarterly\' (Q1-Q4), \'annual\' (full year), \'ytd\' (year-to-date), \'ttm\' (trailing twelve months)
|
|
129
|
-
fiscalPeriodType:
|
|
129
|
+
fiscalPeriodType: annual,
|
|
130
130
|
// 'year_over_year' | 'quarter_over_quarter' | Filter by growth type: year_over_year, quarter_over_quarter (optional)
|
|
131
|
-
growthType:
|
|
131
|
+
growthType: year_over_year,
|
|
132
132
|
// 'asc' | 'desc' | Sort direction for periods by period_end: \'asc\' (oldest first), \'desc\' (newest first) (optional)
|
|
133
|
-
sort:
|
|
133
|
+
sort: desc,
|
|
134
134
|
// number | Maximum number of periods per ticker (1-100) (optional)
|
|
135
|
-
limit:
|
|
135
|
+
limit: 5,
|
|
136
136
|
// number | Number of periods to skip for pagination (optional)
|
|
137
|
-
offset:
|
|
137
|
+
offset: 0,
|
|
138
138
|
} satisfies FinancialMetricsGrowthRequest;
|
|
139
139
|
|
|
140
140
|
try {
|
|
@@ -214,17 +214,17 @@ async function example() {
|
|
|
214
214
|
|
|
215
215
|
const body = {
|
|
216
216
|
// string | Ticker symbol or CIK
|
|
217
|
-
identifier:
|
|
217
|
+
identifier: AAPL,
|
|
218
218
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period: \'quarterly\' (Q1-Q4), \'annual\' (full year), \'ytd\' (year-to-date), \'ttm\' (trailing twelve months)
|
|
219
|
-
fiscalPeriodType:
|
|
219
|
+
fiscalPeriodType: annual,
|
|
220
220
|
// 'valuation' | 'profitability' | 'liquidity' | 'solvency' | Filter by ratio category: valuation, profitability, liquidity, solvency (optional)
|
|
221
|
-
category:
|
|
221
|
+
category: profitability,
|
|
222
222
|
// 'asc' | 'desc' | Sort direction for periods by period_end: \'asc\' (oldest first), \'desc\' (newest first) (optional)
|
|
223
|
-
sort:
|
|
223
|
+
sort: desc,
|
|
224
224
|
// number | Maximum number of periods per ticker (1-100) (optional)
|
|
225
|
-
limit:
|
|
225
|
+
limit: 5,
|
|
226
226
|
// number | Number of periods to skip for pagination (optional)
|
|
227
|
-
offset:
|
|
227
|
+
offset: 0,
|
|
228
228
|
} satisfies FinancialMetricsRatiosRequest;
|
|
229
229
|
|
|
230
230
|
try {
|
package/docs/IPOsApi.md
CHANGED
|
@@ -35,15 +35,15 @@ async function example() {
|
|
|
35
35
|
|
|
36
36
|
const body = {
|
|
37
37
|
// Date | Filter IPOs with listing_date on or after this date (YYYY-MM-DD) (optional)
|
|
38
|
-
startDate:
|
|
38
|
+
startDate: 2025-01-01,
|
|
39
39
|
// Date | Filter IPOs with listing_date on or before this date (YYYY-MM-DD) (optional)
|
|
40
|
-
endDate:
|
|
40
|
+
endDate: 2025-12-31,
|
|
41
41
|
// 'asc' | 'desc' | Sort direction for IPOs by listing_date (optional)
|
|
42
|
-
sort:
|
|
42
|
+
sort: desc,
|
|
43
43
|
// number | Maximum number of IPOs to return (optional)
|
|
44
|
-
limit:
|
|
44
|
+
limit: 5,
|
|
45
45
|
// number | Number of IPOs to skip for pagination (optional)
|
|
46
|
-
offset:
|
|
46
|
+
offset: 0,
|
|
47
47
|
} satisfies IposListRequest;
|
|
48
48
|
|
|
49
49
|
try {
|
package/docs/InsiderTradesApi.md
CHANGED
|
@@ -35,19 +35,19 @@ async function example() {
|
|
|
35
35
|
|
|
36
36
|
const body = {
|
|
37
37
|
// string | Company ticker symbol or CIK
|
|
38
|
-
identifier:
|
|
38
|
+
identifier: AAPL,
|
|
39
39
|
// Date | Filter transactions filed on or after this date (YYYY-MM-DD) (optional)
|
|
40
|
-
startDate:
|
|
40
|
+
startDate: 2025-01-01,
|
|
41
41
|
// Date | Filter transactions filed on or before this date (YYYY-MM-DD) (optional)
|
|
42
|
-
endDate:
|
|
42
|
+
endDate: 2025-12-31,
|
|
43
43
|
// 'A' | 'D' | Filter by acquisition (A) or disposition (D) (optional)
|
|
44
|
-
acquiredDisposed:
|
|
44
|
+
acquiredDisposed: D,
|
|
45
45
|
// 'asc' | 'desc' | Sort direction by filed_at date (optional)
|
|
46
|
-
sort:
|
|
46
|
+
sort: desc,
|
|
47
47
|
// number | Maximum number of transactions to return (optional)
|
|
48
|
-
limit:
|
|
48
|
+
limit: 5,
|
|
49
49
|
// number | Number of transactions to skip for pagination (optional)
|
|
50
|
-
offset:
|
|
50
|
+
offset: 0,
|
|
51
51
|
} satisfies InsiderTradesListRequest;
|
|
52
52
|
|
|
53
53
|
try {
|
|
@@ -38,15 +38,15 @@ async function example() {
|
|
|
38
38
|
|
|
39
39
|
const body = {
|
|
40
40
|
// string | Company ticker symbol or CIK
|
|
41
|
-
identifier:
|
|
41
|
+
identifier: AAPL,
|
|
42
42
|
// number | Minimum dollar value filter (optional)
|
|
43
|
-
minValue:
|
|
43
|
+
minValue: 1000000000,
|
|
44
44
|
// 'asc' | 'desc' | Sort direction by dollar_value (optional)
|
|
45
|
-
sort:
|
|
45
|
+
sort: desc,
|
|
46
46
|
// number | Maximum number of holdings to return (optional)
|
|
47
|
-
limit:
|
|
47
|
+
limit: 5,
|
|
48
48
|
// number | Number of holdings to skip for pagination (optional)
|
|
49
|
-
offset:
|
|
49
|
+
offset: 0,
|
|
50
50
|
} satisfies InstitutionalOwnershipHoldingsByCompanyRequest;
|
|
51
51
|
|
|
52
52
|
try {
|
|
@@ -125,13 +125,13 @@ async function example() {
|
|
|
125
125
|
|
|
126
126
|
const body = {
|
|
127
127
|
// string | Institution CIK
|
|
128
|
-
cik:
|
|
128
|
+
cik: 1067983,
|
|
129
129
|
// 'asc' | 'desc' | Sort direction by dollar_value (optional)
|
|
130
|
-
sort:
|
|
130
|
+
sort: desc,
|
|
131
131
|
// number | Maximum number of holdings to return (optional)
|
|
132
|
-
limit:
|
|
132
|
+
limit: 5,
|
|
133
133
|
// number | Number of holdings to skip for pagination (optional)
|
|
134
|
-
offset:
|
|
134
|
+
offset: 0,
|
|
135
135
|
} satisfies InstitutionalOwnershipHoldingsByInvestorRequest;
|
|
136
136
|
|
|
137
137
|
try {
|
|
@@ -209,13 +209,13 @@ async function example() {
|
|
|
209
209
|
|
|
210
210
|
const body = {
|
|
211
211
|
// string | Comma-separated list of CIKs (Central Index Keys) (optional)
|
|
212
|
-
ciks:
|
|
212
|
+
ciks: 1067983,102909,
|
|
213
213
|
// number | Maximum number of institutions to return (optional)
|
|
214
|
-
limit:
|
|
214
|
+
limit: 5,
|
|
215
215
|
// number | Pagination offset (optional)
|
|
216
|
-
offset:
|
|
216
|
+
offset: 0,
|
|
217
217
|
// 'asc' | 'desc' | Sort direction for institutions by name (optional)
|
|
218
|
-
sort:
|
|
218
|
+
sort: desc,
|
|
219
219
|
} satisfies InstitutionalOwnershipInstitutionsRequest;
|
|
220
220
|
|
|
221
221
|
try {
|
|
@@ -292,25 +292,25 @@ async function example() {
|
|
|
292
292
|
|
|
293
293
|
const body = {
|
|
294
294
|
// string | Institution CIK (at least one of cik or identifier required) (optional)
|
|
295
|
-
cik:
|
|
295
|
+
cik: 1067983,
|
|
296
296
|
// string | Company ticker symbol or CIK (at least one of cik or identifier required) (optional)
|
|
297
|
-
identifier:
|
|
297
|
+
identifier: AAPL,
|
|
298
298
|
// Date | Filter transactions with period_end_new on or after this date (YYYY-MM-DD) (optional)
|
|
299
|
-
startDate:
|
|
299
|
+
startDate: 2025-01-01,
|
|
300
300
|
// Date | Filter transactions with period_end_new on or before this date (YYYY-MM-DD) (optional)
|
|
301
|
-
endDate:
|
|
301
|
+
endDate: 2025-12-31,
|
|
302
302
|
// 'new_buy' | 'added' | 'reduced' | 'sold_out' | Filter by transaction type: new_buy, added, reduced, sold_out (optional)
|
|
303
|
-
type:
|
|
303
|
+
type: new_buy,
|
|
304
304
|
// number | Filter by calendar year (of new position) (optional)
|
|
305
|
-
calendarYear:
|
|
305
|
+
calendarYear: 2025,
|
|
306
306
|
// number | Filter by calendar quarter (of new position) (optional)
|
|
307
|
-
calendarQuarter:
|
|
307
|
+
calendarQuarter: 1,
|
|
308
308
|
// 'asc' | 'desc' | Sort direction by period_end_new: \'asc\' (oldest first), \'desc\' (newest first) (optional)
|
|
309
|
-
sort:
|
|
309
|
+
sort: desc,
|
|
310
310
|
// number | Maximum number of transactions to return (1-1000) (optional)
|
|
311
|
-
limit:
|
|
311
|
+
limit: 5,
|
|
312
312
|
// number | Number of transactions to skip for pagination (optional)
|
|
313
|
-
offset:
|
|
313
|
+
offset: 0,
|
|
314
314
|
} satisfies InstitutionalOwnershipTransactionsRequest;
|
|
315
315
|
|
|
316
316
|
try {
|
package/docs/MarketApi.md
CHANGED
|
@@ -35,11 +35,11 @@ async function example() {
|
|
|
35
35
|
|
|
36
36
|
const body = {
|
|
37
37
|
// 'asc' | 'desc' | Sort direction for holidays by date (optional)
|
|
38
|
-
sort:
|
|
38
|
+
sort: desc,
|
|
39
39
|
// number | Maximum number of holidays to return (optional)
|
|
40
|
-
limit:
|
|
40
|
+
limit: 5,
|
|
41
41
|
// number | Number of holidays to skip for pagination (optional)
|
|
42
|
-
offset:
|
|
42
|
+
offset: 0,
|
|
43
43
|
} satisfies MarketHolidaysRequest;
|
|
44
44
|
|
|
45
45
|
try {
|
package/docs/SECFilingsApi.md
CHANGED
|
@@ -38,7 +38,7 @@ async function example() {
|
|
|
38
38
|
|
|
39
39
|
const body = {
|
|
40
40
|
// string | Optional ticker symbol or CIK. If omitted, returns form types across all filings. (optional)
|
|
41
|
-
identifier:
|
|
41
|
+
identifier: AAPL,
|
|
42
42
|
} satisfies SecFilingsAvailableFormTypesRequest;
|
|
43
43
|
|
|
44
44
|
try {
|
|
@@ -113,15 +113,15 @@ async function example() {
|
|
|
113
113
|
|
|
114
114
|
const body = {
|
|
115
115
|
// string | Ticker symbol or CIK
|
|
116
|
-
identifier:
|
|
116
|
+
identifier: AAPL,
|
|
117
117
|
// string | SEC form type filter (e.g., 10-K, 10-Q, 8-K, 3, 4, 5, 13F-HR). Leave empty to return all form types. (optional)
|
|
118
|
-
formType:
|
|
118
|
+
formType: 10-K,
|
|
119
119
|
// 'asc' | 'desc' | Sort direction for filings by filing_date (optional)
|
|
120
|
-
sort:
|
|
120
|
+
sort: desc,
|
|
121
121
|
// number | Maximum number of filings to return (optional)
|
|
122
|
-
limit:
|
|
122
|
+
limit: 5,
|
|
123
123
|
// number | Number of filings to skip for pagination (optional)
|
|
124
|
-
offset:
|
|
124
|
+
offset: 0,
|
|
125
125
|
} satisfies SecFilingsListRequest;
|
|
126
126
|
|
|
127
127
|
try {
|
|
@@ -200,11 +200,11 @@ async function example() {
|
|
|
200
200
|
|
|
201
201
|
const body = {
|
|
202
202
|
// string | Natural language search request for SEC filing information (e.g., \'What are Apple\'s main risk factors?\')
|
|
203
|
-
request:
|
|
203
|
+
request: What are Apple's main risk factors?,
|
|
204
204
|
// string | Ticker symbol or CIK to filter search results to a specific company (optional)
|
|
205
|
-
identifier:
|
|
205
|
+
identifier: AAPL,
|
|
206
206
|
// string | Accession number to filter search results to a specific filing (optional)
|
|
207
|
-
accessionNumber:
|
|
207
|
+
accessionNumber: 0000320193-25-000079,
|
|
208
208
|
} satisfies SecFilingsSearchRequest;
|
|
209
209
|
|
|
210
210
|
try {
|
|
@@ -280,17 +280,17 @@ async function example() {
|
|
|
280
280
|
|
|
281
281
|
const body = {
|
|
282
282
|
// string | Ticker symbol or CIK
|
|
283
|
-
identifier:
|
|
283
|
+
identifier: AAPL,
|
|
284
284
|
// '10-Q' | '10-K' | '8-K' | SEC form type. Filter requirements vary: 8-K requires accession_number; 10-K requires accession_number or fiscal_year; 10-Q requires accession_number or fiscal_year+fiscal_quarter.
|
|
285
|
-
formType:
|
|
285
|
+
formType: 10-K,
|
|
286
286
|
// string | Optional section ID. If not specified, all sections from the filing are returned. (optional)
|
|
287
|
-
sectionId:
|
|
287
|
+
sectionId: part_i-item_1a,
|
|
288
288
|
// string | SEC accession number of the filing (optional)
|
|
289
|
-
accessionNumber:
|
|
289
|
+
accessionNumber: 0000320193-25-000079,
|
|
290
290
|
// number | Fiscal year (optional)
|
|
291
|
-
fiscalYear:
|
|
291
|
+
fiscalYear: 2025,
|
|
292
292
|
// number | Fiscal quarter (1-4). Required for 10-Q when using fiscal_year filter. (optional)
|
|
293
|
-
fiscalQuarter:
|
|
293
|
+
fiscalQuarter: 4,
|
|
294
294
|
} satisfies SecFilingsSectionsRequest;
|
|
295
295
|
|
|
296
296
|
try {
|
|
@@ -36,17 +36,17 @@ async function example() {
|
|
|
36
36
|
|
|
37
37
|
const body = {
|
|
38
38
|
// string | Ticker symbol or CIK
|
|
39
|
-
identifier:
|
|
39
|
+
identifier: AAPL,
|
|
40
40
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period: \'quarterly\' (Q1-Q4), \'annual\' (full year), \'ytd\' (year-to-date), \'ttm\' (trailing twelve months)
|
|
41
|
-
fiscalPeriodType:
|
|
41
|
+
fiscalPeriodType: annual,
|
|
42
42
|
// 'seg_revenue_product' | 'seg_revenue_geographic' | 'seg_revenue_business_segment' | 'seg_cost_of_revenue_business_segment' | 'seg_research_and_development_expenses_business_segment' | 'seg_selling_and_marketing_expenses_business_segment' | 'seg_general_and_administrative_expenses_business_segment' | Filter by segment ID: seg_revenue_product, seg_revenue_geographic, seg_revenue_business_segment, seg_cost_of_revenue_business_segment, seg_research_and_development_expenses_business_segment, seg_selling_and_marketing_expenses_business_segment, seg_general_and_administrative_expenses_business_segment (optional)
|
|
43
|
-
segmentId:
|
|
43
|
+
segmentId: seg_revenue_product,
|
|
44
44
|
// 'asc' | 'desc' | Sort direction for periods by period_end: \'asc\' (oldest first), \'desc\' (newest first) (optional)
|
|
45
|
-
sort:
|
|
45
|
+
sort: desc,
|
|
46
46
|
// number | Maximum number of periods per ticker (1-100) (optional)
|
|
47
|
-
limit:
|
|
47
|
+
limit: 5,
|
|
48
48
|
// number | Number of periods to skip for pagination (optional)
|
|
49
|
-
offset:
|
|
49
|
+
offset: 0,
|
|
50
50
|
} satisfies SegmentedFinancialsRequest;
|
|
51
51
|
|
|
52
52
|
try {
|
|
@@ -126,17 +126,17 @@ async function example() {
|
|
|
126
126
|
|
|
127
127
|
const body = {
|
|
128
128
|
// string | Ticker symbol or CIK
|
|
129
|
-
identifier:
|
|
129
|
+
identifier: AAPL,
|
|
130
130
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period: \'quarterly\' (Q1-Q4), \'annual\' (full year), \'ytd\' (year-to-date), \'ttm\' (trailing twelve months)
|
|
131
|
-
fiscalPeriodType:
|
|
131
|
+
fiscalPeriodType: annual,
|
|
132
132
|
// 'seg_revenue_product' | 'seg_revenue_geographic' | 'seg_revenue_business_segment' | 'seg_cost_of_revenue_business_segment' | 'seg_research_and_development_expenses_business_segment' | 'seg_selling_and_marketing_expenses_business_segment' | 'seg_general_and_administrative_expenses_business_segment' | Filter by segment ID: seg_revenue_product, seg_revenue_geographic, seg_revenue_business_segment, seg_cost_of_revenue_business_segment, seg_research_and_development_expenses_business_segment, seg_selling_and_marketing_expenses_business_segment, seg_general_and_administrative_expenses_business_segment (optional)
|
|
133
|
-
segmentId:
|
|
133
|
+
segmentId: seg_revenue_product,
|
|
134
134
|
// 'asc' | 'desc' | Sort direction for periods by period_end: \'asc\' (oldest first), \'desc\' (newest first) (optional)
|
|
135
|
-
sort:
|
|
135
|
+
sort: desc,
|
|
136
136
|
// number | Maximum number of periods per ticker (1-100) (optional)
|
|
137
|
-
limit:
|
|
137
|
+
limit: 5,
|
|
138
138
|
// number | Number of periods to skip for pagination (optional)
|
|
139
|
-
offset:
|
|
139
|
+
offset: 0,
|
|
140
140
|
} satisfies SegmentedFinancialsDetailedRequest;
|
|
141
141
|
|
|
142
142
|
try {
|
|
@@ -37,15 +37,15 @@ async function example() {
|
|
|
37
37
|
|
|
38
38
|
const body = {
|
|
39
39
|
// string | Ticker symbol or CIK
|
|
40
|
-
identifier:
|
|
40
|
+
identifier: AAPL,
|
|
41
41
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
42
|
-
fiscalPeriodType:
|
|
42
|
+
fiscalPeriodType: annual,
|
|
43
43
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
44
|
-
sort:
|
|
44
|
+
sort: desc,
|
|
45
45
|
// number | Maximum number of periods per ticker (optional)
|
|
46
|
-
limit:
|
|
46
|
+
limit: 5,
|
|
47
47
|
// number | Number of periods to skip for pagination (optional)
|
|
48
|
-
offset:
|
|
48
|
+
offset: 0,
|
|
49
49
|
} satisfies StandardizedBalanceSheetRequest;
|
|
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:
|
|
127
|
+
identifier: AAPL,
|
|
128
128
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
129
|
-
fiscalPeriodType:
|
|
129
|
+
fiscalPeriodType: annual,
|
|
130
130
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
131
|
-
sort:
|
|
131
|
+
sort: desc,
|
|
132
132
|
// number | Maximum number of periods per ticker (optional)
|
|
133
|
-
limit:
|
|
133
|
+
limit: 5,
|
|
134
134
|
// number | Number of periods to skip for pagination (optional)
|
|
135
|
-
offset:
|
|
135
|
+
offset: 0,
|
|
136
136
|
// 'true' | 'false' | Include formula in response (optional)
|
|
137
|
-
withFormula:
|
|
137
|
+
withFormula: true,
|
|
138
138
|
} satisfies StandardizedBalanceSheetDetailedRequest;
|
|
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:
|
|
217
|
+
identifier: AAPL,
|
|
218
218
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
219
|
-
fiscalPeriodType:
|
|
219
|
+
fiscalPeriodType: annual,
|
|
220
220
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
221
|
-
sort:
|
|
221
|
+
sort: desc,
|
|
222
222
|
// number | Maximum number of periods per ticker (optional)
|
|
223
|
-
limit:
|
|
223
|
+
limit: 5,
|
|
224
224
|
// number | Number of periods to skip for pagination (optional)
|
|
225
|
-
offset:
|
|
225
|
+
offset: 0,
|
|
226
226
|
} satisfies StandardizedBalanceSheetPresentationRequest;
|
|
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:
|
|
40
|
+
identifier: AAPL,
|
|
41
41
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
42
|
-
fiscalPeriodType:
|
|
42
|
+
fiscalPeriodType: annual,
|
|
43
43
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
44
|
-
sort:
|
|
44
|
+
sort: desc,
|
|
45
45
|
// number | Maximum number of periods per ticker (optional)
|
|
46
|
-
limit:
|
|
46
|
+
limit: 5,
|
|
47
47
|
// number | Number of periods to skip for pagination (optional)
|
|
48
|
-
offset:
|
|
48
|
+
offset: 0,
|
|
49
49
|
} satisfies StandardizedCashFlowStatementRequest;
|
|
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:
|
|
127
|
+
identifier: AAPL,
|
|
128
128
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
129
|
-
fiscalPeriodType:
|
|
129
|
+
fiscalPeriodType: annual,
|
|
130
130
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
131
|
-
sort:
|
|
131
|
+
sort: desc,
|
|
132
132
|
// number | Maximum number of periods per ticker (optional)
|
|
133
|
-
limit:
|
|
133
|
+
limit: 5,
|
|
134
134
|
// number | Number of periods to skip for pagination (optional)
|
|
135
|
-
offset:
|
|
135
|
+
offset: 0,
|
|
136
136
|
// 'true' | 'false' | Include formula in response (optional)
|
|
137
|
-
withFormula:
|
|
137
|
+
withFormula: true,
|
|
138
138
|
} satisfies StandardizedCashFlowStatementDetailedRequest;
|
|
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:
|
|
217
|
+
identifier: AAPL,
|
|
218
218
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
219
|
-
fiscalPeriodType:
|
|
219
|
+
fiscalPeriodType: annual,
|
|
220
220
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
221
|
-
sort:
|
|
221
|
+
sort: desc,
|
|
222
222
|
// number | Maximum number of periods per ticker (optional)
|
|
223
|
-
limit:
|
|
223
|
+
limit: 5,
|
|
224
224
|
// number | Number of periods to skip for pagination (optional)
|
|
225
|
-
offset:
|
|
225
|
+
offset: 0,
|
|
226
226
|
} satisfies StandardizedCashFlowStatementPresentationRequest;
|
|
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:
|
|
40
|
+
identifier: AAPL,
|
|
41
41
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
42
|
-
fiscalPeriodType:
|
|
42
|
+
fiscalPeriodType: annual,
|
|
43
43
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
44
|
-
sort:
|
|
44
|
+
sort: desc,
|
|
45
45
|
// number | Maximum number of periods per ticker (optional)
|
|
46
|
-
limit:
|
|
46
|
+
limit: 5,
|
|
47
47
|
// number | Number of periods to skip for pagination (optional)
|
|
48
|
-
offset:
|
|
48
|
+
offset: 0,
|
|
49
49
|
} satisfies StandardizedIncomeStatementRequest;
|
|
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:
|
|
127
|
+
identifier: AAPL,
|
|
128
128
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
129
|
-
fiscalPeriodType:
|
|
129
|
+
fiscalPeriodType: annual,
|
|
130
130
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
131
|
-
sort:
|
|
131
|
+
sort: desc,
|
|
132
132
|
// number | Maximum number of periods per ticker (optional)
|
|
133
|
-
limit:
|
|
133
|
+
limit: 5,
|
|
134
134
|
// number | Number of periods to skip for pagination (optional)
|
|
135
|
-
offset:
|
|
135
|
+
offset: 0,
|
|
136
136
|
// 'true' | 'false' | Include formula in response (optional)
|
|
137
|
-
withFormula:
|
|
137
|
+
withFormula: true,
|
|
138
138
|
} satisfies StandardizedIncomeStatementDetailedRequest;
|
|
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:
|
|
217
|
+
identifier: AAPL,
|
|
218
218
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
219
|
-
fiscalPeriodType:
|
|
219
|
+
fiscalPeriodType: annual,
|
|
220
220
|
// 'asc' | 'desc' | Sort direction for periods by period_end (optional)
|
|
221
|
-
sort:
|
|
221
|
+
sort: desc,
|
|
222
222
|
// number | Maximum number of periods per ticker (optional)
|
|
223
|
-
limit:
|
|
223
|
+
limit: 5,
|
|
224
224
|
// number | Number of periods to skip for pagination (optional)
|
|
225
|
-
offset:
|
|
225
|
+
offset: 0,
|
|
226
226
|
} satisfies StandardizedIncomeStatementPresentationRequest;
|
|
227
227
|
|
|
228
228
|
try {
|