@chadwin/sdk 0.7.0 → 0.8.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 +7 -0
- package/dist/index.cjs +8 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +664 -327
- package/dist/index.d.ts +664 -327
- package/dist/index.js +8 -4
- 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,6 +1440,18 @@ interface operations {
|
|
|
1508
1440
|
"application/json": components["schemas"]["CompanyReferenceResponse"];
|
|
1509
1441
|
};
|
|
1510
1442
|
};
|
|
1443
|
+
/** @description Supply exactly one valid ticker or CIK and no other query keys. */
|
|
1444
|
+
400: {
|
|
1445
|
+
headers: {
|
|
1446
|
+
[name: string]: unknown;
|
|
1447
|
+
};
|
|
1448
|
+
content: {
|
|
1449
|
+
"application/json": {
|
|
1450
|
+
/** @enum {string} */
|
|
1451
|
+
error: "invalid_query_parameters";
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
1511
1455
|
/** @description The request is missing a valid Chadwin API key. */
|
|
1512
1456
|
401: {
|
|
1513
1457
|
headers: {
|
|
@@ -1517,7 +1461,7 @@ interface operations {
|
|
|
1517
1461
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1518
1462
|
};
|
|
1519
1463
|
};
|
|
1520
|
-
/** @description The ticker does not resolve
|
|
1464
|
+
/** @description The ticker does not resolve, or the selected CIK has no stored company profile. */
|
|
1521
1465
|
404: {
|
|
1522
1466
|
headers: {
|
|
1523
1467
|
[name: string]: unknown;
|
|
@@ -1531,6 +1475,18 @@ interface operations {
|
|
|
1531
1475
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1532
1476
|
};
|
|
1533
1477
|
};
|
|
1478
|
+
/** @description The ticker matches multiple CIKs. */
|
|
1479
|
+
409: {
|
|
1480
|
+
headers: {
|
|
1481
|
+
[name: string]: unknown;
|
|
1482
|
+
};
|
|
1483
|
+
content: {
|
|
1484
|
+
"application/json": {
|
|
1485
|
+
/** @enum {string} */
|
|
1486
|
+
error: "company_ambiguous";
|
|
1487
|
+
};
|
|
1488
|
+
};
|
|
1489
|
+
};
|
|
1534
1490
|
/** @description The request exceeded a rate limit. */
|
|
1535
1491
|
429: {
|
|
1536
1492
|
headers: {
|
|
@@ -1567,13 +1523,19 @@ interface operations {
|
|
|
1567
1523
|
};
|
|
1568
1524
|
};
|
|
1569
1525
|
};
|
|
1570
|
-
|
|
1526
|
+
listCompanyInsiderTransactions: {
|
|
1571
1527
|
parameters: {
|
|
1572
|
-
query
|
|
1573
|
-
/** @description
|
|
1574
|
-
|
|
1575
|
-
/** @description
|
|
1576
|
-
|
|
1528
|
+
query: {
|
|
1529
|
+
/** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
|
|
1530
|
+
cursor?: string;
|
|
1531
|
+
/** @description Rows per page from 1 through 1000. Defaults to 1000. */
|
|
1532
|
+
limit?: string;
|
|
1533
|
+
/** @description Optional comma-separated SEC insider transaction codes to include. Supported codes: A, C, D, E, F, G, H, I, J, K, L, M, O, P, S, U, V, W, X, Z. Omitted or empty means all supported codes. */
|
|
1534
|
+
transaction_codes?: string;
|
|
1535
|
+
/** @description Required inclusive SEC filing-date lower bound in YYYY-MM-DD format. */
|
|
1536
|
+
from: string;
|
|
1537
|
+
/** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
|
|
1538
|
+
until?: string;
|
|
1577
1539
|
};
|
|
1578
1540
|
header?: never;
|
|
1579
1541
|
path: {
|
|
@@ -1584,7 +1546,7 @@ interface operations {
|
|
|
1584
1546
|
};
|
|
1585
1547
|
requestBody?: never;
|
|
1586
1548
|
responses: {
|
|
1587
|
-
/** @description
|
|
1549
|
+
/** @description Company insider transactions filed during the requested coverage window. */
|
|
1588
1550
|
200: {
|
|
1589
1551
|
headers: {
|
|
1590
1552
|
"Cache-Control"?: string;
|
|
@@ -1596,193 +1558,27 @@ interface operations {
|
|
|
1596
1558
|
content: {
|
|
1597
1559
|
/**
|
|
1598
1560
|
* @example {
|
|
1561
|
+
* "has_more": false,
|
|
1599
1562
|
* "issuer": {
|
|
1600
1563
|
* "cik": "0000320193",
|
|
1601
1564
|
* "name": "Apple Inc.",
|
|
1602
1565
|
* "ticker": "AAPL"
|
|
1603
1566
|
* },
|
|
1604
|
-
* "
|
|
1567
|
+
* "next_cursor": null,
|
|
1568
|
+
* "transactions": [
|
|
1605
1569
|
* {
|
|
1606
|
-
* "
|
|
1607
|
-
* "
|
|
1608
|
-
*
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1613
|
-
*
|
|
1614
|
-
* "
|
|
1615
|
-
* "
|
|
1616
|
-
*
|
|
1617
|
-
*
|
|
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. */
|
|
1651
|
-
400: {
|
|
1652
|
-
headers: {
|
|
1653
|
-
[name: string]: unknown;
|
|
1654
|
-
};
|
|
1655
|
-
content: {
|
|
1656
|
-
"application/json": components["schemas"]["FinancialStatementsBadRequest"];
|
|
1657
|
-
};
|
|
1658
|
-
};
|
|
1659
|
-
/** @description The request is missing a valid Chadwin API key. */
|
|
1660
|
-
401: {
|
|
1661
|
-
headers: {
|
|
1662
|
-
[name: string]: unknown;
|
|
1663
|
-
};
|
|
1664
|
-
content: {
|
|
1665
|
-
"application/json": components["schemas"]["FinancialStatementsUnauthorized"];
|
|
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"];
|
|
1675
|
-
};
|
|
1676
|
-
};
|
|
1677
|
-
/** @description No current company has the requested ticker. */
|
|
1678
|
-
404: {
|
|
1679
|
-
headers: {
|
|
1680
|
-
[name: string]: unknown;
|
|
1681
|
-
};
|
|
1682
|
-
content: {
|
|
1683
|
-
"application/json": components["schemas"]["FinancialStatementsCompanyNotFound"];
|
|
1684
|
-
};
|
|
1685
|
-
};
|
|
1686
|
-
/** @description More than one current company has the ticker. */
|
|
1687
|
-
409: {
|
|
1688
|
-
headers: {
|
|
1689
|
-
[name: string]: unknown;
|
|
1690
|
-
};
|
|
1691
|
-
content: {
|
|
1692
|
-
"application/json": components["schemas"]["FinancialStatementsTickerAmbiguous"];
|
|
1693
|
-
};
|
|
1694
|
-
};
|
|
1695
|
-
/** @description The request exceeded a rate limit or monthly quota. */
|
|
1696
|
-
429: {
|
|
1697
|
-
headers: {
|
|
1698
|
-
"RateLimit-Limit"?: string;
|
|
1699
|
-
"RateLimit-Reset"?: string;
|
|
1700
|
-
"Retry-After"?: string;
|
|
1701
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1702
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1703
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1704
|
-
[name: string]: unknown;
|
|
1705
|
-
};
|
|
1706
|
-
content: {
|
|
1707
|
-
"application/json": components["schemas"]["FinancialStatementsTooManyRequests"];
|
|
1708
|
-
};
|
|
1709
|
-
};
|
|
1710
|
-
/** @description A stored result cannot map to the public schema. */
|
|
1711
|
-
500: {
|
|
1712
|
-
headers: {
|
|
1713
|
-
[name: string]: unknown;
|
|
1714
|
-
};
|
|
1715
|
-
content: {
|
|
1716
|
-
"application/json": components["schemas"]["FinancialStatementsInternalError"];
|
|
1717
|
-
};
|
|
1718
|
-
};
|
|
1719
|
-
/** @description The database is unavailable. */
|
|
1720
|
-
503: {
|
|
1721
|
-
headers: {
|
|
1722
|
-
[name: string]: unknown;
|
|
1723
|
-
};
|
|
1724
|
-
content: {
|
|
1725
|
-
"application/json": components["schemas"]["FinancialStatementsUnavailable"];
|
|
1726
|
-
};
|
|
1727
|
-
};
|
|
1728
|
-
};
|
|
1729
|
-
};
|
|
1730
|
-
listCompanyInsiderTransactions: {
|
|
1731
|
-
parameters: {
|
|
1732
|
-
query: {
|
|
1733
|
-
/** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
|
|
1734
|
-
cursor?: string;
|
|
1735
|
-
/** @description Rows per page from 1 through 1000. Defaults to 1000. */
|
|
1736
|
-
limit?: string;
|
|
1737
|
-
/** @description Optional comma-separated SEC insider transaction codes to include. Supported codes: A, C, D, E, F, G, H, I, J, K, L, M, O, P, S, U, V, W, X, Z. Omitted or empty means all supported codes. */
|
|
1738
|
-
transaction_codes?: string;
|
|
1739
|
-
/** @description Required inclusive SEC filing-date lower bound in YYYY-MM-DD format. */
|
|
1740
|
-
from: string;
|
|
1741
|
-
/** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
|
|
1742
|
-
until?: string;
|
|
1743
|
-
};
|
|
1744
|
-
header?: never;
|
|
1745
|
-
path: {
|
|
1746
|
-
/** @description US listed company ticker */
|
|
1747
|
-
ticker: string;
|
|
1748
|
-
};
|
|
1749
|
-
cookie?: never;
|
|
1750
|
-
};
|
|
1751
|
-
requestBody?: never;
|
|
1752
|
-
responses: {
|
|
1753
|
-
/** @description Company insider transactions filed during the requested coverage window. */
|
|
1754
|
-
200: {
|
|
1755
|
-
headers: {
|
|
1756
|
-
"Cache-Control"?: string;
|
|
1757
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1758
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1759
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1760
|
-
[name: string]: unknown;
|
|
1761
|
-
};
|
|
1762
|
-
content: {
|
|
1763
|
-
/**
|
|
1764
|
-
* @example {
|
|
1765
|
-
* "has_more": false,
|
|
1766
|
-
* "issuer": {
|
|
1767
|
-
* "cik": "0000320193",
|
|
1768
|
-
* "name": "Apple Inc.",
|
|
1769
|
-
* "ticker": "AAPL"
|
|
1770
|
-
* },
|
|
1771
|
-
* "next_cursor": null,
|
|
1772
|
-
* "transactions": [
|
|
1773
|
-
* {
|
|
1774
|
-
* "accepted_at": "2026-05-29T22:30:27.000Z",
|
|
1775
|
-
* "accession_number": "0001140361-26-023363",
|
|
1776
|
-
* "acquired_disposed_code": "D",
|
|
1777
|
-
* "conversion_or_exercise_price": null,
|
|
1778
|
-
* "deemed_execution_date": null,
|
|
1779
|
-
* "equity_swap_involved": false,
|
|
1780
|
-
* "exercise_date": null,
|
|
1781
|
-
* "expiration_date": null,
|
|
1782
|
-
* "field_footnote_ids": {
|
|
1783
|
-
* "price": [
|
|
1784
|
-
* "F1"
|
|
1785
|
-
* ]
|
|
1570
|
+
* "accepted_at": "2026-05-29T22:30:27.000Z",
|
|
1571
|
+
* "accession_number": "0001140361-26-023363",
|
|
1572
|
+
* "acquired_disposed_code": "D",
|
|
1573
|
+
* "conversion_or_exercise_price": null,
|
|
1574
|
+
* "deemed_execution_date": null,
|
|
1575
|
+
* "equity_swap_involved": false,
|
|
1576
|
+
* "exercise_date": null,
|
|
1577
|
+
* "expiration_date": null,
|
|
1578
|
+
* "field_footnote_ids": {
|
|
1579
|
+
* "price": [
|
|
1580
|
+
* "F1"
|
|
1581
|
+
* ]
|
|
1786
1582
|
* },
|
|
1787
1583
|
* "footnote_ids": [
|
|
1788
1584
|
* "F1"
|
|
@@ -2041,8 +1837,245 @@ interface operations {
|
|
|
2041
1837
|
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
2042
1838
|
};
|
|
2043
1839
|
};
|
|
2044
|
-
/** @description The requested company was not found */
|
|
2045
|
-
404: {
|
|
1840
|
+
/** @description The requested company was not found */
|
|
1841
|
+
404: {
|
|
1842
|
+
headers: {
|
|
1843
|
+
[name: string]: unknown;
|
|
1844
|
+
};
|
|
1845
|
+
content: {
|
|
1846
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
/** @description The request exceeded a rate limit. */
|
|
1850
|
+
429: {
|
|
1851
|
+
headers: {
|
|
1852
|
+
"RateLimit-Limit"?: string;
|
|
1853
|
+
"RateLimit-Reset"?: string;
|
|
1854
|
+
"Retry-After"?: string;
|
|
1855
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
1856
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1857
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
1858
|
+
[name: string]: unknown;
|
|
1859
|
+
};
|
|
1860
|
+
content: {
|
|
1861
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1862
|
+
};
|
|
1863
|
+
};
|
|
1864
|
+
/** @description The database is unavailable */
|
|
1865
|
+
503: {
|
|
1866
|
+
headers: {
|
|
1867
|
+
[name: string]: unknown;
|
|
1868
|
+
};
|
|
1869
|
+
content: {
|
|
1870
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1871
|
+
};
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
};
|
|
1875
|
+
getCompanyReport: {
|
|
1876
|
+
parameters: {
|
|
1877
|
+
query?: never;
|
|
1878
|
+
header?: never;
|
|
1879
|
+
path: {
|
|
1880
|
+
ticker: string;
|
|
1881
|
+
fiscal_year: string;
|
|
1882
|
+
};
|
|
1883
|
+
cookie?: never;
|
|
1884
|
+
};
|
|
1885
|
+
requestBody?: never;
|
|
1886
|
+
responses: {
|
|
1887
|
+
/** @description Annual report filing family */
|
|
1888
|
+
200: {
|
|
1889
|
+
headers: {
|
|
1890
|
+
"Cache-Control"?: string;
|
|
1891
|
+
ETag?: string;
|
|
1892
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
1893
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1894
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
1895
|
+
[name: string]: unknown;
|
|
1896
|
+
};
|
|
1897
|
+
content: {
|
|
1898
|
+
/**
|
|
1899
|
+
* @example {
|
|
1900
|
+
* "filings": [
|
|
1901
|
+
* {
|
|
1902
|
+
* "accepted_at": "2024-11-01T10:00:00.000Z",
|
|
1903
|
+
* "accession_number": "0000320193-24-000123",
|
|
1904
|
+
* "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
|
|
1905
|
+
* "form": "10-K",
|
|
1906
|
+
* "period_end_date": "2024-09-28",
|
|
1907
|
+
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
|
|
1908
|
+
* }
|
|
1909
|
+
* ],
|
|
1910
|
+
* "fiscal_period": "FY",
|
|
1911
|
+
* "fiscal_year": 2024,
|
|
1912
|
+
* "issuer": {
|
|
1913
|
+
* "cik": "0000320193",
|
|
1914
|
+
* "name": "Apple Inc.",
|
|
1915
|
+
* "ticker": "AAPL"
|
|
1916
|
+
* }
|
|
1917
|
+
* }
|
|
1918
|
+
*/
|
|
1919
|
+
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
1920
|
+
};
|
|
1921
|
+
};
|
|
1922
|
+
/** @description The ticker or fiscal year is invalid */
|
|
1923
|
+
400: {
|
|
1924
|
+
headers: {
|
|
1925
|
+
[name: string]: unknown;
|
|
1926
|
+
};
|
|
1927
|
+
content: {
|
|
1928
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
1932
|
+
401: {
|
|
1933
|
+
headers: {
|
|
1934
|
+
[name: string]: unknown;
|
|
1935
|
+
};
|
|
1936
|
+
content: {
|
|
1937
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1938
|
+
};
|
|
1939
|
+
};
|
|
1940
|
+
/** @description The subscription does not include this dataset. */
|
|
1941
|
+
403: {
|
|
1942
|
+
headers: {
|
|
1943
|
+
[name: string]: unknown;
|
|
1944
|
+
};
|
|
1945
|
+
content: {
|
|
1946
|
+
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
1947
|
+
};
|
|
1948
|
+
};
|
|
1949
|
+
/** @description The company or eligible annual report was not found */
|
|
1950
|
+
404: {
|
|
1951
|
+
headers: {
|
|
1952
|
+
[name: string]: unknown;
|
|
1953
|
+
};
|
|
1954
|
+
content: {
|
|
1955
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1956
|
+
};
|
|
1957
|
+
};
|
|
1958
|
+
/** @description More than one original annual report matches the fiscal year */
|
|
1959
|
+
409: {
|
|
1960
|
+
headers: {
|
|
1961
|
+
[name: string]: unknown;
|
|
1962
|
+
};
|
|
1963
|
+
content: {
|
|
1964
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1965
|
+
};
|
|
1966
|
+
};
|
|
1967
|
+
/** @description The request exceeded a rate limit. */
|
|
1968
|
+
429: {
|
|
1969
|
+
headers: {
|
|
1970
|
+
"RateLimit-Limit"?: string;
|
|
1971
|
+
"RateLimit-Reset"?: string;
|
|
1972
|
+
"Retry-After"?: string;
|
|
1973
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
1974
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1975
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
1976
|
+
[name: string]: unknown;
|
|
1977
|
+
};
|
|
1978
|
+
content: {
|
|
1979
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
1982
|
+
/** @description The filing catalog is unavailable */
|
|
1983
|
+
503: {
|
|
1984
|
+
headers: {
|
|
1985
|
+
[name: string]: unknown;
|
|
1986
|
+
};
|
|
1987
|
+
content: {
|
|
1988
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1991
|
+
};
|
|
1992
|
+
};
|
|
1993
|
+
getCompanyReportForFiscalPeriod: {
|
|
1994
|
+
parameters: {
|
|
1995
|
+
query?: never;
|
|
1996
|
+
header?: never;
|
|
1997
|
+
path: {
|
|
1998
|
+
ticker: string;
|
|
1999
|
+
fiscal_year: string;
|
|
2000
|
+
fiscal_period: "Q1" | "Q2" | "Q3";
|
|
2001
|
+
};
|
|
2002
|
+
cookie?: never;
|
|
2003
|
+
};
|
|
2004
|
+
requestBody?: never;
|
|
2005
|
+
responses: {
|
|
2006
|
+
/** @description Quarterly report filing family */
|
|
2007
|
+
200: {
|
|
2008
|
+
headers: {
|
|
2009
|
+
"Cache-Control"?: string;
|
|
2010
|
+
ETag?: string;
|
|
2011
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2012
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2013
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2014
|
+
[name: string]: unknown;
|
|
2015
|
+
};
|
|
2016
|
+
content: {
|
|
2017
|
+
/**
|
|
2018
|
+
* @example {
|
|
2019
|
+
* "filings": [
|
|
2020
|
+
* {
|
|
2021
|
+
* "accepted_at": "2025-08-01T10:00:42.000Z",
|
|
2022
|
+
* "accession_number": "0000320193-25-000073",
|
|
2023
|
+
* "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
|
|
2024
|
+
* "form": "10-Q",
|
|
2025
|
+
* "period_end_date": "2025-06-28",
|
|
2026
|
+
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
|
|
2027
|
+
* }
|
|
2028
|
+
* ],
|
|
2029
|
+
* "fiscal_period": "Q3",
|
|
2030
|
+
* "fiscal_year": 2025,
|
|
2031
|
+
* "issuer": {
|
|
2032
|
+
* "cik": "0000320193",
|
|
2033
|
+
* "name": "Apple Inc.",
|
|
2034
|
+
* "ticker": "AAPL"
|
|
2035
|
+
* }
|
|
2036
|
+
* }
|
|
2037
|
+
*/
|
|
2038
|
+
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
2039
|
+
};
|
|
2040
|
+
};
|
|
2041
|
+
/** @description The ticker, fiscal year, or fiscal period is invalid */
|
|
2042
|
+
400: {
|
|
2043
|
+
headers: {
|
|
2044
|
+
[name: string]: unknown;
|
|
2045
|
+
};
|
|
2046
|
+
content: {
|
|
2047
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
2050
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
2051
|
+
401: {
|
|
2052
|
+
headers: {
|
|
2053
|
+
[name: string]: unknown;
|
|
2054
|
+
};
|
|
2055
|
+
content: {
|
|
2056
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2057
|
+
};
|
|
2058
|
+
};
|
|
2059
|
+
/** @description The subscription does not include this dataset. */
|
|
2060
|
+
403: {
|
|
2061
|
+
headers: {
|
|
2062
|
+
[name: string]: unknown;
|
|
2063
|
+
};
|
|
2064
|
+
content: {
|
|
2065
|
+
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
2066
|
+
};
|
|
2067
|
+
};
|
|
2068
|
+
/** @description The company or eligible quarterly report was not found */
|
|
2069
|
+
404: {
|
|
2070
|
+
headers: {
|
|
2071
|
+
[name: string]: unknown;
|
|
2072
|
+
};
|
|
2073
|
+
content: {
|
|
2074
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2075
|
+
};
|
|
2076
|
+
};
|
|
2077
|
+
/** @description More than one original quarterly report matches the fiscal period */
|
|
2078
|
+
409: {
|
|
2046
2079
|
headers: {
|
|
2047
2080
|
[name: string]: unknown;
|
|
2048
2081
|
};
|
|
@@ -2065,7 +2098,7 @@ interface operations {
|
|
|
2065
2098
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2066
2099
|
};
|
|
2067
2100
|
};
|
|
2068
|
-
/** @description The
|
|
2101
|
+
/** @description The filing catalog is unavailable */
|
|
2069
2102
|
503: {
|
|
2070
2103
|
headers: {
|
|
2071
2104
|
[name: string]: unknown;
|
|
@@ -2076,13 +2109,14 @@ interface operations {
|
|
|
2076
2109
|
};
|
|
2077
2110
|
};
|
|
2078
2111
|
};
|
|
2079
|
-
|
|
2112
|
+
getCompanyReportByCik: {
|
|
2080
2113
|
parameters: {
|
|
2081
2114
|
query?: never;
|
|
2082
2115
|
header?: never;
|
|
2083
2116
|
path: {
|
|
2084
|
-
ticker: string;
|
|
2085
2117
|
fiscal_year: string;
|
|
2118
|
+
/** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
|
|
2119
|
+
cik: string;
|
|
2086
2120
|
};
|
|
2087
2121
|
cookie?: never;
|
|
2088
2122
|
};
|
|
@@ -2123,7 +2157,7 @@ interface operations {
|
|
|
2123
2157
|
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
2124
2158
|
};
|
|
2125
2159
|
};
|
|
2126
|
-
/** @description The
|
|
2160
|
+
/** @description The cik or fiscal year is invalid */
|
|
2127
2161
|
400: {
|
|
2128
2162
|
headers: {
|
|
2129
2163
|
[name: string]: unknown;
|
|
@@ -2194,13 +2228,14 @@ interface operations {
|
|
|
2194
2228
|
};
|
|
2195
2229
|
};
|
|
2196
2230
|
};
|
|
2197
|
-
|
|
2231
|
+
getCompanyReportByCikForFiscalPeriod: {
|
|
2198
2232
|
parameters: {
|
|
2199
2233
|
query?: never;
|
|
2200
2234
|
header?: never;
|
|
2201
2235
|
path: {
|
|
2202
|
-
ticker: string;
|
|
2203
2236
|
fiscal_year: string;
|
|
2237
|
+
/** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
|
|
2238
|
+
cik: string;
|
|
2204
2239
|
fiscal_period: "Q1" | "Q2" | "Q3";
|
|
2205
2240
|
};
|
|
2206
2241
|
cookie?: never;
|
|
@@ -2242,7 +2277,7 @@ interface operations {
|
|
|
2242
2277
|
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
2243
2278
|
};
|
|
2244
2279
|
};
|
|
2245
|
-
/** @description The
|
|
2280
|
+
/** @description The cik, fiscal year, or fiscal period is invalid */
|
|
2246
2281
|
400: {
|
|
2247
2282
|
headers: {
|
|
2248
2283
|
[name: string]: unknown;
|
|
@@ -2313,6 +2348,306 @@ interface operations {
|
|
|
2313
2348
|
};
|
|
2314
2349
|
};
|
|
2315
2350
|
};
|
|
2351
|
+
getCompanyFinancialStatements: {
|
|
2352
|
+
parameters: {
|
|
2353
|
+
query?: {
|
|
2354
|
+
/** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
|
|
2355
|
+
ticker?: string;
|
|
2356
|
+
/** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
|
|
2357
|
+
cik?: string;
|
|
2358
|
+
/** @description One fiscal year from 1900 through 9999. */
|
|
2359
|
+
fiscal_year?: number;
|
|
2360
|
+
/** @description Newest available fiscal years to return, from 1 through 20. */
|
|
2361
|
+
years?: number;
|
|
2362
|
+
};
|
|
2363
|
+
header?: never;
|
|
2364
|
+
path?: never;
|
|
2365
|
+
cookie?: never;
|
|
2366
|
+
};
|
|
2367
|
+
requestBody?: never;
|
|
2368
|
+
responses: {
|
|
2369
|
+
/** @description Published and reviewed normalized annual financial statements. */
|
|
2370
|
+
200: {
|
|
2371
|
+
headers: {
|
|
2372
|
+
"Cache-Control"?: string;
|
|
2373
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2374
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2375
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2376
|
+
[name: string]: unknown;
|
|
2377
|
+
};
|
|
2378
|
+
content: {
|
|
2379
|
+
/**
|
|
2380
|
+
* @example {
|
|
2381
|
+
* "issuer": {
|
|
2382
|
+
* "cik": "0000320193",
|
|
2383
|
+
* "name": "Apple Inc.",
|
|
2384
|
+
* "ticker": "AAPL"
|
|
2385
|
+
* },
|
|
2386
|
+
* "periods": [
|
|
2387
|
+
* {
|
|
2388
|
+
* "accession_number": "0000320193-25-000079",
|
|
2389
|
+
* "balance_sheet": {
|
|
2390
|
+
* "accounts_payable_current": "69860000000",
|
|
2391
|
+
* "accounts_receivable_current": "39777000000",
|
|
2392
|
+
* "cash_and_cash_equivalents": "35934000000",
|
|
2393
|
+
* "current_portion_of_long_term_debt": "12350000000",
|
|
2394
|
+
* "equity_attributable_to_parent": "73733000000",
|
|
2395
|
+
* "inventory": "5718000000",
|
|
2396
|
+
* "long_term_debt_noncurrent": "78328000000",
|
|
2397
|
+
* "property_plant_and_equipment_net": "49834000000",
|
|
2398
|
+
* "short_term_borrowings": "7979000000",
|
|
2399
|
+
* "short_term_investments": "18763000000",
|
|
2400
|
+
* "total_assets": "359241000000",
|
|
2401
|
+
* "total_current_assets": "147957000000",
|
|
2402
|
+
* "total_current_liabilities": "165631000000",
|
|
2403
|
+
* "total_liabilities": "285508000000",
|
|
2404
|
+
* "total_liabilities_and_equity": "359241000000"
|
|
2405
|
+
* },
|
|
2406
|
+
* "cash_flow_statement": {
|
|
2407
|
+
* "capital_expenditure": "12715000000",
|
|
2408
|
+
* "common_stock_repurchases": "90711000000",
|
|
2409
|
+
* "depreciation_and_amortization_adjustment": "11698000000",
|
|
2410
|
+
* "net_cash_from_financing_activities": "-120686000000",
|
|
2411
|
+
* "net_cash_from_investing_activities": "15195000000",
|
|
2412
|
+
* "net_cash_from_operating_activities": "111482000000",
|
|
2413
|
+
* "net_change_in_cash_cash_equivalents_and_restricted_cash_including_exchange_rate_effect": "5991000000",
|
|
2414
|
+
* "purchases_of_investments": "24407000000",
|
|
2415
|
+
* "share_based_compensation_adjustment": "12863000000"
|
|
2416
|
+
* },
|
|
2417
|
+
* "currency": "USD",
|
|
2418
|
+
* "fiscal_period": "FY",
|
|
2419
|
+
* "fiscal_year": 2025,
|
|
2420
|
+
* "income_statement": {
|
|
2421
|
+
* "basic_earnings_per_share": "7.49",
|
|
2422
|
+
* "basic_weighted_average_shares": "14948500000",
|
|
2423
|
+
* "cost_of_sales": "220960000000",
|
|
2424
|
+
* "diluted_earnings_per_share": "7.46",
|
|
2425
|
+
* "diluted_weighted_average_shares": "15004697000",
|
|
2426
|
+
* "gross_profit": "195201000000",
|
|
2427
|
+
* "income_before_income_taxes": "132729000000",
|
|
2428
|
+
* "income_tax_expense": "20719000000",
|
|
2429
|
+
* "net_income_attributable_to_parent": "112010000000",
|
|
2430
|
+
* "net_income_including_noncontrolling_interests": "112010000000",
|
|
2431
|
+
* "nonoperating_income_expense": "-321000000",
|
|
2432
|
+
* "operating_income": "133050000000",
|
|
2433
|
+
* "research_and_development_expense": "34550000000",
|
|
2434
|
+
* "revenue": "416161000000",
|
|
2435
|
+
* "selling_general_and_administrative_expense": "27601000000",
|
|
2436
|
+
* "total_operating_expenses": "62151000000"
|
|
2437
|
+
* },
|
|
2438
|
+
* "metrics": {
|
|
2439
|
+
* "asset_turnover": "1.15",
|
|
2440
|
+
* "cash_ratio": "0.22",
|
|
2441
|
+
* "current_ratio": "0.89",
|
|
2442
|
+
* "effective_tax_rate": "15.61",
|
|
2443
|
+
* "free_cash_flow": "98767000000",
|
|
2444
|
+
* "free_cash_flow_margin": "23.73",
|
|
2445
|
+
* "gross_margin": "46.91",
|
|
2446
|
+
* "net_margin": "26.92",
|
|
2447
|
+
* "operating_cash_flow_margin": "26.79",
|
|
2448
|
+
* "operating_cash_flow_to_net_income": "1.00",
|
|
2449
|
+
* "operating_margin": "31.97",
|
|
2450
|
+
* "pretax_margin": "31.89",
|
|
2451
|
+
* "quick_ratio": "0.57",
|
|
2452
|
+
* "return_on_assets": "30.93",
|
|
2453
|
+
* "return_on_equity": "171.42",
|
|
2454
|
+
* "working_capital": "-17674000000"
|
|
2455
|
+
* },
|
|
2456
|
+
* "period_end_date": "2025-09-27"
|
|
2457
|
+
* }
|
|
2458
|
+
* ]
|
|
2459
|
+
* }
|
|
2460
|
+
*/
|
|
2461
|
+
"application/json": components["schemas"]["CompanyFinancialStatementsResponse"];
|
|
2462
|
+
};
|
|
2463
|
+
};
|
|
2464
|
+
/** @description The identifier or query parameters are invalid. */
|
|
2465
|
+
400: {
|
|
2466
|
+
headers: {
|
|
2467
|
+
[name: string]: unknown;
|
|
2468
|
+
};
|
|
2469
|
+
content: {
|
|
2470
|
+
"application/json": components["schemas"]["FinancialStatementsBadRequest"];
|
|
2471
|
+
};
|
|
2472
|
+
};
|
|
2473
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
2474
|
+
401: {
|
|
2475
|
+
headers: {
|
|
2476
|
+
[name: string]: unknown;
|
|
2477
|
+
};
|
|
2478
|
+
content: {
|
|
2479
|
+
"application/json": components["schemas"]["FinancialStatementsUnauthorized"];
|
|
2480
|
+
};
|
|
2481
|
+
};
|
|
2482
|
+
/** @description The subscription does not include this dataset. */
|
|
2483
|
+
403: {
|
|
2484
|
+
headers: {
|
|
2485
|
+
[name: string]: unknown;
|
|
2486
|
+
};
|
|
2487
|
+
content: {
|
|
2488
|
+
"application/json": components["schemas"]["FinancialStatementsNotEntitled"];
|
|
2489
|
+
};
|
|
2490
|
+
};
|
|
2491
|
+
/** @description No company matches the requested ticker. */
|
|
2492
|
+
404: {
|
|
2493
|
+
headers: {
|
|
2494
|
+
[name: string]: unknown;
|
|
2495
|
+
};
|
|
2496
|
+
content: {
|
|
2497
|
+
"application/json": components["schemas"]["FinancialStatementsCompanyNotFound"];
|
|
2498
|
+
};
|
|
2499
|
+
};
|
|
2500
|
+
/** @description The ticker matches more than one CIK in the accepted SEC snapshot. */
|
|
2501
|
+
409: {
|
|
2502
|
+
headers: {
|
|
2503
|
+
[name: string]: unknown;
|
|
2504
|
+
};
|
|
2505
|
+
content: {
|
|
2506
|
+
"application/json": components["schemas"]["FinancialStatementsTickerAmbiguous"];
|
|
2507
|
+
};
|
|
2508
|
+
};
|
|
2509
|
+
/** @description The request exceeded a rate limit or monthly quota. */
|
|
2510
|
+
429: {
|
|
2511
|
+
headers: {
|
|
2512
|
+
"RateLimit-Limit"?: string;
|
|
2513
|
+
"RateLimit-Reset"?: string;
|
|
2514
|
+
"Retry-After"?: string;
|
|
2515
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2516
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2517
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2518
|
+
[name: string]: unknown;
|
|
2519
|
+
};
|
|
2520
|
+
content: {
|
|
2521
|
+
"application/json": components["schemas"]["FinancialStatementsTooManyRequests"];
|
|
2522
|
+
};
|
|
2523
|
+
};
|
|
2524
|
+
/** @description A stored result cannot map to the public schema. */
|
|
2525
|
+
500: {
|
|
2526
|
+
headers: {
|
|
2527
|
+
[name: string]: unknown;
|
|
2528
|
+
};
|
|
2529
|
+
content: {
|
|
2530
|
+
"application/json": components["schemas"]["FinancialStatementsInternalError"];
|
|
2531
|
+
};
|
|
2532
|
+
};
|
|
2533
|
+
/** @description The database is unavailable. */
|
|
2534
|
+
503: {
|
|
2535
|
+
headers: {
|
|
2536
|
+
[name: string]: unknown;
|
|
2537
|
+
};
|
|
2538
|
+
content: {
|
|
2539
|
+
"application/json": components["schemas"]["FinancialStatementsUnavailable"];
|
|
2540
|
+
};
|
|
2541
|
+
};
|
|
2542
|
+
};
|
|
2543
|
+
};
|
|
2544
|
+
searchCompanies: {
|
|
2545
|
+
parameters: {
|
|
2546
|
+
query: {
|
|
2547
|
+
/** @description Company name, stored ticker association, or padded or unpadded CIK. */
|
|
2548
|
+
query: string;
|
|
2549
|
+
};
|
|
2550
|
+
header?: never;
|
|
2551
|
+
path?: never;
|
|
2552
|
+
cookie?: never;
|
|
2553
|
+
};
|
|
2554
|
+
requestBody?: never;
|
|
2555
|
+
responses: {
|
|
2556
|
+
/** @description Ranked company matches. */
|
|
2557
|
+
200: {
|
|
2558
|
+
headers: {
|
|
2559
|
+
"Cache-Control"?: string;
|
|
2560
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2561
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2562
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2563
|
+
[name: string]: unknown;
|
|
2564
|
+
};
|
|
2565
|
+
content: {
|
|
2566
|
+
/**
|
|
2567
|
+
* @example {
|
|
2568
|
+
* "companies": [
|
|
2569
|
+
* {
|
|
2570
|
+
* "cik": "0000051143",
|
|
2571
|
+
* "fiscal_year_end": "1231",
|
|
2572
|
+
* "listings": [
|
|
2573
|
+
* {
|
|
2574
|
+
* "exchange": "NYSE",
|
|
2575
|
+
* "share_class_figi": "BBG001S5S399",
|
|
2576
|
+
* "ticker": "IBM"
|
|
2577
|
+
* }
|
|
2578
|
+
* ],
|
|
2579
|
+
* "name": "International Business Machines Corporation",
|
|
2580
|
+
* "sic": {
|
|
2581
|
+
* "code": "3570",
|
|
2582
|
+
* "industry_title": "COMPUTER & OFFICE EQUIPMENT",
|
|
2583
|
+
* "office": "Office of Technology"
|
|
2584
|
+
* }
|
|
2585
|
+
* }
|
|
2586
|
+
* ]
|
|
2587
|
+
* }
|
|
2588
|
+
*/
|
|
2589
|
+
"application/json": components["schemas"]["CompanySearchResponse"];
|
|
2590
|
+
};
|
|
2591
|
+
};
|
|
2592
|
+
/** @description The query is missing, invalid, or has unsupported keys. */
|
|
2593
|
+
400: {
|
|
2594
|
+
headers: {
|
|
2595
|
+
[name: string]: unknown;
|
|
2596
|
+
};
|
|
2597
|
+
content: {
|
|
2598
|
+
/**
|
|
2599
|
+
* @example {
|
|
2600
|
+
* "error": "invalid_query"
|
|
2601
|
+
* }
|
|
2602
|
+
*/
|
|
2603
|
+
"application/json": components["schemas"]["CompanySearchBadRequestResponse"];
|
|
2604
|
+
};
|
|
2605
|
+
};
|
|
2606
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
2607
|
+
401: {
|
|
2608
|
+
headers: {
|
|
2609
|
+
[name: string]: unknown;
|
|
2610
|
+
};
|
|
2611
|
+
content: {
|
|
2612
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2613
|
+
};
|
|
2614
|
+
};
|
|
2615
|
+
/** @description The request exceeded a rate limit. */
|
|
2616
|
+
429: {
|
|
2617
|
+
headers: {
|
|
2618
|
+
"RateLimit-Limit"?: string;
|
|
2619
|
+
"RateLimit-Reset"?: string;
|
|
2620
|
+
"Retry-After"?: string;
|
|
2621
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2622
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2623
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2624
|
+
[name: string]: unknown;
|
|
2625
|
+
};
|
|
2626
|
+
content: {
|
|
2627
|
+
/**
|
|
2628
|
+
* @example {
|
|
2629
|
+
* "error": "rate_limited"
|
|
2630
|
+
* }
|
|
2631
|
+
*/
|
|
2632
|
+
"application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
|
|
2633
|
+
};
|
|
2634
|
+
};
|
|
2635
|
+
/** @description The database is unavailable. */
|
|
2636
|
+
503: {
|
|
2637
|
+
headers: {
|
|
2638
|
+
[name: string]: unknown;
|
|
2639
|
+
};
|
|
2640
|
+
content: {
|
|
2641
|
+
/**
|
|
2642
|
+
* @example {
|
|
2643
|
+
* "error": "database_unavailable"
|
|
2644
|
+
* }
|
|
2645
|
+
*/
|
|
2646
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2647
|
+
};
|
|
2648
|
+
};
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2316
2651
|
listCompanyReportFeed: {
|
|
2317
2652
|
parameters: {
|
|
2318
2653
|
query?: {
|
|
@@ -4566,19 +4901,23 @@ interface operations {
|
|
|
4566
4901
|
|
|
4567
4902
|
type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
|
|
4568
4903
|
type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
|
|
4569
|
-
type
|
|
4904
|
+
type CompanySelector = {
|
|
4570
4905
|
ticker: string;
|
|
4906
|
+
cik?: never;
|
|
4907
|
+
} | {
|
|
4908
|
+
cik: string;
|
|
4909
|
+
ticker?: never;
|
|
4910
|
+
};
|
|
4911
|
+
type FinancialStatementsGetParams = CompanySelector & ({
|
|
4571
4912
|
fiscalYear: number;
|
|
4572
4913
|
years?: never;
|
|
4573
4914
|
} | {
|
|
4574
|
-
ticker: string;
|
|
4575
4915
|
years: number;
|
|
4576
4916
|
fiscalYear?: never;
|
|
4577
4917
|
} | {
|
|
4578
|
-
ticker: string;
|
|
4579
4918
|
fiscalYear?: never;
|
|
4580
4919
|
years?: never;
|
|
4581
|
-
};
|
|
4920
|
+
});
|
|
4582
4921
|
type InsiderActivityForm = "3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "144" | "144/A";
|
|
4583
4922
|
type InsiderTransactionCode = "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
|
|
4584
4923
|
type InstitutionalFilingForm = "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
|
|
@@ -4696,9 +5035,7 @@ declare class Companies {
|
|
|
4696
5035
|
search({ query }: {
|
|
4697
5036
|
query: string;
|
|
4698
5037
|
}): PromiseWithResponse<JsonResponse<"searchCompanies">>;
|
|
4699
|
-
get({ ticker }:
|
|
4700
|
-
ticker: string;
|
|
4701
|
-
}): PromiseWithResponse<JsonResponse<"getCompany">>;
|
|
5038
|
+
get({ ticker, cik }: CompanySelector): PromiseWithResponse<JsonResponse<"getCompany">>;
|
|
4702
5039
|
}
|
|
4703
5040
|
declare class CompanyReports {
|
|
4704
5041
|
private readonly transport;
|
|
@@ -4722,7 +5059,7 @@ declare class CompanyReports {
|
|
|
4722
5059
|
declare class FinancialStatements {
|
|
4723
5060
|
private readonly transport;
|
|
4724
5061
|
constructor(transport: HttpTransport);
|
|
4725
|
-
get({ ticker, fiscalYear, years, }: FinancialStatementsGetParams): PromiseWithResponse<JsonResponse<"getCompanyFinancialStatements">>;
|
|
5062
|
+
get({ ticker, cik, fiscalYear, years, }: FinancialStatementsGetParams): PromiseWithResponse<JsonResponse<"getCompanyFinancialStatements">>;
|
|
4726
5063
|
}
|
|
4727
5064
|
declare class InsiderTransactions {
|
|
4728
5065
|
private readonly transport;
|
|
@@ -4890,4 +5227,4 @@ declare class APIError extends Error {
|
|
|
4890
5227
|
constructor(message: string, options?: APIErrorOptions);
|
|
4891
5228
|
}
|
|
4892
5229
|
|
|
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 };
|
|
5230
|
+
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 };
|