@chadwin/sdk 0.6.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 +28 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +810 -142
- package/dist/index.d.ts +810 -142
- package/dist/index.js +28 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -7,6 +7,24 @@ interface PromiseWithResponse<T> extends Promise<T> {
|
|
|
7
7
|
|
|
8
8
|
interface components {
|
|
9
9
|
schemas: {
|
|
10
|
+
CompanyFinancialStatementPeriod: {
|
|
11
|
+
/** @description SEC filing used as the source for this period. EPS and weighted-average shares are adjusted for later stock splits. */
|
|
12
|
+
accession_number: string;
|
|
13
|
+
balance_sheet: components["schemas"]["FinancialStatementBalanceSheet"];
|
|
14
|
+
cash_flow_statement: components["schemas"]["FinancialStatementCashFlowStatement"];
|
|
15
|
+
currency: string;
|
|
16
|
+
/** @enum {string} */
|
|
17
|
+
fiscal_period: "FY";
|
|
18
|
+
fiscal_year: number;
|
|
19
|
+
income_statement: components["schemas"]["FinancialStatementIncomeStatement"];
|
|
20
|
+
metrics: components["schemas"]["FinancialStatementMetrics"];
|
|
21
|
+
/** Format: date */
|
|
22
|
+
period_end_date: string;
|
|
23
|
+
};
|
|
24
|
+
CompanyFinancialStatementsResponse: {
|
|
25
|
+
issuer: components["schemas"]["FinancialStatementIssuer"];
|
|
26
|
+
periods: components["schemas"]["CompanyFinancialStatementPeriod"][];
|
|
27
|
+
};
|
|
10
28
|
CompanyInsiderTransactionListItem: {
|
|
11
29
|
/**
|
|
12
30
|
* Format: date-time
|
|
@@ -152,7 +170,10 @@ interface components {
|
|
|
152
170
|
listings: {
|
|
153
171
|
/** @description Source exchange label. */
|
|
154
172
|
exchange: string | null;
|
|
155
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* @description Present in the accepted SEC ticker snapshot; does not establish trading or business status.
|
|
175
|
+
* @enum {boolean}
|
|
176
|
+
*/
|
|
156
177
|
is_current: true;
|
|
157
178
|
share_class_figi: string | null;
|
|
158
179
|
ticker: string;
|
|
@@ -242,7 +263,36 @@ interface components {
|
|
|
242
263
|
error: "invalid_query" | "invalid_query_parameters";
|
|
243
264
|
};
|
|
244
265
|
CompanySearchResponse: {
|
|
245
|
-
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;
|
|
246
296
|
};
|
|
247
297
|
DatasetNotEntitledErrorResponse: {
|
|
248
298
|
/** @enum {string} */
|
|
@@ -252,6 +302,128 @@ interface components {
|
|
|
252
302
|
/** @example unauthorized */
|
|
253
303
|
error: string;
|
|
254
304
|
};
|
|
305
|
+
FinancialStatementBalanceSheet: {
|
|
306
|
+
accounts_payable_current?: string;
|
|
307
|
+
accounts_receivable_current?: string;
|
|
308
|
+
cash_and_cash_equivalents?: string;
|
|
309
|
+
current_portion_of_long_term_debt?: string;
|
|
310
|
+
equity_attributable_to_parent?: string;
|
|
311
|
+
goodwill?: string;
|
|
312
|
+
intangible_assets_net_excluding_goodwill?: string;
|
|
313
|
+
inventory?: string;
|
|
314
|
+
long_term_debt_noncurrent?: string;
|
|
315
|
+
property_plant_and_equipment_net?: string;
|
|
316
|
+
retained_earnings_accumulated_deficit?: string;
|
|
317
|
+
short_term_borrowings?: string;
|
|
318
|
+
short_term_investments?: string;
|
|
319
|
+
total_assets?: string;
|
|
320
|
+
total_current_assets?: string;
|
|
321
|
+
total_current_liabilities?: string;
|
|
322
|
+
total_debt?: string;
|
|
323
|
+
total_liabilities?: string;
|
|
324
|
+
total_liabilities_and_equity?: string;
|
|
325
|
+
};
|
|
326
|
+
FinancialStatementCashFlowStatement: {
|
|
327
|
+
business_acquisitions_net?: string;
|
|
328
|
+
capital_expenditure?: string;
|
|
329
|
+
common_dividends_paid?: string;
|
|
330
|
+
common_stock_repurchases?: string;
|
|
331
|
+
depreciation_and_amortization_adjustment?: string;
|
|
332
|
+
effect_of_exchange_rate_on_cash?: string;
|
|
333
|
+
net_cash_from_financing_activities?: string;
|
|
334
|
+
net_cash_from_investing_activities?: string;
|
|
335
|
+
net_cash_from_operating_activities?: string;
|
|
336
|
+
net_change_in_cash_cash_equivalents_and_restricted_cash_including_exchange_rate_effect?: string;
|
|
337
|
+
proceeds_from_common_stock_issuance?: string;
|
|
338
|
+
proceeds_from_debt_issuance?: string;
|
|
339
|
+
purchases_of_investments?: string;
|
|
340
|
+
repayments_of_debt?: string;
|
|
341
|
+
share_based_compensation_adjustment?: string;
|
|
342
|
+
};
|
|
343
|
+
FinancialStatementIncomeStatement: {
|
|
344
|
+
/** @description Reported earnings per share projected onto the latest reviewed stock-split basis. */
|
|
345
|
+
basic_earnings_per_share?: string;
|
|
346
|
+
/** @description Reported weighted-average shares projected onto the latest reviewed stock-split basis. */
|
|
347
|
+
basic_weighted_average_shares?: string;
|
|
348
|
+
cost_of_sales?: string;
|
|
349
|
+
/** @description Reported earnings per share projected onto the latest reviewed stock-split basis. */
|
|
350
|
+
diluted_earnings_per_share?: string;
|
|
351
|
+
/** @description Reported weighted-average shares projected onto the latest reviewed stock-split basis. */
|
|
352
|
+
diluted_weighted_average_shares?: string;
|
|
353
|
+
gross_profit?: string;
|
|
354
|
+
income_before_income_taxes?: string;
|
|
355
|
+
income_tax_expense?: string;
|
|
356
|
+
interest_expense?: string;
|
|
357
|
+
net_income_attributable_to_parent?: string;
|
|
358
|
+
net_income_including_noncontrolling_interests?: string;
|
|
359
|
+
nonoperating_income_expense?: string;
|
|
360
|
+
operating_income?: string;
|
|
361
|
+
research_and_development_expense?: string;
|
|
362
|
+
revenue?: string;
|
|
363
|
+
selling_general_and_administrative_expense?: string;
|
|
364
|
+
total_operating_expenses?: string;
|
|
365
|
+
};
|
|
366
|
+
FinancialStatementIssuer: {
|
|
367
|
+
cik: string;
|
|
368
|
+
name: string | null;
|
|
369
|
+
ticker: string | null;
|
|
370
|
+
};
|
|
371
|
+
FinancialStatementMetrics: {
|
|
372
|
+
asset_turnover?: string;
|
|
373
|
+
cash_ratio?: string;
|
|
374
|
+
current_ratio?: string;
|
|
375
|
+
debt_to_assets?: string;
|
|
376
|
+
debt_to_equity?: string;
|
|
377
|
+
ebit?: string;
|
|
378
|
+
ebit_margin?: string;
|
|
379
|
+
effective_tax_rate?: string;
|
|
380
|
+
free_cash_flow?: string;
|
|
381
|
+
free_cash_flow_margin?: string;
|
|
382
|
+
gross_margin?: string;
|
|
383
|
+
interest_coverage?: string;
|
|
384
|
+
net_debt?: string;
|
|
385
|
+
net_margin?: string;
|
|
386
|
+
operating_cash_flow_margin?: string;
|
|
387
|
+
operating_cash_flow_to_net_income?: string;
|
|
388
|
+
operating_margin?: string;
|
|
389
|
+
pretax_margin?: string;
|
|
390
|
+
quick_ratio?: string;
|
|
391
|
+
return_on_assets?: string;
|
|
392
|
+
return_on_equity?: string;
|
|
393
|
+
working_capital?: string;
|
|
394
|
+
};
|
|
395
|
+
FinancialStatementsBadRequest: {
|
|
396
|
+
/** @enum {string} */
|
|
397
|
+
error: "invalid_query_parameters";
|
|
398
|
+
};
|
|
399
|
+
FinancialStatementsCompanyNotFound: {
|
|
400
|
+
/** @enum {string} */
|
|
401
|
+
error: "company_not_found";
|
|
402
|
+
};
|
|
403
|
+
FinancialStatementsInternalError: {
|
|
404
|
+
/** @enum {string} */
|
|
405
|
+
error: "internal_server_error";
|
|
406
|
+
};
|
|
407
|
+
FinancialStatementsNotEntitled: {
|
|
408
|
+
/** @enum {string} */
|
|
409
|
+
error: "dataset_not_entitled";
|
|
410
|
+
};
|
|
411
|
+
FinancialStatementsTickerAmbiguous: {
|
|
412
|
+
/** @enum {string} */
|
|
413
|
+
error: "company_ambiguous";
|
|
414
|
+
};
|
|
415
|
+
FinancialStatementsTooManyRequests: {
|
|
416
|
+
/** @enum {string} */
|
|
417
|
+
error: "rate_limited" | "billing_period_quota_exceeded";
|
|
418
|
+
};
|
|
419
|
+
FinancialStatementsUnauthorized: {
|
|
420
|
+
/** @enum {string} */
|
|
421
|
+
error: "unauthorized";
|
|
422
|
+
};
|
|
423
|
+
FinancialStatementsUnavailable: {
|
|
424
|
+
/** @enum {string} */
|
|
425
|
+
error: "database_unavailable";
|
|
426
|
+
};
|
|
255
427
|
InitialOwnershipActivity: {
|
|
256
428
|
/**
|
|
257
429
|
* Format: date-time
|
|
@@ -313,7 +485,7 @@ interface components {
|
|
|
313
485
|
has_more: boolean;
|
|
314
486
|
/**
|
|
315
487
|
* @description Cursor to send after the current page has been processed successfully.
|
|
316
|
-
* @example
|
|
488
|
+
* @example cur_request_bound_example
|
|
317
489
|
*/
|
|
318
490
|
next_cursor: string;
|
|
319
491
|
};
|
|
@@ -525,7 +697,7 @@ interface components {
|
|
|
525
697
|
has_more: boolean;
|
|
526
698
|
/**
|
|
527
699
|
* @description Cursor to send after the current page has been processed successfully.
|
|
528
|
-
* @example
|
|
700
|
+
* @example cur_request_bound_example
|
|
529
701
|
*/
|
|
530
702
|
next_cursor: string;
|
|
531
703
|
transactions: components["schemas"]["InsiderTransactionFeedEvent"][];
|
|
@@ -722,7 +894,7 @@ interface components {
|
|
|
722
894
|
has_more: boolean;
|
|
723
895
|
/**
|
|
724
896
|
* @description Cursor to send after the current page has been processed successfully.
|
|
725
|
-
* @example
|
|
897
|
+
* @example cur_request_bound_example
|
|
726
898
|
*/
|
|
727
899
|
next_cursor: string;
|
|
728
900
|
updates: components["schemas"]["InstitutionalHoldingFeedUpdate"][];
|
|
@@ -1219,125 +1391,19 @@ interface components {
|
|
|
1219
1391
|
pathItems: never;
|
|
1220
1392
|
}
|
|
1221
1393
|
interface operations {
|
|
1222
|
-
|
|
1394
|
+
getCompany: {
|
|
1223
1395
|
parameters: {
|
|
1224
|
-
query
|
|
1225
|
-
/** @description
|
|
1226
|
-
|
|
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;
|
|
1227
1401
|
};
|
|
1228
1402
|
header?: never;
|
|
1229
1403
|
path?: never;
|
|
1230
1404
|
cookie?: never;
|
|
1231
1405
|
};
|
|
1232
1406
|
requestBody?: never;
|
|
1233
|
-
responses: {
|
|
1234
|
-
/** @description Ranked company matches. */
|
|
1235
|
-
200: {
|
|
1236
|
-
headers: {
|
|
1237
|
-
"Cache-Control"?: string;
|
|
1238
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1239
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1240
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1241
|
-
[name: string]: unknown;
|
|
1242
|
-
};
|
|
1243
|
-
content: {
|
|
1244
|
-
/**
|
|
1245
|
-
* @example {
|
|
1246
|
-
* "companies": [
|
|
1247
|
-
* {
|
|
1248
|
-
* "cik": "0000051143",
|
|
1249
|
-
* "fiscal_year_end": "1231",
|
|
1250
|
-
* "listings": [
|
|
1251
|
-
* {
|
|
1252
|
-
* "exchange": "NYSE",
|
|
1253
|
-
* "is_current": true,
|
|
1254
|
-
* "share_class_figi": "BBG001S5S399",
|
|
1255
|
-
* "ticker": "IBM"
|
|
1256
|
-
* }
|
|
1257
|
-
* ],
|
|
1258
|
-
* "name": "International Business Machines Corporation",
|
|
1259
|
-
* "sic": {
|
|
1260
|
-
* "code": "3570",
|
|
1261
|
-
* "industry_title": "COMPUTER & OFFICE EQUIPMENT",
|
|
1262
|
-
* "office": "Office of Technology"
|
|
1263
|
-
* }
|
|
1264
|
-
* }
|
|
1265
|
-
* ]
|
|
1266
|
-
* }
|
|
1267
|
-
*/
|
|
1268
|
-
"application/json": components["schemas"]["CompanySearchResponse"];
|
|
1269
|
-
};
|
|
1270
|
-
};
|
|
1271
|
-
/** @description The query is missing, invalid, or has unsupported keys. */
|
|
1272
|
-
400: {
|
|
1273
|
-
headers: {
|
|
1274
|
-
[name: string]: unknown;
|
|
1275
|
-
};
|
|
1276
|
-
content: {
|
|
1277
|
-
/**
|
|
1278
|
-
* @example {
|
|
1279
|
-
* "error": "invalid_query"
|
|
1280
|
-
* }
|
|
1281
|
-
*/
|
|
1282
|
-
"application/json": components["schemas"]["CompanySearchBadRequestResponse"];
|
|
1283
|
-
};
|
|
1284
|
-
};
|
|
1285
|
-
/** @description The request is missing a valid Chadwin API key. */
|
|
1286
|
-
401: {
|
|
1287
|
-
headers: {
|
|
1288
|
-
[name: string]: unknown;
|
|
1289
|
-
};
|
|
1290
|
-
content: {
|
|
1291
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1292
|
-
};
|
|
1293
|
-
};
|
|
1294
|
-
/** @description The request exceeded a rate limit. */
|
|
1295
|
-
429: {
|
|
1296
|
-
headers: {
|
|
1297
|
-
"RateLimit-Limit"?: string;
|
|
1298
|
-
"RateLimit-Reset"?: string;
|
|
1299
|
-
"Retry-After"?: string;
|
|
1300
|
-
"X-Billing-Period-Quota-Limit"?: string;
|
|
1301
|
-
"X-Billing-Period-Quota-Remaining"?: string;
|
|
1302
|
-
"X-Billing-Period-Quota-Reset"?: string;
|
|
1303
|
-
[name: string]: unknown;
|
|
1304
|
-
};
|
|
1305
|
-
content: {
|
|
1306
|
-
/**
|
|
1307
|
-
* @example {
|
|
1308
|
-
* "error": "rate_limited"
|
|
1309
|
-
* }
|
|
1310
|
-
*/
|
|
1311
|
-
"application/json": components["schemas"]["CompanyReferenceTooManyRequestsResponse"];
|
|
1312
|
-
};
|
|
1313
|
-
};
|
|
1314
|
-
/** @description The database is unavailable. */
|
|
1315
|
-
503: {
|
|
1316
|
-
headers: {
|
|
1317
|
-
[name: string]: unknown;
|
|
1318
|
-
};
|
|
1319
|
-
content: {
|
|
1320
|
-
/**
|
|
1321
|
-
* @example {
|
|
1322
|
-
* "error": "database_unavailable"
|
|
1323
|
-
* }
|
|
1324
|
-
*/
|
|
1325
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1326
|
-
};
|
|
1327
|
-
};
|
|
1328
|
-
};
|
|
1329
|
-
};
|
|
1330
|
-
getCompany: {
|
|
1331
|
-
parameters: {
|
|
1332
|
-
query?: never;
|
|
1333
|
-
header?: never;
|
|
1334
|
-
path: {
|
|
1335
|
-
/** @description US listed company ticker */
|
|
1336
|
-
ticker: string;
|
|
1337
|
-
};
|
|
1338
|
-
cookie?: never;
|
|
1339
|
-
};
|
|
1340
|
-
requestBody?: never;
|
|
1341
1407
|
responses: {
|
|
1342
1408
|
/** @description Company reference details. */
|
|
1343
1409
|
200: {
|
|
@@ -1374,6 +1440,18 @@ interface operations {
|
|
|
1374
1440
|
"application/json": components["schemas"]["CompanyReferenceResponse"];
|
|
1375
1441
|
};
|
|
1376
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
|
+
};
|
|
1377
1455
|
/** @description The request is missing a valid Chadwin API key. */
|
|
1378
1456
|
401: {
|
|
1379
1457
|
headers: {
|
|
@@ -1383,7 +1461,7 @@ interface operations {
|
|
|
1383
1461
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1384
1462
|
};
|
|
1385
1463
|
};
|
|
1386
|
-
/** @description The ticker does not resolve
|
|
1464
|
+
/** @description The ticker does not resolve, or the selected CIK has no stored company profile. */
|
|
1387
1465
|
404: {
|
|
1388
1466
|
headers: {
|
|
1389
1467
|
[name: string]: unknown;
|
|
@@ -1397,6 +1475,18 @@ interface operations {
|
|
|
1397
1475
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1398
1476
|
};
|
|
1399
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
|
+
};
|
|
1400
1490
|
/** @description The request exceeded a rate limit. */
|
|
1401
1491
|
429: {
|
|
1402
1492
|
headers: {
|
|
@@ -1747,7 +1837,235 @@ interface operations {
|
|
|
1747
1837
|
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
1748
1838
|
};
|
|
1749
1839
|
};
|
|
1750
|
-
/** @description The requested company was not found */
|
|
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 */
|
|
1751
2069
|
404: {
|
|
1752
2070
|
headers: {
|
|
1753
2071
|
[name: string]: unknown;
|
|
@@ -1756,6 +2074,15 @@ interface operations {
|
|
|
1756
2074
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1757
2075
|
};
|
|
1758
2076
|
};
|
|
2077
|
+
/** @description More than one original quarterly report matches the fiscal period */
|
|
2078
|
+
409: {
|
|
2079
|
+
headers: {
|
|
2080
|
+
[name: string]: unknown;
|
|
2081
|
+
};
|
|
2082
|
+
content: {
|
|
2083
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2084
|
+
};
|
|
2085
|
+
};
|
|
1759
2086
|
/** @description The request exceeded a rate limit. */
|
|
1760
2087
|
429: {
|
|
1761
2088
|
headers: {
|
|
@@ -1771,7 +2098,7 @@ interface operations {
|
|
|
1771
2098
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1772
2099
|
};
|
|
1773
2100
|
};
|
|
1774
|
-
/** @description The
|
|
2101
|
+
/** @description The filing catalog is unavailable */
|
|
1775
2102
|
503: {
|
|
1776
2103
|
headers: {
|
|
1777
2104
|
[name: string]: unknown;
|
|
@@ -1782,13 +2109,14 @@ interface operations {
|
|
|
1782
2109
|
};
|
|
1783
2110
|
};
|
|
1784
2111
|
};
|
|
1785
|
-
|
|
2112
|
+
getCompanyReportByCik: {
|
|
1786
2113
|
parameters: {
|
|
1787
2114
|
query?: never;
|
|
1788
2115
|
header?: never;
|
|
1789
2116
|
path: {
|
|
1790
|
-
ticker: string;
|
|
1791
2117
|
fiscal_year: string;
|
|
2118
|
+
/** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
|
|
2119
|
+
cik: string;
|
|
1792
2120
|
};
|
|
1793
2121
|
cookie?: never;
|
|
1794
2122
|
};
|
|
@@ -1829,7 +2157,7 @@ interface operations {
|
|
|
1829
2157
|
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
1830
2158
|
};
|
|
1831
2159
|
};
|
|
1832
|
-
/** @description The
|
|
2160
|
+
/** @description The cik or fiscal year is invalid */
|
|
1833
2161
|
400: {
|
|
1834
2162
|
headers: {
|
|
1835
2163
|
[name: string]: unknown;
|
|
@@ -1900,13 +2228,14 @@ interface operations {
|
|
|
1900
2228
|
};
|
|
1901
2229
|
};
|
|
1902
2230
|
};
|
|
1903
|
-
|
|
2231
|
+
getCompanyReportByCikForFiscalPeriod: {
|
|
1904
2232
|
parameters: {
|
|
1905
2233
|
query?: never;
|
|
1906
2234
|
header?: never;
|
|
1907
2235
|
path: {
|
|
1908
|
-
ticker: string;
|
|
1909
2236
|
fiscal_year: string;
|
|
2237
|
+
/** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
|
|
2238
|
+
cik: string;
|
|
1910
2239
|
fiscal_period: "Q1" | "Q2" | "Q3";
|
|
1911
2240
|
};
|
|
1912
2241
|
cookie?: never;
|
|
@@ -1948,7 +2277,7 @@ interface operations {
|
|
|
1948
2277
|
"application/json": components["schemas"]["CompanyReportFamilyResponse"];
|
|
1949
2278
|
};
|
|
1950
2279
|
};
|
|
1951
|
-
/** @description The
|
|
2280
|
+
/** @description The cik, fiscal year, or fiscal period is invalid */
|
|
1952
2281
|
400: {
|
|
1953
2282
|
headers: {
|
|
1954
2283
|
[name: string]: unknown;
|
|
@@ -2019,10 +2348,310 @@ interface operations {
|
|
|
2019
2348
|
};
|
|
2020
2349
|
};
|
|
2021
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
|
+
};
|
|
2022
2651
|
listCompanyReportFeed: {
|
|
2023
2652
|
parameters: {
|
|
2024
2653
|
query?: {
|
|
2025
|
-
/** @description Use `next_cursor` from the previous response.
|
|
2654
|
+
/** @description Use `next_cursor` from the previous response. The cursor is bound to this feed, the normalized `forms` filter, and the page size. Do not combine it with `start`. */
|
|
2026
2655
|
cursor?: string;
|
|
2027
2656
|
/** @description Optional comma-separated report families. Supported values are 10-K, 10-Q, 20-F, and 40-F. Each family includes its /A amendments. */
|
|
2028
2657
|
forms?: string;
|
|
@@ -2050,7 +2679,7 @@ interface operations {
|
|
|
2050
2679
|
/**
|
|
2051
2680
|
* @example {
|
|
2052
2681
|
* "has_more": false,
|
|
2053
|
-
* "next_cursor": "
|
|
2682
|
+
* "next_cursor": "cur_request_bound_example",
|
|
2054
2683
|
* "updates": [
|
|
2055
2684
|
* {
|
|
2056
2685
|
* "accepted_at": "2025-08-01T10:00:42.000Z",
|
|
@@ -2167,7 +2796,7 @@ interface operations {
|
|
|
2167
2796
|
query?: {
|
|
2168
2797
|
/** @description Optional comma-separated SEC forms to include. Supported forms: 3, 3/A, 4, 4/A, 5, 5/A, 144, 144/A. Omission selects all supported forms. Reuse the same selection with every cursor request. */
|
|
2169
2798
|
forms?: string;
|
|
2170
|
-
/** @description Use `next_cursor` from the previous response to continue where you left off.
|
|
2799
|
+
/** @description Use `next_cursor` from the previous response to continue where you left off. The cursor is bound to this feed, the normalized `forms` filter, and the page size. Do not use `cursor` and `start` together. Omit both to get the most recent activity updates. */
|
|
2171
2800
|
cursor?: string;
|
|
2172
2801
|
/** @description Page size from 1 through 1000. */
|
|
2173
2802
|
limit?: string;
|
|
@@ -2466,7 +3095,7 @@ interface operations {
|
|
|
2466
3095
|
listInsiderTransactionFeed: {
|
|
2467
3096
|
parameters: {
|
|
2468
3097
|
query?: {
|
|
2469
|
-
/** @description Use `next_cursor` from the previous response to continue where you left off.
|
|
3098
|
+
/** @description Use `next_cursor` from the previous response to continue where you left off. The cursor is bound to this feed, the normalized `transaction_codes` filter, and the page size. Do not use `cursor` and `start` together. Omit both to get the most recent transaction updates. */
|
|
2470
3099
|
cursor?: string;
|
|
2471
3100
|
/** @description Page size from 1 through 1000. */
|
|
2472
3101
|
limit?: string;
|
|
@@ -2550,7 +3179,7 @@ interface operations {
|
|
|
2550
3179
|
listInstitutionalFilingFeed: {
|
|
2551
3180
|
parameters: {
|
|
2552
3181
|
query?: {
|
|
2553
|
-
/** @description Use `next_cursor` from the previous response to continue where you left off.
|
|
3182
|
+
/** @description Use `next_cursor` from the previous response to continue where you left off. The cursor is bound to this feed, the normalized `forms` filter, and the page size. Do not use `cursor` and `start` together. Omit both to get the most recent filing updates. */
|
|
2554
3183
|
cursor?: string;
|
|
2555
3184
|
/** @description Optional comma-separated 13F form types to include. Supported forms: 13F-HR, 13F-HR/A, 13F-NT, 13F-NT/A. Omitted or empty means all supported forms. */
|
|
2556
3185
|
forms?: string;
|
|
@@ -2634,7 +3263,7 @@ interface operations {
|
|
|
2634
3263
|
listInstitutionalManagers: {
|
|
2635
3264
|
parameters: {
|
|
2636
3265
|
query?: {
|
|
2637
|
-
/** @description
|
|
3266
|
+
/** @description Opaque next_cursor from the prior page. Keep the same filters and page size. */
|
|
2638
3267
|
cursor?: string;
|
|
2639
3268
|
/** @description Page size from 1 through 1000. */
|
|
2640
3269
|
limit?: string;
|
|
@@ -2673,7 +3302,7 @@ interface operations {
|
|
|
2673
3302
|
* "total_value_usd": "267891234567"
|
|
2674
3303
|
* }
|
|
2675
3304
|
* ],
|
|
2676
|
-
* "next_cursor": "
|
|
3305
|
+
* "next_cursor": "cur_request_bound_example"
|
|
2677
3306
|
* }
|
|
2678
3307
|
*/
|
|
2679
3308
|
"application/json": components["schemas"]["InstitutionalManagersResponse"];
|
|
@@ -2933,7 +3562,7 @@ interface operations {
|
|
|
2933
3562
|
listInstitutionalManagerHoldings: {
|
|
2934
3563
|
parameters: {
|
|
2935
3564
|
query: {
|
|
2936
|
-
/** @description
|
|
3565
|
+
/** @description Opaque next_cursor from the prior page. Keep the same resource identifiers and page size. If the bound filing or manager-period revision changed, restart without a cursor. */
|
|
2937
3566
|
cursor?: string;
|
|
2938
3567
|
/** @description Page size from 1 through 5000. */
|
|
2939
3568
|
limit?: string;
|
|
@@ -2997,7 +3626,7 @@ interface operations {
|
|
|
2997
3626
|
* "form_13f_file_number": "028-04545",
|
|
2998
3627
|
* "name": "Berkshire Hathaway Inc."
|
|
2999
3628
|
* },
|
|
3000
|
-
* "next_cursor": "
|
|
3629
|
+
* "next_cursor": "cur_request_bound_example",
|
|
3001
3630
|
* "period": {
|
|
3002
3631
|
* "accepted_at": "2026-05-15T20:12:34.000Z",
|
|
3003
3632
|
* "period_of_report": "2026-03-31"
|
|
@@ -3043,6 +3672,15 @@ interface operations {
|
|
|
3043
3672
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3044
3673
|
};
|
|
3045
3674
|
};
|
|
3675
|
+
/** @description The manager-period holdings changed after the cursor was issued. Restart pagination from the first page. */
|
|
3676
|
+
409: {
|
|
3677
|
+
headers: {
|
|
3678
|
+
[name: string]: unknown;
|
|
3679
|
+
};
|
|
3680
|
+
content: {
|
|
3681
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3682
|
+
};
|
|
3683
|
+
};
|
|
3046
3684
|
/** @description The request exceeded a rate limit. */
|
|
3047
3685
|
429: {
|
|
3048
3686
|
headers: {
|
|
@@ -3188,7 +3826,7 @@ interface operations {
|
|
|
3188
3826
|
listInstitutionalManagerPositions: {
|
|
3189
3827
|
parameters: {
|
|
3190
3828
|
query: {
|
|
3191
|
-
/** @description
|
|
3829
|
+
/** @description Opaque next_cursor from the prior page. Keep the same resource identifiers and page size. If the bound filing or manager-period revision changed, restart without a cursor. */
|
|
3192
3830
|
cursor?: string;
|
|
3193
3831
|
/** @description Page size from 1 through 5000. */
|
|
3194
3832
|
limit?: string;
|
|
@@ -3971,7 +4609,7 @@ interface operations {
|
|
|
3971
4609
|
listSecInstitutionalFilingHoldings: {
|
|
3972
4610
|
parameters: {
|
|
3973
4611
|
query?: {
|
|
3974
|
-
/** @description
|
|
4612
|
+
/** @description Opaque next_cursor from the prior page. Keep the same resource identifiers and page size. If the bound filing or manager-period revision changed, restart without a cursor. */
|
|
3975
4613
|
cursor?: string;
|
|
3976
4614
|
/** @description Page size from 1 through 5000. */
|
|
3977
4615
|
limit?: string;
|
|
@@ -4027,7 +4665,7 @@ interface operations {
|
|
|
4027
4665
|
* }
|
|
4028
4666
|
* }
|
|
4029
4667
|
* ],
|
|
4030
|
-
* "next_cursor": "
|
|
4668
|
+
* "next_cursor": "cur_request_bound_example",
|
|
4031
4669
|
* "period_of_report": "2026-03-31",
|
|
4032
4670
|
* "report_type": "13F HOLDINGS REPORT"
|
|
4033
4671
|
* }
|
|
@@ -4071,6 +4709,15 @@ interface operations {
|
|
|
4071
4709
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
4072
4710
|
};
|
|
4073
4711
|
};
|
|
4712
|
+
/** @description The filing holdings changed after the cursor was issued. Restart pagination from the first page. */
|
|
4713
|
+
409: {
|
|
4714
|
+
headers: {
|
|
4715
|
+
[name: string]: unknown;
|
|
4716
|
+
};
|
|
4717
|
+
content: {
|
|
4718
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4719
|
+
};
|
|
4720
|
+
};
|
|
4074
4721
|
/** @description The request exceeded a rate limit. */
|
|
4075
4722
|
429: {
|
|
4076
4723
|
headers: {
|
|
@@ -4254,6 +4901,23 @@ interface operations {
|
|
|
4254
4901
|
|
|
4255
4902
|
type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
|
|
4256
4903
|
type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
|
|
4904
|
+
type CompanySelector = {
|
|
4905
|
+
ticker: string;
|
|
4906
|
+
cik?: never;
|
|
4907
|
+
} | {
|
|
4908
|
+
cik: string;
|
|
4909
|
+
ticker?: never;
|
|
4910
|
+
};
|
|
4911
|
+
type FinancialStatementsGetParams = CompanySelector & ({
|
|
4912
|
+
fiscalYear: number;
|
|
4913
|
+
years?: never;
|
|
4914
|
+
} | {
|
|
4915
|
+
years: number;
|
|
4916
|
+
fiscalYear?: never;
|
|
4917
|
+
} | {
|
|
4918
|
+
fiscalYear?: never;
|
|
4919
|
+
years?: never;
|
|
4920
|
+
});
|
|
4257
4921
|
type InsiderActivityForm = "3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "144" | "144/A";
|
|
4258
4922
|
type InsiderTransactionCode = "A" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "O" | "P" | "S" | "U" | "V" | "W" | "X" | "Z";
|
|
4259
4923
|
type InstitutionalFilingForm = "13F-HR" | "13F-HR/A" | "13F-NT" | "13F-NT/A";
|
|
@@ -4371,9 +5035,7 @@ declare class Companies {
|
|
|
4371
5035
|
search({ query }: {
|
|
4372
5036
|
query: string;
|
|
4373
5037
|
}): PromiseWithResponse<JsonResponse<"searchCompanies">>;
|
|
4374
|
-
get({ ticker }:
|
|
4375
|
-
ticker: string;
|
|
4376
|
-
}): PromiseWithResponse<JsonResponse<"getCompany">>;
|
|
5038
|
+
get({ ticker, cik }: CompanySelector): PromiseWithResponse<JsonResponse<"getCompany">>;
|
|
4377
5039
|
}
|
|
4378
5040
|
declare class CompanyReports {
|
|
4379
5041
|
private readonly transport;
|
|
@@ -4394,6 +5056,11 @@ declare class CompanyReports {
|
|
|
4394
5056
|
accessionNumber: string;
|
|
4395
5057
|
}): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
|
|
4396
5058
|
}
|
|
5059
|
+
declare class FinancialStatements {
|
|
5060
|
+
private readonly transport;
|
|
5061
|
+
constructor(transport: HttpTransport);
|
|
5062
|
+
get({ ticker, cik, fiscalYear, years, }: FinancialStatementsGetParams): PromiseWithResponse<JsonResponse<"getCompanyFinancialStatements">>;
|
|
5063
|
+
}
|
|
4397
5064
|
declare class InsiderTransactions {
|
|
4398
5065
|
private readonly transport;
|
|
4399
5066
|
constructor(transport: HttpTransport);
|
|
@@ -4539,6 +5206,7 @@ declare class Chadwin {
|
|
|
4539
5206
|
readonly companies: Companies;
|
|
4540
5207
|
readonly companyReports: CompanyReports;
|
|
4541
5208
|
readonly feeds: Feeds;
|
|
5209
|
+
readonly financialStatements: FinancialStatements;
|
|
4542
5210
|
readonly insiderFilings: InsiderFilings;
|
|
4543
5211
|
readonly insiderTransactions: InsiderTransactions;
|
|
4544
5212
|
readonly institutionalFilings: InstitutionalFilings;
|
|
@@ -4559,4 +5227,4 @@ declare class APIError extends Error {
|
|
|
4559
5227
|
constructor(message: string, options?: APIErrorOptions);
|
|
4560
5228
|
}
|
|
4561
5229
|
|
|
4562
|
-
export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportFiscalPeriod, type CompanyReportForm, 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 };
|