@chadwin/sdk 0.7.0 → 0.9.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/README.md +12 -0
- package/dist/index.cjs +11 -35
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +348 -359
- package/dist/index.d.ts +348 -359
- package/dist/index.js +11 -35
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -8,6 +8,7 @@ interface PromiseWithResponse<T> extends Promise<T> {
|
|
|
8
8
|
interface components {
|
|
9
9
|
schemas: {
|
|
10
10
|
CompanyFinancialStatementPeriod: {
|
|
11
|
+
/** @description SEC filing used as the source for this period. EPS and weighted-average shares are adjusted for later stock splits. */
|
|
11
12
|
accession_number: string;
|
|
12
13
|
balance_sheet: components["schemas"]["FinancialStatementBalanceSheet"];
|
|
13
14
|
cash_flow_statement: components["schemas"]["FinancialStatementCashFlowStatement"];
|
|
@@ -169,7 +170,10 @@ interface components {
|
|
|
169
170
|
listings: {
|
|
170
171
|
/** @description Source exchange label. */
|
|
171
172
|
exchange: string | null;
|
|
172
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* @description Present in the accepted SEC ticker snapshot; does not establish trading or business status.
|
|
175
|
+
* @enum {boolean}
|
|
176
|
+
*/
|
|
173
177
|
is_current: true;
|
|
174
178
|
share_class_figi: string | null;
|
|
175
179
|
ticker: string;
|
|
@@ -259,7 +263,36 @@ interface components {
|
|
|
259
263
|
error: "invalid_query" | "invalid_query_parameters";
|
|
260
264
|
};
|
|
261
265
|
CompanySearchResponse: {
|
|
262
|
-
companies: components["schemas"]["
|
|
266
|
+
companies: components["schemas"]["CompanySearchResult"][];
|
|
267
|
+
};
|
|
268
|
+
CompanySearchResult: {
|
|
269
|
+
/**
|
|
270
|
+
* @description Zero-padded SEC Central Index Key.
|
|
271
|
+
* @example 0000051143
|
|
272
|
+
*/
|
|
273
|
+
cik: string;
|
|
274
|
+
/**
|
|
275
|
+
* @description Stored fiscal year end in MMDD form, or null.
|
|
276
|
+
* @example 1231
|
|
277
|
+
*/
|
|
278
|
+
fiscal_year_end: string | null;
|
|
279
|
+
/** @description All stored ticker and exchange associations for this CIK, including historical associations. May be empty; does not establish currentness or effective dates. */
|
|
280
|
+
listings: {
|
|
281
|
+
/** @description Source exchange label. */
|
|
282
|
+
exchange: string | null;
|
|
283
|
+
share_class_figi: string | null;
|
|
284
|
+
ticker: string;
|
|
285
|
+
}[];
|
|
286
|
+
/**
|
|
287
|
+
* @description Company display name.
|
|
288
|
+
* @example INTERNATIONAL BUSINESS MACHINES CORP
|
|
289
|
+
*/
|
|
290
|
+
name: string;
|
|
291
|
+
sic: {
|
|
292
|
+
code: string;
|
|
293
|
+
industry_title: string;
|
|
294
|
+
office: string;
|
|
295
|
+
} | null;
|
|
263
296
|
};
|
|
264
297
|
DatasetNotEntitledErrorResponse: {
|
|
265
298
|
/** @enum {string} */
|
|
@@ -280,12 +313,13 @@ interface components {
|
|
|
280
313
|
inventory?: string;
|
|
281
314
|
long_term_debt_noncurrent?: string;
|
|
282
315
|
property_plant_and_equipment_net?: string;
|
|
316
|
+
retained_earnings_accumulated_deficit?: string;
|
|
283
317
|
short_term_borrowings?: string;
|
|
284
318
|
short_term_investments?: string;
|
|
285
319
|
total_assets?: string;
|
|
286
|
-
total_borrowings?: string;
|
|
287
320
|
total_current_assets?: string;
|
|
288
321
|
total_current_liabilities?: string;
|
|
322
|
+
total_debt?: string;
|
|
289
323
|
total_liabilities?: string;
|
|
290
324
|
total_liabilities_and_equity?: string;
|
|
291
325
|
};
|
|
@@ -307,16 +341,19 @@ interface components {
|
|
|
307
341
|
share_based_compensation_adjustment?: string;
|
|
308
342
|
};
|
|
309
343
|
FinancialStatementIncomeStatement: {
|
|
344
|
+
/** @description Reported earnings per share projected onto the latest reviewed stock-split basis. */
|
|
310
345
|
basic_earnings_per_share?: string;
|
|
346
|
+
/** @description Reported weighted-average shares projected onto the latest reviewed stock-split basis. */
|
|
311
347
|
basic_weighted_average_shares?: string;
|
|
312
348
|
cost_of_sales?: string;
|
|
349
|
+
/** @description Reported earnings per share projected onto the latest reviewed stock-split basis. */
|
|
313
350
|
diluted_earnings_per_share?: string;
|
|
351
|
+
/** @description Reported weighted-average shares projected onto the latest reviewed stock-split basis. */
|
|
314
352
|
diluted_weighted_average_shares?: string;
|
|
315
353
|
gross_profit?: string;
|
|
316
354
|
income_before_income_taxes?: string;
|
|
317
355
|
income_tax_expense?: string;
|
|
318
356
|
interest_expense?: string;
|
|
319
|
-
net_income_attributable_to_noncontrolling_interests?: string;
|
|
320
357
|
net_income_attributable_to_parent?: string;
|
|
321
358
|
net_income_including_noncontrolling_interests?: string;
|
|
322
359
|
nonoperating_income_expense?: string;
|
|
@@ -328,8 +365,8 @@ interface components {
|
|
|
328
365
|
};
|
|
329
366
|
FinancialStatementIssuer: {
|
|
330
367
|
cik: string;
|
|
331
|
-
name: string;
|
|
332
|
-
ticker: string;
|
|
368
|
+
name: string | null;
|
|
369
|
+
ticker: string | null;
|
|
333
370
|
};
|
|
334
371
|
FinancialStatementMetrics: {
|
|
335
372
|
asset_turnover?: string;
|
|
@@ -338,6 +375,7 @@ interface components {
|
|
|
338
375
|
debt_to_assets?: string;
|
|
339
376
|
debt_to_equity?: string;
|
|
340
377
|
ebit?: string;
|
|
378
|
+
ebit_margin?: string;
|
|
341
379
|
effective_tax_rate?: string;
|
|
342
380
|
free_cash_flow?: string;
|
|
343
381
|
free_cash_flow_margin?: string;
|
|
@@ -356,7 +394,7 @@ interface components {
|
|
|
356
394
|
};
|
|
357
395
|
FinancialStatementsBadRequest: {
|
|
358
396
|
/** @enum {string} */
|
|
359
|
-
error: "
|
|
397
|
+
error: "invalid_query_parameters";
|
|
360
398
|
};
|
|
361
399
|
FinancialStatementsCompanyNotFound: {
|
|
362
400
|
/** @enum {string} */
|
|
@@ -372,7 +410,7 @@ interface components {
|
|
|
372
410
|
};
|
|
373
411
|
FinancialStatementsTickerAmbiguous: {
|
|
374
412
|
/** @enum {string} */
|
|
375
|
-
error: "
|
|
413
|
+
error: "company_ambiguous";
|
|
376
414
|
};
|
|
377
415
|
FinancialStatementsTooManyRequests: {
|
|
378
416
|
/** @enum {string} */
|
|
@@ -1353,125 +1391,19 @@ interface components {
|
|
|
1353
1391
|
pathItems: never;
|
|
1354
1392
|
}
|
|
1355
1393
|
interface operations {
|
|
1356
|
-
|
|
1394
|
+
getCompany: {
|
|
1357
1395
|
parameters: {
|
|
1358
|
-
query
|
|
1359
|
-
/** @description
|
|
1360
|
-
|
|
1396
|
+
query?: {
|
|
1397
|
+
/** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
|
|
1398
|
+
ticker?: string;
|
|
1399
|
+
/** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
|
|
1400
|
+
cik?: string;
|
|
1361
1401
|
};
|
|
1362
1402
|
header?: never;
|
|
1363
1403
|
path?: never;
|
|
1364
1404
|
cookie?: never;
|
|
1365
1405
|
};
|
|
1366
1406
|
requestBody?: never;
|
|
1367
|
-
responses: {
|
|
1368
|
-
/** @description Ranked company matches. */
|
|
1369
|
-
200: {
|
|
1370
|
-
headers: {
|
|
1371
|
-
"Cache-Control"?: string;
|
|
1372
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1373
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1374
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1375
|
-
[name: string]: unknown;
|
|
1376
|
-
};
|
|
1377
|
-
content: {
|
|
1378
|
-
/**
|
|
1379
|
-
* @example {
|
|
1380
|
-
* "companies": [
|
|
1381
|
-
* {
|
|
1382
|
-
* "cik": "0000051143",
|
|
1383
|
-
* "fiscal_year_end": "1231",
|
|
1384
|
-
* "listings": [
|
|
1385
|
-
* {
|
|
1386
|
-
* "exchange": "NYSE",
|
|
1387
|
-
* "is_current": true,
|
|
1388
|
-
* "share_class_figi": "BBG001S5S399",
|
|
1389
|
-
* "ticker": "IBM"
|
|
1390
|
-
* }
|
|
1391
|
-
* ],
|
|
1392
|
-
* "name": "International Business Machines Corporation",
|
|
1393
|
-
* "sic": {
|
|
1394
|
-
* "code": "3570",
|
|
1395
|
-
* "industry_title": "COMPUTER & OFFICE EQUIPMENT",
|
|
1396
|
-
* "office": "Office of Technology"
|
|
1397
|
-
* }
|
|
1398
|
-
* }
|
|
1399
|
-
* ]
|
|
1400
|
-
* }
|
|
1401
|
-
*/
|
|
1402
|
-
"application/json": components["schemas"]["CompanySearchResponse"];
|
|
1403
|
-
};
|
|
1404
|
-
};
|
|
1405
|
-
/** @description The query is missing, invalid, or has unsupported keys. */
|
|
1406
|
-
400: {
|
|
1407
|
-
headers: {
|
|
1408
|
-
[name: string]: unknown;
|
|
1409
|
-
};
|
|
1410
|
-
content: {
|
|
1411
|
-
/**
|
|
1412
|
-
* @example {
|
|
1413
|
-
* "error": "invalid_query"
|
|
1414
|
-
* }
|
|
1415
|
-
*/
|
|
1416
|
-
"application/json": components["schemas"]["CompanySearchBadRequestResponse"];
|
|
1417
|
-
};
|
|
1418
|
-
};
|
|
1419
|
-
/** @description The request is missing a valid Chadwin API key. */
|
|
1420
|
-
401: {
|
|
1421
|
-
headers: {
|
|
1422
|
-
[name: string]: unknown;
|
|
1423
|
-
};
|
|
1424
|
-
content: {
|
|
1425
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1426
|
-
};
|
|
1427
|
-
};
|
|
1428
|
-
/** @description The request exceeded a rate limit. */
|
|
1429
|
-
429: {
|
|
1430
|
-
headers: {
|
|
1431
|
-
"RateLimit-Limit"?: string;
|
|
1432
|
-
"RateLimit-Reset"?: string;
|
|
1433
|
-
"Retry-After"?: string;
|
|
1434
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1435
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1436
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1437
|
-
[name: string]: unknown;
|
|
1438
|
-
};
|
|
1439
|
-
content: {
|
|
1440
|
-
/**
|
|
1441
|
-
* @example {
|
|
1442
|
-
* "error": "rate_limited"
|
|
1443
|
-
* }
|
|
1444
|
-
*/
|
|
1445
|
-
"application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
|
|
1446
|
-
};
|
|
1447
|
-
};
|
|
1448
|
-
/** @description The database is unavailable. */
|
|
1449
|
-
503: {
|
|
1450
|
-
headers: {
|
|
1451
|
-
[name: string]: unknown;
|
|
1452
|
-
};
|
|
1453
|
-
content: {
|
|
1454
|
-
/**
|
|
1455
|
-
* @example {
|
|
1456
|
-
* "error": "database_unavailable"
|
|
1457
|
-
* }
|
|
1458
|
-
*/
|
|
1459
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1460
|
-
};
|
|
1461
|
-
};
|
|
1462
|
-
};
|
|
1463
|
-
};
|
|
1464
|
-
getCompany: {
|
|
1465
|
-
parameters: {
|
|
1466
|
-
query?: never;
|
|
1467
|
-
header?: never;
|
|
1468
|
-
path: {
|
|
1469
|
-
/** @description US listed company ticker */
|
|
1470
|
-
ticker: string;
|
|
1471
|
-
};
|
|
1472
|
-
cookie?: never;
|
|
1473
|
-
};
|
|
1474
|
-
requestBody?: never;
|
|
1475
1407
|
responses: {
|
|
1476
1408
|
/** @description Company reference details. */
|
|
1477
1409
|
200: {
|
|
@@ -1508,152 +1440,16 @@ interface operations {
|
|
|
1508
1440
|
"application/json": components["schemas"]["CompanyReferenceResponse"];
|
|
1509
1441
|
};
|
|
1510
1442
|
};
|
|
1511
|
-
/** @description
|
|
1512
|
-
401: {
|
|
1513
|
-
headers: {
|
|
1514
|
-
[name: string]: unknown;
|
|
1515
|
-
};
|
|
1516
|
-
content: {
|
|
1517
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1518
|
-
};
|
|
1519
|
-
};
|
|
1520
|
-
/** @description The ticker does not resolve to exactly one current company. */
|
|
1521
|
-
404: {
|
|
1522
|
-
headers: {
|
|
1523
|
-
[name: string]: unknown;
|
|
1524
|
-
};
|
|
1525
|
-
content: {
|
|
1526
|
-
/**
|
|
1527
|
-
* @example {
|
|
1528
|
-
* "error": "company_not_found"
|
|
1529
|
-
* }
|
|
1530
|
-
*/
|
|
1531
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1532
|
-
};
|
|
1533
|
-
};
|
|
1534
|
-
/** @description The request exceeded a rate limit. */
|
|
1535
|
-
429: {
|
|
1536
|
-
headers: {
|
|
1537
|
-
"RateLimit-Limit"?: string;
|
|
1538
|
-
"RateLimit-Reset"?: string;
|
|
1539
|
-
"Retry-After"?: string;
|
|
1540
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1541
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1542
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1543
|
-
[name: string]: unknown;
|
|
1544
|
-
};
|
|
1545
|
-
content: {
|
|
1546
|
-
/**
|
|
1547
|
-
* @example {
|
|
1548
|
-
* "error": "rate_limited"
|
|
1549
|
-
* }
|
|
1550
|
-
*/
|
|
1551
|
-
"application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
|
|
1552
|
-
};
|
|
1553
|
-
};
|
|
1554
|
-
/** @description The database is unavailable. */
|
|
1555
|
-
503: {
|
|
1556
|
-
headers: {
|
|
1557
|
-
[name: string]: unknown;
|
|
1558
|
-
};
|
|
1559
|
-
content: {
|
|
1560
|
-
/**
|
|
1561
|
-
* @example {
|
|
1562
|
-
* "error": "database_unavailable"
|
|
1563
|
-
* }
|
|
1564
|
-
*/
|
|
1565
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1566
|
-
};
|
|
1567
|
-
};
|
|
1568
|
-
};
|
|
1569
|
-
};
|
|
1570
|
-
getCompanyFinancialStatements: {
|
|
1571
|
-
parameters: {
|
|
1572
|
-
query?: {
|
|
1573
|
-
/** @description One fiscal year from 1900 through 9999. */
|
|
1574
|
-
fiscal_year?: number;
|
|
1575
|
-
/** @description Newest available fiscal years to return, from 1 through 20. */
|
|
1576
|
-
years?: number;
|
|
1577
|
-
};
|
|
1578
|
-
header?: never;
|
|
1579
|
-
path: {
|
|
1580
|
-
/** @description US listed company ticker */
|
|
1581
|
-
ticker: string;
|
|
1582
|
-
};
|
|
1583
|
-
cookie?: never;
|
|
1584
|
-
};
|
|
1585
|
-
requestBody?: never;
|
|
1586
|
-
responses: {
|
|
1587
|
-
/** @description Published and reviewed normalized annual financial statements. */
|
|
1588
|
-
200: {
|
|
1589
|
-
headers: {
|
|
1590
|
-
"Cache-Control"?: string;
|
|
1591
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1592
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1593
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1594
|
-
[name: string]: unknown;
|
|
1595
|
-
};
|
|
1596
|
-
content: {
|
|
1597
|
-
/**
|
|
1598
|
-
* @example {
|
|
1599
|
-
* "issuer": {
|
|
1600
|
-
* "cik": "0000320193",
|
|
1601
|
-
* "name": "Apple Inc.",
|
|
1602
|
-
* "ticker": "AAPL"
|
|
1603
|
-
* },
|
|
1604
|
-
* "periods": [
|
|
1605
|
-
* {
|
|
1606
|
-
* "accession_number": "0000320193-24-000123",
|
|
1607
|
-
* "balance_sheet": {
|
|
1608
|
-
* "cash_and_cash_equivalents": "29943000000",
|
|
1609
|
-
* "equity_attributable_to_parent": "56950000000",
|
|
1610
|
-
* "total_assets": "364980000000",
|
|
1611
|
-
* "total_current_assets": "152987000000",
|
|
1612
|
-
* "total_current_liabilities": "176392000000"
|
|
1613
|
-
* },
|
|
1614
|
-
* "cash_flow_statement": {
|
|
1615
|
-
* "net_cash_from_financing_activities": "-121983000000",
|
|
1616
|
-
* "net_cash_from_investing_activities": "2935000000",
|
|
1617
|
-
* "net_cash_from_operating_activities": "118254000000"
|
|
1618
|
-
* },
|
|
1619
|
-
* "currency": "USD",
|
|
1620
|
-
* "fiscal_period": "FY",
|
|
1621
|
-
* "fiscal_year": 2024,
|
|
1622
|
-
* "income_statement": {
|
|
1623
|
-
* "basic_earnings_per_share": "6.11",
|
|
1624
|
-
* "diluted_earnings_per_share": "6.08",
|
|
1625
|
-
* "income_before_income_taxes": "123485000000",
|
|
1626
|
-
* "income_tax_expense": "29749000000",
|
|
1627
|
-
* "net_income_attributable_to_parent": "93736000000",
|
|
1628
|
-
* "operating_income": "123216000000",
|
|
1629
|
-
* "revenue": "391035000000"
|
|
1630
|
-
* },
|
|
1631
|
-
* "metrics": {
|
|
1632
|
-
* "cash_ratio": "0.17",
|
|
1633
|
-
* "current_ratio": "0.87",
|
|
1634
|
-
* "effective_tax_rate": "24.09",
|
|
1635
|
-
* "net_margin": "23.97",
|
|
1636
|
-
* "operating_cash_flow_margin": "30.24",
|
|
1637
|
-
* "operating_margin": "31.51",
|
|
1638
|
-
* "pretax_margin": "31.58",
|
|
1639
|
-
* "return_on_equity": "157.41",
|
|
1640
|
-
* "working_capital": "-23405000000"
|
|
1641
|
-
* },
|
|
1642
|
-
* "period_end_date": "2024-09-28"
|
|
1643
|
-
* }
|
|
1644
|
-
* ]
|
|
1645
|
-
* }
|
|
1646
|
-
*/
|
|
1647
|
-
"application/json": components["schemas"]["CompanyFinancialStatementsResponse"];
|
|
1648
|
-
};
|
|
1649
|
-
};
|
|
1650
|
-
/** @description The ticker or query parameters are invalid. */
|
|
1443
|
+
/** @description Supply exactly one valid ticker or CIK and no other query keys. */
|
|
1651
1444
|
400: {
|
|
1652
1445
|
headers: {
|
|
1653
1446
|
[name: string]: unknown;
|
|
1654
1447
|
};
|
|
1655
1448
|
content: {
|
|
1656
|
-
"application/json":
|
|
1449
|
+
"application/json": {
|
|
1450
|
+
/** @enum {string} */
|
|
1451
|
+
error: "invalid_query_parameters";
|
|
1452
|
+
};
|
|
1657
1453
|
};
|
|
1658
1454
|
};
|
|
1659
1455
|
/** @description The request is missing a valid Chadwin API key. */
|
|
@@ -1662,37 +1458,36 @@ interface operations {
|
|
|
1662
1458
|
[name: string]: unknown;
|
|
1663
1459
|
};
|
|
1664
1460
|
content: {
|
|
1665
|
-
"application/json": components["schemas"]["
|
|
1666
|
-
};
|
|
1667
|
-
};
|
|
1668
|
-
/** @description The subscription does not include this dataset. */
|
|
1669
|
-
403: {
|
|
1670
|
-
headers: {
|
|
1671
|
-
[name: string]: unknown;
|
|
1672
|
-
};
|
|
1673
|
-
content: {
|
|
1674
|
-
"application/json": components["schemas"]["FinancialStatementsNotEntitled"];
|
|
1461
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1675
1462
|
};
|
|
1676
1463
|
};
|
|
1677
|
-
/** @description
|
|
1464
|
+
/** @description The ticker does not resolve, or the selected CIK has no stored company profile. */
|
|
1678
1465
|
404: {
|
|
1679
1466
|
headers: {
|
|
1680
1467
|
[name: string]: unknown;
|
|
1681
1468
|
};
|
|
1682
1469
|
content: {
|
|
1683
|
-
|
|
1470
|
+
/**
|
|
1471
|
+
* @example {
|
|
1472
|
+
* "error": "company_not_found"
|
|
1473
|
+
* }
|
|
1474
|
+
*/
|
|
1475
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1684
1476
|
};
|
|
1685
1477
|
};
|
|
1686
|
-
/** @description
|
|
1478
|
+
/** @description The ticker matches multiple CIKs. */
|
|
1687
1479
|
409: {
|
|
1688
1480
|
headers: {
|
|
1689
1481
|
[name: string]: unknown;
|
|
1690
1482
|
};
|
|
1691
1483
|
content: {
|
|
1692
|
-
"application/json":
|
|
1484
|
+
"application/json": {
|
|
1485
|
+
/** @enum {string} */
|
|
1486
|
+
error: "company_ambiguous";
|
|
1487
|
+
};
|
|
1693
1488
|
};
|
|
1694
1489
|
};
|
|
1695
|
-
/** @description The request exceeded a rate limit
|
|
1490
|
+
/** @description The request exceeded a rate limit. */
|
|
1696
1491
|
429: {
|
|
1697
1492
|
headers: {
|
|
1698
1493
|
"RateLimit-Limit"?: string;
|
|
@@ -1704,16 +1499,12 @@ interface operations {
|
|
|
1704
1499
|
[name: string]: unknown;
|
|
1705
1500
|
};
|
|
1706
1501
|
content: {
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
[name: string]: unknown;
|
|
1714
|
-
};
|
|
1715
|
-
content: {
|
|
1716
|
-
"application/json": components["schemas"]["FinancialStatementsInternalError"];
|
|
1502
|
+
/**
|
|
1503
|
+
* @example {
|
|
1504
|
+
* "error": "rate_limited"
|
|
1505
|
+
* }
|
|
1506
|
+
*/
|
|
1507
|
+
"application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
|
|
1717
1508
|
};
|
|
1718
1509
|
};
|
|
1719
1510
|
/** @description The database is unavailable. */
|
|
@@ -1722,7 +1513,12 @@ interface operations {
|
|
|
1722
1513
|
[name: string]: unknown;
|
|
1723
1514
|
};
|
|
1724
1515
|
content: {
|
|
1725
|
-
|
|
1516
|
+
/**
|
|
1517
|
+
* @example {
|
|
1518
|
+
* "error": "database_unavailable"
|
|
1519
|
+
* }
|
|
1520
|
+
*/
|
|
1521
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1726
1522
|
};
|
|
1727
1523
|
};
|
|
1728
1524
|
};
|
|
@@ -2076,23 +1872,28 @@ interface operations {
|
|
|
2076
1872
|
};
|
|
2077
1873
|
};
|
|
2078
1874
|
};
|
|
2079
|
-
|
|
1875
|
+
getCompanyFinancialStatements: {
|
|
2080
1876
|
parameters: {
|
|
2081
|
-
query?:
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
ticker
|
|
2085
|
-
|
|
1877
|
+
query?: {
|
|
1878
|
+
/** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
|
|
1879
|
+
ticker?: string;
|
|
1880
|
+
/** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
|
|
1881
|
+
cik?: string;
|
|
1882
|
+
/** @description One fiscal year from 1900 through 9999. */
|
|
1883
|
+
fiscal_year?: number;
|
|
1884
|
+
/** @description Newest available fiscal years to return, from 1 through 20. */
|
|
1885
|
+
years?: number;
|
|
2086
1886
|
};
|
|
1887
|
+
header?: never;
|
|
1888
|
+
path?: never;
|
|
2087
1889
|
cookie?: never;
|
|
2088
1890
|
};
|
|
2089
1891
|
requestBody?: never;
|
|
2090
1892
|
responses: {
|
|
2091
|
-
/** @description
|
|
1893
|
+
/** @description Published and reviewed normalized annual financial statements. */
|
|
2092
1894
|
200: {
|
|
2093
1895
|
headers: {
|
|
2094
1896
|
"Cache-Control"?: string;
|
|
2095
|
-
ETag?: string;
|
|
2096
1897
|
"X-Billing-Period-Quota-Limit"?: string;
|
|
2097
1898
|
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2098
1899
|
"X-Billing-Period-Quota-Reset"?: string;
|
|
@@ -2101,35 +1902,96 @@ interface operations {
|
|
|
2101
1902
|
content: {
|
|
2102
1903
|
/**
|
|
2103
1904
|
* @example {
|
|
2104
|
-
* "filings": [
|
|
2105
|
-
* {
|
|
2106
|
-
* "accepted_at": "2024-11-01T10:00:00.000Z",
|
|
2107
|
-
* "accession_number": "0000320193-24-000123",
|
|
2108
|
-
* "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
|
|
2109
|
-
* "form": "10-K",
|
|
2110
|
-
* "period_end_date": "2024-09-28",
|
|
2111
|
-
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
|
|
2112
|
-
* }
|
|
2113
|
-
* ],
|
|
2114
|
-
* "fiscal_period": "FY",
|
|
2115
|
-
* "fiscal_year": 2024,
|
|
2116
1905
|
* "issuer": {
|
|
2117
1906
|
* "cik": "0000320193",
|
|
2118
1907
|
* "name": "Apple Inc.",
|
|
2119
1908
|
* "ticker": "AAPL"
|
|
2120
|
-
* }
|
|
1909
|
+
* },
|
|
1910
|
+
* "periods": [
|
|
1911
|
+
* {
|
|
1912
|
+
* "accession_number": "0000320193-25-000079",
|
|
1913
|
+
* "balance_sheet": {
|
|
1914
|
+
* "accounts_payable_current": "69860000000",
|
|
1915
|
+
* "accounts_receivable_current": "39777000000",
|
|
1916
|
+
* "cash_and_cash_equivalents": "35934000000",
|
|
1917
|
+
* "current_portion_of_long_term_debt": "12350000000",
|
|
1918
|
+
* "equity_attributable_to_parent": "73733000000",
|
|
1919
|
+
* "inventory": "5718000000",
|
|
1920
|
+
* "long_term_debt_noncurrent": "78328000000",
|
|
1921
|
+
* "property_plant_and_equipment_net": "49834000000",
|
|
1922
|
+
* "short_term_borrowings": "7979000000",
|
|
1923
|
+
* "short_term_investments": "18763000000",
|
|
1924
|
+
* "total_assets": "359241000000",
|
|
1925
|
+
* "total_current_assets": "147957000000",
|
|
1926
|
+
* "total_current_liabilities": "165631000000",
|
|
1927
|
+
* "total_liabilities": "285508000000",
|
|
1928
|
+
* "total_liabilities_and_equity": "359241000000"
|
|
1929
|
+
* },
|
|
1930
|
+
* "cash_flow_statement": {
|
|
1931
|
+
* "capital_expenditure": "12715000000",
|
|
1932
|
+
* "common_stock_repurchases": "90711000000",
|
|
1933
|
+
* "depreciation_and_amortization_adjustment": "11698000000",
|
|
1934
|
+
* "net_cash_from_financing_activities": "-120686000000",
|
|
1935
|
+
* "net_cash_from_investing_activities": "15195000000",
|
|
1936
|
+
* "net_cash_from_operating_activities": "111482000000",
|
|
1937
|
+
* "net_change_in_cash_cash_equivalents_and_restricted_cash_including_exchange_rate_effect": "5991000000",
|
|
1938
|
+
* "purchases_of_investments": "24407000000",
|
|
1939
|
+
* "share_based_compensation_adjustment": "12863000000"
|
|
1940
|
+
* },
|
|
1941
|
+
* "currency": "USD",
|
|
1942
|
+
* "fiscal_period": "FY",
|
|
1943
|
+
* "fiscal_year": 2025,
|
|
1944
|
+
* "income_statement": {
|
|
1945
|
+
* "basic_earnings_per_share": "7.49",
|
|
1946
|
+
* "basic_weighted_average_shares": "14948500000",
|
|
1947
|
+
* "cost_of_sales": "220960000000",
|
|
1948
|
+
* "diluted_earnings_per_share": "7.46",
|
|
1949
|
+
* "diluted_weighted_average_shares": "15004697000",
|
|
1950
|
+
* "gross_profit": "195201000000",
|
|
1951
|
+
* "income_before_income_taxes": "132729000000",
|
|
1952
|
+
* "income_tax_expense": "20719000000",
|
|
1953
|
+
* "net_income_attributable_to_parent": "112010000000",
|
|
1954
|
+
* "net_income_including_noncontrolling_interests": "112010000000",
|
|
1955
|
+
* "nonoperating_income_expense": "-321000000",
|
|
1956
|
+
* "operating_income": "133050000000",
|
|
1957
|
+
* "research_and_development_expense": "34550000000",
|
|
1958
|
+
* "revenue": "416161000000",
|
|
1959
|
+
* "selling_general_and_administrative_expense": "27601000000",
|
|
1960
|
+
* "total_operating_expenses": "62151000000"
|
|
1961
|
+
* },
|
|
1962
|
+
* "metrics": {
|
|
1963
|
+
* "asset_turnover": "1.15",
|
|
1964
|
+
* "cash_ratio": "0.22",
|
|
1965
|
+
* "current_ratio": "0.89",
|
|
1966
|
+
* "effective_tax_rate": "15.61",
|
|
1967
|
+
* "free_cash_flow": "98767000000",
|
|
1968
|
+
* "free_cash_flow_margin": "23.73",
|
|
1969
|
+
* "gross_margin": "46.91",
|
|
1970
|
+
* "net_margin": "26.92",
|
|
1971
|
+
* "operating_cash_flow_margin": "26.79",
|
|
1972
|
+
* "operating_cash_flow_to_net_income": "1.00",
|
|
1973
|
+
* "operating_margin": "31.97",
|
|
1974
|
+
* "pretax_margin": "31.89",
|
|
1975
|
+
* "quick_ratio": "0.57",
|
|
1976
|
+
* "return_on_assets": "30.93",
|
|
1977
|
+
* "return_on_equity": "171.42",
|
|
1978
|
+
* "working_capital": "-17674000000"
|
|
1979
|
+
* },
|
|
1980
|
+
* "period_end_date": "2025-09-27"
|
|
1981
|
+
* }
|
|
1982
|
+
* ]
|
|
2121
1983
|
* }
|
|
2122
1984
|
*/
|
|
2123
|
-
"application/json": components["schemas"]["
|
|
1985
|
+
"application/json": components["schemas"]["CompanyFinancialStatementsResponse"];
|
|
2124
1986
|
};
|
|
2125
1987
|
};
|
|
2126
|
-
/** @description The
|
|
1988
|
+
/** @description The identifier or query parameters are invalid. */
|
|
2127
1989
|
400: {
|
|
2128
1990
|
headers: {
|
|
2129
1991
|
[name: string]: unknown;
|
|
2130
1992
|
};
|
|
2131
1993
|
content: {
|
|
2132
|
-
"application/json": components["schemas"]["
|
|
1994
|
+
"application/json": components["schemas"]["FinancialStatementsBadRequest"];
|
|
2133
1995
|
};
|
|
2134
1996
|
};
|
|
2135
1997
|
/** @description The request is missing a valid Chadwin API key. */
|
|
@@ -2138,7 +2000,7 @@ interface operations {
|
|
|
2138
2000
|
[name: string]: unknown;
|
|
2139
2001
|
};
|
|
2140
2002
|
content: {
|
|
2141
|
-
"application/json": components["schemas"]["
|
|
2003
|
+
"application/json": components["schemas"]["FinancialStatementsUnauthorized"];
|
|
2142
2004
|
};
|
|
2143
2005
|
};
|
|
2144
2006
|
/** @description The subscription does not include this dataset. */
|
|
@@ -2147,28 +2009,28 @@ interface operations {
|
|
|
2147
2009
|
[name: string]: unknown;
|
|
2148
2010
|
};
|
|
2149
2011
|
content: {
|
|
2150
|
-
"application/json": components["schemas"]["
|
|
2012
|
+
"application/json": components["schemas"]["FinancialStatementsNotEntitled"];
|
|
2151
2013
|
};
|
|
2152
2014
|
};
|
|
2153
|
-
/** @description
|
|
2015
|
+
/** @description No company matches the requested ticker. */
|
|
2154
2016
|
404: {
|
|
2155
2017
|
headers: {
|
|
2156
2018
|
[name: string]: unknown;
|
|
2157
2019
|
};
|
|
2158
2020
|
content: {
|
|
2159
|
-
"application/json": components["schemas"]["
|
|
2021
|
+
"application/json": components["schemas"]["FinancialStatementsCompanyNotFound"];
|
|
2160
2022
|
};
|
|
2161
2023
|
};
|
|
2162
|
-
/** @description
|
|
2024
|
+
/** @description The ticker matches more than one CIK in the accepted SEC snapshot. */
|
|
2163
2025
|
409: {
|
|
2164
2026
|
headers: {
|
|
2165
2027
|
[name: string]: unknown;
|
|
2166
2028
|
};
|
|
2167
2029
|
content: {
|
|
2168
|
-
"application/json": components["schemas"]["
|
|
2030
|
+
"application/json": components["schemas"]["FinancialStatementsTickerAmbiguous"];
|
|
2169
2031
|
};
|
|
2170
2032
|
};
|
|
2171
|
-
/** @description The request exceeded a rate limit. */
|
|
2033
|
+
/** @description The request exceeded a rate limit or monthly quota. */
|
|
2172
2034
|
429: {
|
|
2173
2035
|
headers: {
|
|
2174
2036
|
"RateLimit-Limit"?: string;
|
|
@@ -2180,34 +2042,48 @@ interface operations {
|
|
|
2180
2042
|
[name: string]: unknown;
|
|
2181
2043
|
};
|
|
2182
2044
|
content: {
|
|
2183
|
-
"application/json": components["schemas"]["
|
|
2045
|
+
"application/json": components["schemas"]["FinancialStatementsTooManyRequests"];
|
|
2184
2046
|
};
|
|
2185
2047
|
};
|
|
2186
|
-
/** @description
|
|
2048
|
+
/** @description A stored result cannot map to the public schema. */
|
|
2049
|
+
500: {
|
|
2050
|
+
headers: {
|
|
2051
|
+
[name: string]: unknown;
|
|
2052
|
+
};
|
|
2053
|
+
content: {
|
|
2054
|
+
"application/json": components["schemas"]["FinancialStatementsInternalError"];
|
|
2055
|
+
};
|
|
2056
|
+
};
|
|
2057
|
+
/** @description The database is unavailable. */
|
|
2187
2058
|
503: {
|
|
2188
2059
|
headers: {
|
|
2189
2060
|
[name: string]: unknown;
|
|
2190
2061
|
};
|
|
2191
2062
|
content: {
|
|
2192
|
-
"application/json": components["schemas"]["
|
|
2063
|
+
"application/json": components["schemas"]["FinancialStatementsUnavailable"];
|
|
2193
2064
|
};
|
|
2194
2065
|
};
|
|
2195
2066
|
};
|
|
2196
2067
|
};
|
|
2197
|
-
|
|
2068
|
+
getCompanyReportsForPeriod: {
|
|
2198
2069
|
parameters: {
|
|
2199
|
-
query
|
|
2200
|
-
|
|
2201
|
-
|
|
2202
|
-
ticker
|
|
2070
|
+
query: {
|
|
2071
|
+
/** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
|
|
2072
|
+
ticker?: string;
|
|
2073
|
+
/** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
|
|
2074
|
+
cik?: string;
|
|
2075
|
+
/** @description Required four-digit fiscal year, from 1900 through 9999. */
|
|
2203
2076
|
fiscal_year: string;
|
|
2204
|
-
|
|
2077
|
+
/** @description Required FY for annual reports, or Q1, Q2 or Q3 for quarterly reports. FY is not Q4. */
|
|
2078
|
+
fiscal_period: "FY" | "Q1" | "Q2" | "Q3";
|
|
2205
2079
|
};
|
|
2080
|
+
header?: never;
|
|
2081
|
+
path?: never;
|
|
2206
2082
|
cookie?: never;
|
|
2207
2083
|
};
|
|
2208
2084
|
requestBody?: never;
|
|
2209
2085
|
responses: {
|
|
2210
|
-
/** @description
|
|
2086
|
+
/** @description Original report and subsequent amendments */
|
|
2211
2087
|
200: {
|
|
2212
2088
|
headers: {
|
|
2213
2089
|
"Cache-Control"?: string;
|
|
@@ -2222,16 +2098,16 @@ interface operations {
|
|
|
2222
2098
|
* @example {
|
|
2223
2099
|
* "filings": [
|
|
2224
2100
|
* {
|
|
2225
|
-
* "accepted_at": "
|
|
2226
|
-
* "accession_number": "0000320193-
|
|
2227
|
-
* "content_url": "/v1/sec/company-reports/0000320193-
|
|
2228
|
-
* "form": "10-
|
|
2229
|
-
* "period_end_date": "
|
|
2230
|
-
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/
|
|
2101
|
+
* "accepted_at": "2024-11-01T10:00:00.000Z",
|
|
2102
|
+
* "accession_number": "0000320193-24-000123",
|
|
2103
|
+
* "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
|
|
2104
|
+
* "form": "10-K",
|
|
2105
|
+
* "period_end_date": "2024-09-28",
|
|
2106
|
+
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
|
|
2231
2107
|
* }
|
|
2232
2108
|
* ],
|
|
2233
|
-
* "fiscal_period": "
|
|
2234
|
-
* "fiscal_year":
|
|
2109
|
+
* "fiscal_period": "FY",
|
|
2110
|
+
* "fiscal_year": 2024,
|
|
2235
2111
|
* "issuer": {
|
|
2236
2112
|
* "cik": "0000320193",
|
|
2237
2113
|
* "name": "Apple Inc.",
|
|
@@ -2242,13 +2118,16 @@ interface operations {
|
|
|
2242
2118
|
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
2243
2119
|
};
|
|
2244
2120
|
};
|
|
2245
|
-
/** @description
|
|
2121
|
+
/** @description Supply one identifier, a valid fiscal year and FY, Q1, Q2 or Q3; no extra or repeated keys. */
|
|
2246
2122
|
400: {
|
|
2247
2123
|
headers: {
|
|
2248
2124
|
[name: string]: unknown;
|
|
2249
2125
|
};
|
|
2250
2126
|
content: {
|
|
2251
|
-
"application/json":
|
|
2127
|
+
"application/json": {
|
|
2128
|
+
/** @enum {string} */
|
|
2129
|
+
error: "invalid_query_parameters";
|
|
2130
|
+
};
|
|
2252
2131
|
};
|
|
2253
2132
|
};
|
|
2254
2133
|
/** @description The request is missing a valid Chadwin API key. */
|
|
@@ -2269,22 +2148,28 @@ interface operations {
|
|
|
2269
2148
|
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
2270
2149
|
};
|
|
2271
2150
|
};
|
|
2272
|
-
/** @description The
|
|
2151
|
+
/** @description The ticker is unresolved or no eligible report family exists. */
|
|
2273
2152
|
404: {
|
|
2274
2153
|
headers: {
|
|
2275
2154
|
[name: string]: unknown;
|
|
2276
2155
|
};
|
|
2277
2156
|
content: {
|
|
2278
|
-
"application/json":
|
|
2157
|
+
"application/json": {
|
|
2158
|
+
/** @enum {string} */
|
|
2159
|
+
error: "company_not_found" | "company_report_not_found";
|
|
2160
|
+
};
|
|
2279
2161
|
};
|
|
2280
2162
|
};
|
|
2281
|
-
/** @description
|
|
2163
|
+
/** @description The ticker matches multiple CIKs or multiple original reports match the selected period. */
|
|
2282
2164
|
409: {
|
|
2283
2165
|
headers: {
|
|
2284
2166
|
[name: string]: unknown;
|
|
2285
2167
|
};
|
|
2286
2168
|
content: {
|
|
2287
|
-
"application/json":
|
|
2169
|
+
"application/json": {
|
|
2170
|
+
/** @enum {string} */
|
|
2171
|
+
error: "company_ambiguous" | "company_report_ambiguous";
|
|
2172
|
+
};
|
|
2288
2173
|
};
|
|
2289
2174
|
};
|
|
2290
2175
|
/** @description The request exceeded a rate limit. */
|
|
@@ -2313,6 +2198,113 @@ interface operations {
|
|
|
2313
2198
|
};
|
|
2314
2199
|
};
|
|
2315
2200
|
};
|
|
2201
|
+
searchCompanies: {
|
|
2202
|
+
parameters: {
|
|
2203
|
+
query: {
|
|
2204
|
+
/** @description Company name, stored ticker association, or padded or unpadded CIK. */
|
|
2205
|
+
query: string;
|
|
2206
|
+
};
|
|
2207
|
+
header?: never;
|
|
2208
|
+
path?: never;
|
|
2209
|
+
cookie?: never;
|
|
2210
|
+
};
|
|
2211
|
+
requestBody?: never;
|
|
2212
|
+
responses: {
|
|
2213
|
+
/** @description Ranked company matches. */
|
|
2214
|
+
200: {
|
|
2215
|
+
headers: {
|
|
2216
|
+
"Cache-Control"?: string;
|
|
2217
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2218
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2219
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2220
|
+
[name: string]: unknown;
|
|
2221
|
+
};
|
|
2222
|
+
content: {
|
|
2223
|
+
/**
|
|
2224
|
+
* @example {
|
|
2225
|
+
* "companies": [
|
|
2226
|
+
* {
|
|
2227
|
+
* "cik": "0000051143",
|
|
2228
|
+
* "fiscal_year_end": "1231",
|
|
2229
|
+
* "listings": [
|
|
2230
|
+
* {
|
|
2231
|
+
* "exchange": "NYSE",
|
|
2232
|
+
* "share_class_figi": "BBG001S5S399",
|
|
2233
|
+
* "ticker": "IBM"
|
|
2234
|
+
* }
|
|
2235
|
+
* ],
|
|
2236
|
+
* "name": "International Business Machines Corporation",
|
|
2237
|
+
* "sic": {
|
|
2238
|
+
* "code": "3570",
|
|
2239
|
+
* "industry_title": "COMPUTER & OFFICE EQUIPMENT",
|
|
2240
|
+
* "office": "Office of Technology"
|
|
2241
|
+
* }
|
|
2242
|
+
* }
|
|
2243
|
+
* ]
|
|
2244
|
+
* }
|
|
2245
|
+
*/
|
|
2246
|
+
"application/json": components["schemas"]["CompanySearchResponse"];
|
|
2247
|
+
};
|
|
2248
|
+
};
|
|
2249
|
+
/** @description The query is missing, invalid, or has unsupported keys. */
|
|
2250
|
+
400: {
|
|
2251
|
+
headers: {
|
|
2252
|
+
[name: string]: unknown;
|
|
2253
|
+
};
|
|
2254
|
+
content: {
|
|
2255
|
+
/**
|
|
2256
|
+
* @example {
|
|
2257
|
+
* "error": "invalid_query"
|
|
2258
|
+
* }
|
|
2259
|
+
*/
|
|
2260
|
+
"application/json": components["schemas"]["CompanySearchBadRequestResponse"];
|
|
2261
|
+
};
|
|
2262
|
+
};
|
|
2263
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
2264
|
+
401: {
|
|
2265
|
+
headers: {
|
|
2266
|
+
[name: string]: unknown;
|
|
2267
|
+
};
|
|
2268
|
+
content: {
|
|
2269
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2270
|
+
};
|
|
2271
|
+
};
|
|
2272
|
+
/** @description The request exceeded a rate limit. */
|
|
2273
|
+
429: {
|
|
2274
|
+
headers: {
|
|
2275
|
+
"RateLimit-Limit"?: string;
|
|
2276
|
+
"RateLimit-Reset"?: string;
|
|
2277
|
+
"Retry-After"?: string;
|
|
2278
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2279
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2280
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2281
|
+
[name: string]: unknown;
|
|
2282
|
+
};
|
|
2283
|
+
content: {
|
|
2284
|
+
/**
|
|
2285
|
+
* @example {
|
|
2286
|
+
* "error": "rate_limited"
|
|
2287
|
+
* }
|
|
2288
|
+
*/
|
|
2289
|
+
"application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
|
|
2290
|
+
};
|
|
2291
|
+
};
|
|
2292
|
+
/** @description The database is unavailable. */
|
|
2293
|
+
503: {
|
|
2294
|
+
headers: {
|
|
2295
|
+
[name: string]: unknown;
|
|
2296
|
+
};
|
|
2297
|
+
content: {
|
|
2298
|
+
/**
|
|
2299
|
+
* @example {
|
|
2300
|
+
* "error": "database_unavailable"
|
|
2301
|
+
* }
|
|
2302
|
+
*/
|
|
2303
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2304
|
+
};
|
|
2305
|
+
};
|
|
2306
|
+
};
|
|
2307
|
+
};
|
|
2316
2308
|
listCompanyReportFeed: {
|
|
2317
2309
|
parameters: {
|
|
2318
2310
|
query?: {
|
|
@@ -4565,20 +4557,24 @@ interface operations {
|
|
|
4565
4557
|
}
|
|
4566
4558
|
|
|
4567
4559
|
type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
|
|
4568
|
-
type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
|
|
4569
|
-
type
|
|
4560
|
+
type CompanyReportFiscalPeriod = "FY" | "Q1" | "Q2" | "Q3";
|
|
4561
|
+
type CompanySelector = {
|
|
4570
4562
|
ticker: string;
|
|
4563
|
+
cik?: never;
|
|
4564
|
+
} | {
|
|
4565
|
+
cik: string;
|
|
4566
|
+
ticker?: never;
|
|
4567
|
+
};
|
|
4568
|
+
type FinancialStatementsGetParams = CompanySelector & ({
|
|
4571
4569
|
fiscalYear: number;
|
|
4572
4570
|
years?: never;
|
|
4573
4571
|
} | {
|
|
4574
|
-
ticker: string;
|
|
4575
4572
|
years: number;
|
|
4576
4573
|
fiscalYear?: never;
|
|
4577
4574
|
} | {
|
|
4578
|
-
ticker: string;
|
|
4579
4575
|
fiscalYear?: never;
|
|
4580
4576
|
years?: never;
|
|
4581
|
-
};
|
|
4577
|
+
});
|
|
4582
4578
|
type InsiderActivityForm = "3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "144" | "144/A";
|
|
4583
4579
|
type InsiderTransactionCode = "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
|
|
4584
4580
|
type InstitutionalFilingForm = "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
|
|
@@ -4696,9 +4692,7 @@ declare class Companies {
|
|
|
4696
4692
|
search({ query }: {
|
|
4697
4693
|
query: string;
|
|
4698
4694
|
}): PromiseWithResponse<JsonResponse<"searchCompanies">>;
|
|
4699
|
-
get({ ticker }:
|
|
4700
|
-
ticker: string;
|
|
4701
|
-
}): PromiseWithResponse<JsonResponse<"getCompany">>;
|
|
4695
|
+
get({ ticker, cik }: CompanySelector): PromiseWithResponse<JsonResponse<"getCompany">>;
|
|
4702
4696
|
}
|
|
4703
4697
|
declare class CompanyReports {
|
|
4704
4698
|
private readonly transport;
|
|
@@ -4706,15 +4700,10 @@ declare class CompanyReports {
|
|
|
4706
4700
|
get({ accessionNumber, }: {
|
|
4707
4701
|
accessionNumber: string;
|
|
4708
4702
|
}): PromiseWithResponse<JsonResponse<"getSecCompanyReport">>;
|
|
4709
|
-
|
|
4710
|
-
ticker: string;
|
|
4711
|
-
fiscalYear: number;
|
|
4712
|
-
}): PromiseWithResponse<JsonResponse<"getCompanyReport">>;
|
|
4713
|
-
getByFiscalPeriod({ ticker, fiscalYear, fiscalPeriod, }: {
|
|
4714
|
-
ticker: string;
|
|
4703
|
+
getForPeriod({ ticker, cik, fiscalYear, fiscalPeriod }: CompanySelector & {
|
|
4715
4704
|
fiscalYear: number;
|
|
4716
4705
|
fiscalPeriod: CompanyReportFiscalPeriod;
|
|
4717
|
-
}): PromiseWithResponse<JsonResponse<"
|
|
4706
|
+
}): PromiseWithResponse<JsonResponse<"getCompanyReportsForPeriod">>;
|
|
4718
4707
|
getHtml({ accessionNumber, }: {
|
|
4719
4708
|
accessionNumber: string;
|
|
4720
4709
|
}): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
|
|
@@ -4722,7 +4711,7 @@ declare class CompanyReports {
|
|
|
4722
4711
|
declare class FinancialStatements {
|
|
4723
4712
|
private readonly transport;
|
|
4724
4713
|
constructor(transport: HttpTransport);
|
|
4725
|
-
get({ ticker, fiscalYear, years, }: FinancialStatementsGetParams): PromiseWithResponse<JsonResponse<"getCompanyFinancialStatements">>;
|
|
4714
|
+
get({ ticker, cik, fiscalYear, years, }: FinancialStatementsGetParams): PromiseWithResponse<JsonResponse<"getCompanyFinancialStatements">>;
|
|
4726
4715
|
}
|
|
4727
4716
|
declare class InsiderTransactions {
|
|
4728
4717
|
private readonly transport;
|
|
@@ -4890,4 +4879,4 @@ declare class APIError extends Error {
|
|
|
4890
4879
|
constructor(message: string, options?: APIErrorOptions);
|
|
4891
4880
|
}
|
|
4892
4881
|
|
|
4893
|
-
export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportFiscalPeriod, type CompanyReportForm, type FinancialStatementsGetParams, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };
|
|
4882
|
+
export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportFiscalPeriod, type CompanyReportForm, type CompanySelector, type FinancialStatementsGetParams, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };
|