@chadwin/sdk 0.10.0 → 0.11.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 +50 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +573 -38
- package/dist/index.d.ts +573 -38
- package/dist/index.js +50 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -163,6 +163,68 @@ interface components {
|
|
|
163
163
|
office: string;
|
|
164
164
|
} | null;
|
|
165
165
|
};
|
|
166
|
+
CurrentReport: {
|
|
167
|
+
/** Format: date-time */
|
|
168
|
+
accepted_at: string | null;
|
|
169
|
+
accession_number: string;
|
|
170
|
+
content_url: string;
|
|
171
|
+
/** Format: date */
|
|
172
|
+
event_date: string | null;
|
|
173
|
+
/** Format: date */
|
|
174
|
+
filed_at: string | null;
|
|
175
|
+
fiscal_period: null;
|
|
176
|
+
fiscal_year: null;
|
|
177
|
+
/** @enum {string} */
|
|
178
|
+
form: "8-K" | "8-K/A" | "6-K" | "6-K/A";
|
|
179
|
+
issuer: {
|
|
180
|
+
cik: string;
|
|
181
|
+
name: string | null;
|
|
182
|
+
ticker: string | null;
|
|
183
|
+
};
|
|
184
|
+
item_codes: string[];
|
|
185
|
+
/** Format: date */
|
|
186
|
+
report_date: string | null;
|
|
187
|
+
/** Format: uri */
|
|
188
|
+
sec_url: string;
|
|
189
|
+
};
|
|
190
|
+
CurrentReportFeedPage: {
|
|
191
|
+
has_more: boolean;
|
|
192
|
+
next_cursor: string;
|
|
193
|
+
updates: components["schemas"]["CurrentReportFeedUpdate"][];
|
|
194
|
+
};
|
|
195
|
+
CurrentReportFeedUpdate: {
|
|
196
|
+
/** Format: date-time */
|
|
197
|
+
accepted_at: string | null;
|
|
198
|
+
accession_number: string;
|
|
199
|
+
content_url: string;
|
|
200
|
+
/** Format: date */
|
|
201
|
+
event_date: string | null;
|
|
202
|
+
feed_event_id: string;
|
|
203
|
+
/** Format: date */
|
|
204
|
+
filed_at: string | null;
|
|
205
|
+
fiscal_period: null;
|
|
206
|
+
fiscal_year: null;
|
|
207
|
+
/** @enum {string} */
|
|
208
|
+
form: "8-K" | "8-K/A" | "6-K" | "6-K/A";
|
|
209
|
+
issuer: {
|
|
210
|
+
cik: string;
|
|
211
|
+
name: string | null;
|
|
212
|
+
ticker: string | null;
|
|
213
|
+
};
|
|
214
|
+
item_codes: string[];
|
|
215
|
+
metadata_url: string;
|
|
216
|
+
/** Format: date-time */
|
|
217
|
+
published_at: string;
|
|
218
|
+
/** Format: date */
|
|
219
|
+
report_date: string | null;
|
|
220
|
+
/** Format: uri */
|
|
221
|
+
sec_url: string;
|
|
222
|
+
};
|
|
223
|
+
CurrentReportPage: {
|
|
224
|
+
filings: components["schemas"]["CurrentReport"][];
|
|
225
|
+
has_more: boolean;
|
|
226
|
+
next_cursor: string | null;
|
|
227
|
+
};
|
|
166
228
|
DatasetNotEntitledErrorResponse: {
|
|
167
229
|
/** @enum {string} */
|
|
168
230
|
error: "dataset_not_entitled";
|
|
@@ -1828,14 +1890,14 @@ interface operations {
|
|
|
1828
1890
|
listCompanyReportFeed: {
|
|
1829
1891
|
parameters: {
|
|
1830
1892
|
query?: {
|
|
1831
|
-
/** @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`. */
|
|
1832
|
-
cursor?: string;
|
|
1833
1893
|
/** @description Optional comma-separated report families. Supported values are 10-K, 10-Q, 20-F, and 40-F. Each family includes its /A amendments. */
|
|
1834
1894
|
forms?: string;
|
|
1835
|
-
/** @description Page size from 1 through 1000. */
|
|
1836
|
-
limit?: string;
|
|
1837
1895
|
/** @description Set to `now` to establish a future-only cursor. Do not combine this with `cursor`. */
|
|
1838
1896
|
start?: string;
|
|
1897
|
+
/** @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`. */
|
|
1898
|
+
cursor?: string;
|
|
1899
|
+
/** @description Page size from 1 through 1000. */
|
|
1900
|
+
limit?: string;
|
|
1839
1901
|
};
|
|
1840
1902
|
header?: never;
|
|
1841
1903
|
path?: never;
|
|
@@ -1968,17 +2030,133 @@ interface operations {
|
|
|
1968
2030
|
};
|
|
1969
2031
|
};
|
|
1970
2032
|
};
|
|
2033
|
+
listCurrentReportFeed: {
|
|
2034
|
+
parameters: {
|
|
2035
|
+
query?: {
|
|
2036
|
+
/** @description Optional comma-separated report families. Supported values are 8-K and 6-K. Each family includes its /A amendments. */
|
|
2037
|
+
forms?: string;
|
|
2038
|
+
/** @description Set to `now` to establish a future-only cursor. Do not combine this with `cursor`. */
|
|
2039
|
+
start?: string;
|
|
2040
|
+
/** @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`. */
|
|
2041
|
+
cursor?: string;
|
|
2042
|
+
/** @description Page size from 1 through 1000. */
|
|
2043
|
+
limit?: string;
|
|
2044
|
+
};
|
|
2045
|
+
header?: never;
|
|
2046
|
+
path?: never;
|
|
2047
|
+
cookie?: never;
|
|
2048
|
+
};
|
|
2049
|
+
requestBody?: never;
|
|
2050
|
+
responses: {
|
|
2051
|
+
/** @description Published current report updates. */
|
|
2052
|
+
200: {
|
|
2053
|
+
headers: {
|
|
2054
|
+
"Cache-Control"?: string;
|
|
2055
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2056
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2057
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2058
|
+
[name: string]: unknown;
|
|
2059
|
+
};
|
|
2060
|
+
content: {
|
|
2061
|
+
/**
|
|
2062
|
+
* @example {
|
|
2063
|
+
* "has_more": false,
|
|
2064
|
+
* "next_cursor": "cur_request_bound_example",
|
|
2065
|
+
* "updates": [
|
|
2066
|
+
* {
|
|
2067
|
+
* "accepted_at": "2026-08-18T12:00:00.000Z",
|
|
2068
|
+
* "accession_number": "0000320193-26-000001",
|
|
2069
|
+
* "content_url": "/v1/sec/current-reports/0000320193-26-000001/content.html",
|
|
2070
|
+
* "event_date": "2026-08-17",
|
|
2071
|
+
* "feed_event_id": "crfe_000000012345",
|
|
2072
|
+
* "filed_at": "2026-08-18",
|
|
2073
|
+
* "fiscal_period": null,
|
|
2074
|
+
* "fiscal_year": null,
|
|
2075
|
+
* "form": "8-K",
|
|
2076
|
+
* "issuer": {
|
|
2077
|
+
* "cik": "0000320193",
|
|
2078
|
+
* "name": "Apple Inc.",
|
|
2079
|
+
* "ticker": "AAPL"
|
|
2080
|
+
* },
|
|
2081
|
+
* "item_codes": [
|
|
2082
|
+
* "2.02",
|
|
2083
|
+
* "9.01"
|
|
2084
|
+
* ],
|
|
2085
|
+
* "metadata_url": "/v1/sec/current-reports/0000320193-26-000001",
|
|
2086
|
+
* "published_at": "2026-08-18T12:01:00.000Z",
|
|
2087
|
+
* "report_date": null,
|
|
2088
|
+
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000001/0000320193-26-000001-index.htm"
|
|
2089
|
+
* }
|
|
2090
|
+
* ]
|
|
2091
|
+
* }
|
|
2092
|
+
*/
|
|
2093
|
+
"application/json": components["schemas"]["CurrentReportFeedPage"];
|
|
2094
|
+
};
|
|
2095
|
+
};
|
|
2096
|
+
/** @description The feed query parameters are invalid. */
|
|
2097
|
+
400: {
|
|
2098
|
+
headers: {
|
|
2099
|
+
[name: string]: unknown;
|
|
2100
|
+
};
|
|
2101
|
+
content: {
|
|
2102
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2103
|
+
};
|
|
2104
|
+
};
|
|
2105
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
2106
|
+
401: {
|
|
2107
|
+
headers: {
|
|
2108
|
+
[name: string]: unknown;
|
|
2109
|
+
};
|
|
2110
|
+
content: {
|
|
2111
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2112
|
+
};
|
|
2113
|
+
};
|
|
2114
|
+
/** @description The subscription does not include this dataset. */
|
|
2115
|
+
403: {
|
|
2116
|
+
headers: {
|
|
2117
|
+
[name: string]: unknown;
|
|
2118
|
+
};
|
|
2119
|
+
content: {
|
|
2120
|
+
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
2121
|
+
};
|
|
2122
|
+
};
|
|
2123
|
+
/** @description The request exceeded a rate limit. */
|
|
2124
|
+
429: {
|
|
2125
|
+
headers: {
|
|
2126
|
+
"RateLimit-Limit"?: string;
|
|
2127
|
+
"RateLimit-Reset"?: string;
|
|
2128
|
+
"Retry-After"?: string;
|
|
2129
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
2130
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
2131
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
2132
|
+
[name: string]: unknown;
|
|
2133
|
+
};
|
|
2134
|
+
content: {
|
|
2135
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2136
|
+
};
|
|
2137
|
+
};
|
|
2138
|
+
/** @description The database is unavailable. */
|
|
2139
|
+
503: {
|
|
2140
|
+
headers: {
|
|
2141
|
+
[name: string]: unknown;
|
|
2142
|
+
};
|
|
2143
|
+
content: {
|
|
2144
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2145
|
+
};
|
|
2146
|
+
};
|
|
2147
|
+
};
|
|
2148
|
+
};
|
|
1971
2149
|
listInsiderActivityFeed: {
|
|
1972
2150
|
parameters: {
|
|
1973
2151
|
query?: {
|
|
1974
2152
|
/** @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. */
|
|
1975
2153
|
forms?: string;
|
|
2154
|
+
/** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
|
|
2155
|
+
start?: string;
|
|
1976
2156
|
/** @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. */
|
|
1977
2157
|
cursor?: string;
|
|
1978
2158
|
/** @description Page size from 1 through 1000. */
|
|
1979
2159
|
limit?: string;
|
|
1980
|
-
/** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
|
|
1981
|
-
start?: string;
|
|
1982
2160
|
};
|
|
1983
2161
|
header?: never;
|
|
1984
2162
|
path?: never;
|
|
@@ -2055,20 +2233,20 @@ interface operations {
|
|
|
2055
2233
|
listInsiderTransactions: {
|
|
2056
2234
|
parameters: {
|
|
2057
2235
|
query: {
|
|
2058
|
-
/** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
|
|
2059
|
-
cursor?: string;
|
|
2060
|
-
/** @description Rows per page from 1 through 1000. Defaults to 1000. */
|
|
2061
|
-
limit?: string;
|
|
2062
|
-
/** @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. */
|
|
2063
|
-
transaction_codes?: string;
|
|
2064
2236
|
/** @description Required inclusive SEC filing-date lower bound in YYYY-MM-DD format. */
|
|
2065
2237
|
from: string;
|
|
2066
|
-
/** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
|
|
2067
|
-
until?: string;
|
|
2068
|
-
/** @description Optional filing entity CIKs. Mutually exclusive with tickers; reference rows are not required. */
|
|
2069
|
-
ciks?: string;
|
|
2070
2238
|
/** @description Optional comma-separated ticker filter. Mutually exclusive with ciks. */
|
|
2071
2239
|
tickers?: string;
|
|
2240
|
+
/** @description Optional filing entity CIKs. Mutually exclusive with tickers; reference rows are not required. */
|
|
2241
|
+
ciks?: string;
|
|
2242
|
+
/** @description Optional inclusive SEC filing-date upper bound in YYYY-MM-DD format. Defaults to the current date. */
|
|
2243
|
+
until?: string;
|
|
2244
|
+
/** @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. */
|
|
2245
|
+
transaction_codes?: string;
|
|
2246
|
+
/** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. */
|
|
2247
|
+
cursor?: string;
|
|
2248
|
+
/** @description Rows per page from 1 through 1000. Defaults to 1000. */
|
|
2249
|
+
limit?: string;
|
|
2072
2250
|
};
|
|
2073
2251
|
header?: never;
|
|
2074
2252
|
path?: never;
|
|
@@ -2292,14 +2470,14 @@ interface operations {
|
|
|
2292
2470
|
listInsiderTransactionFeed: {
|
|
2293
2471
|
parameters: {
|
|
2294
2472
|
query?: {
|
|
2473
|
+
/** @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. */
|
|
2474
|
+
transaction_codes?: string;
|
|
2475
|
+
/** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
|
|
2476
|
+
start?: string;
|
|
2295
2477
|
/** @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. */
|
|
2296
2478
|
cursor?: string;
|
|
2297
2479
|
/** @description Page size from 1 through 1000. */
|
|
2298
2480
|
limit?: string;
|
|
2299
|
-
/** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
|
|
2300
|
-
start?: string;
|
|
2301
|
-
/** @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. */
|
|
2302
|
-
transaction_codes?: string;
|
|
2303
2481
|
};
|
|
2304
2482
|
header?: never;
|
|
2305
2483
|
path?: never;
|
|
@@ -2376,14 +2554,14 @@ interface operations {
|
|
|
2376
2554
|
listInstitutionalFilingFeed: {
|
|
2377
2555
|
parameters: {
|
|
2378
2556
|
query?: {
|
|
2379
|
-
/** @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. */
|
|
2380
|
-
cursor?: string;
|
|
2381
2557
|
/** @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. */
|
|
2382
2558
|
forms?: string;
|
|
2383
|
-
/** @description Page size from 1 through 1000. */
|
|
2384
|
-
limit?: string;
|
|
2385
2559
|
/** @description Set `start` to `now` to skip existing updates. The response contains no items and gives you a cursor for updates published after your request. Do not use `cursor` and `start` together. */
|
|
2386
2560
|
start?: string;
|
|
2561
|
+
/** @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. */
|
|
2562
|
+
cursor?: string;
|
|
2563
|
+
/** @description Page size from 1 through 1000. */
|
|
2564
|
+
limit?: string;
|
|
2387
2565
|
};
|
|
2388
2566
|
header?: never;
|
|
2389
2567
|
path?: never;
|
|
@@ -2460,14 +2638,14 @@ interface operations {
|
|
|
2460
2638
|
listInstitutionalManagers: {
|
|
2461
2639
|
parameters: {
|
|
2462
2640
|
query?: {
|
|
2641
|
+
/** @description Optional manager CIK filter for source filers associated with a manager profile. */
|
|
2642
|
+
cik?: string;
|
|
2643
|
+
/** @description Optional Form 13F file-number filter for source filers associated with a manager profile. */
|
|
2644
|
+
form_13f_file_number?: string;
|
|
2463
2645
|
/** @description Opaque next_cursor from the prior page. Keep the same filters and page size. */
|
|
2464
2646
|
cursor?: string;
|
|
2465
2647
|
/** @description Page size from 1 through 1000. */
|
|
2466
2648
|
limit?: string;
|
|
2467
|
-
/** @description Optional Form 13F file-number filter for source filers associated with a manager profile. */
|
|
2468
|
-
form_13f_file_number?: string;
|
|
2469
|
-
/** @description Optional manager CIK filter for source filers associated with a manager profile. */
|
|
2470
|
-
cik?: string;
|
|
2471
2649
|
};
|
|
2472
2650
|
header?: never;
|
|
2473
2651
|
path?: never;
|
|
@@ -2759,12 +2937,12 @@ interface operations {
|
|
|
2759
2937
|
listInstitutionalManagerHoldings: {
|
|
2760
2938
|
parameters: {
|
|
2761
2939
|
query: {
|
|
2940
|
+
/** @description Required report period. Use latest for the latest available manager period, or YYYY-MM-DD for a concrete period. */
|
|
2941
|
+
period: string;
|
|
2762
2942
|
/** @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. */
|
|
2763
2943
|
cursor?: string;
|
|
2764
2944
|
/** @description Page size from 1 through 5000. */
|
|
2765
2945
|
limit?: string;
|
|
2766
|
-
/** @description Required report period. Use latest for the latest available manager period, or YYYY-MM-DD for a concrete period. */
|
|
2767
|
-
period: string;
|
|
2768
2946
|
};
|
|
2769
2947
|
header?: never;
|
|
2770
2948
|
path: {
|
|
@@ -3023,12 +3201,12 @@ interface operations {
|
|
|
3023
3201
|
listInstitutionalManagerPositions: {
|
|
3024
3202
|
parameters: {
|
|
3025
3203
|
query: {
|
|
3204
|
+
/** @description Required report period. Use latest for the latest available manager period, or YYYY-MM-DD for a concrete period. */
|
|
3205
|
+
period: string;
|
|
3026
3206
|
/** @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. */
|
|
3027
3207
|
cursor?: string;
|
|
3028
3208
|
/** @description Page size from 1 through 5000. */
|
|
3029
3209
|
limit?: string;
|
|
3030
|
-
/** @description Required report period. Use latest for the latest available manager period, or YYYY-MM-DD for a concrete period. */
|
|
3031
|
-
period: string;
|
|
3032
3210
|
};
|
|
3033
3211
|
header?: never;
|
|
3034
3212
|
path: {
|
|
@@ -3167,16 +3345,16 @@ interface operations {
|
|
|
3167
3345
|
listProposedSales: {
|
|
3168
3346
|
parameters: {
|
|
3169
3347
|
query: {
|
|
3170
|
-
/** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. Old cursors or changed ticker resolution return invalid_cursor; restart from the first page. */
|
|
3171
|
-
cursor?: string;
|
|
3172
|
-
/** @description Rows per page from 1 through 1000. Defaults to 1000. */
|
|
3173
|
-
limit?: string;
|
|
3174
3348
|
from: string;
|
|
3175
|
-
until?: string;
|
|
3176
3349
|
/** @description Company tickers; mutually exclusive with ciks. */
|
|
3177
3350
|
tickers?: string;
|
|
3178
3351
|
/** @description Filing entity CIKs; mutually exclusive with tickers. Reference rows are not required. */
|
|
3179
3352
|
ciks?: string;
|
|
3353
|
+
until?: string;
|
|
3354
|
+
/** @description Opaque next_cursor from the preceding page. Keep the same filters and limit. Old cursors or changed ticker resolution return invalid_cursor; restart from the first page. */
|
|
3355
|
+
cursor?: string;
|
|
3356
|
+
/** @description Rows per page from 1 through 1000. Defaults to 1000. */
|
|
3357
|
+
limit?: string;
|
|
3180
3358
|
};
|
|
3181
3359
|
header?: never;
|
|
3182
3360
|
path?: never;
|
|
@@ -3495,6 +3673,322 @@ interface operations {
|
|
|
3495
3673
|
};
|
|
3496
3674
|
};
|
|
3497
3675
|
};
|
|
3676
|
+
listCurrentReports: {
|
|
3677
|
+
parameters: {
|
|
3678
|
+
query: {
|
|
3679
|
+
from: string;
|
|
3680
|
+
/** @description Optional filer CIK, up to ten digits; no ticker required. */
|
|
3681
|
+
cik?: string;
|
|
3682
|
+
until?: string;
|
|
3683
|
+
/** @description Comma-separated 8-K, 8-K/A, 6-K, 6-K/A; all by default. */
|
|
3684
|
+
forms?: string;
|
|
3685
|
+
/** @description Comma-separated exact 8-K item codes, matched with any-match semantics. */
|
|
3686
|
+
items?: string;
|
|
3687
|
+
/** @description Page size 1–1000; default 500. */
|
|
3688
|
+
limit?: string;
|
|
3689
|
+
/** @description Continuation cursor. Keep filters and page size unchanged. */
|
|
3690
|
+
cursor?: string;
|
|
3691
|
+
};
|
|
3692
|
+
header?: never;
|
|
3693
|
+
path?: never;
|
|
3694
|
+
cookie?: never;
|
|
3695
|
+
};
|
|
3696
|
+
requestBody?: never;
|
|
3697
|
+
responses: {
|
|
3698
|
+
/** @description Current report history */
|
|
3699
|
+
200: {
|
|
3700
|
+
headers: {
|
|
3701
|
+
"Cache-Control"?: string;
|
|
3702
|
+
ETag?: string;
|
|
3703
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
3704
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
3705
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
3706
|
+
[name: string]: unknown;
|
|
3707
|
+
};
|
|
3708
|
+
content: {
|
|
3709
|
+
/**
|
|
3710
|
+
* @example {
|
|
3711
|
+
* "filings": [
|
|
3712
|
+
* {
|
|
3713
|
+
* "accepted_at": "2026-08-18T12:00:00.000Z",
|
|
3714
|
+
* "accession_number": "0000320193-26-000001",
|
|
3715
|
+
* "content_url": "/v1/sec/current-reports/0000320193-26-000001/content.html",
|
|
3716
|
+
* "event_date": "2026-08-17",
|
|
3717
|
+
* "filed_at": "2026-08-18",
|
|
3718
|
+
* "fiscal_period": null,
|
|
3719
|
+
* "fiscal_year": null,
|
|
3720
|
+
* "form": "8-K",
|
|
3721
|
+
* "issuer": {
|
|
3722
|
+
* "cik": "0000320193",
|
|
3723
|
+
* "name": "Apple Inc.",
|
|
3724
|
+
* "ticker": "AAPL"
|
|
3725
|
+
* },
|
|
3726
|
+
* "item_codes": [
|
|
3727
|
+
* "2.02",
|
|
3728
|
+
* "9.01"
|
|
3729
|
+
* ],
|
|
3730
|
+
* "report_date": null,
|
|
3731
|
+
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000001/0000320193-26-000001-index.htm"
|
|
3732
|
+
* }
|
|
3733
|
+
* ],
|
|
3734
|
+
* "has_more": false,
|
|
3735
|
+
* "next_cursor": null
|
|
3736
|
+
* }
|
|
3737
|
+
*/
|
|
3738
|
+
"application/json": components["schemas"]["CurrentReportPage"];
|
|
3739
|
+
};
|
|
3740
|
+
};
|
|
3741
|
+
/** @description Invalid identifier, filters, limit or cursor */
|
|
3742
|
+
400: {
|
|
3743
|
+
headers: {
|
|
3744
|
+
[name: string]: unknown;
|
|
3745
|
+
};
|
|
3746
|
+
content: {
|
|
3747
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3748
|
+
};
|
|
3749
|
+
};
|
|
3750
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
3751
|
+
401: {
|
|
3752
|
+
headers: {
|
|
3753
|
+
[name: string]: unknown;
|
|
3754
|
+
};
|
|
3755
|
+
content: {
|
|
3756
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3757
|
+
};
|
|
3758
|
+
};
|
|
3759
|
+
/** @description The subscription does not include this dataset. */
|
|
3760
|
+
403: {
|
|
3761
|
+
headers: {
|
|
3762
|
+
[name: string]: unknown;
|
|
3763
|
+
};
|
|
3764
|
+
content: {
|
|
3765
|
+
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
3766
|
+
};
|
|
3767
|
+
};
|
|
3768
|
+
/** @description The request exceeded a rate limit. */
|
|
3769
|
+
429: {
|
|
3770
|
+
headers: {
|
|
3771
|
+
"RateLimit-Limit"?: string;
|
|
3772
|
+
"RateLimit-Reset"?: string;
|
|
3773
|
+
"Retry-After"?: string;
|
|
3774
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
3775
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
3776
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
3777
|
+
[name: string]: unknown;
|
|
3778
|
+
};
|
|
3779
|
+
content: {
|
|
3780
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3781
|
+
};
|
|
3782
|
+
};
|
|
3783
|
+
/** @description Required catalog data or prepared output is unavailable */
|
|
3784
|
+
503: {
|
|
3785
|
+
headers: {
|
|
3786
|
+
[name: string]: unknown;
|
|
3787
|
+
};
|
|
3788
|
+
content: {
|
|
3789
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3790
|
+
};
|
|
3791
|
+
};
|
|
3792
|
+
};
|
|
3793
|
+
};
|
|
3794
|
+
getCurrentReport: {
|
|
3795
|
+
parameters: {
|
|
3796
|
+
query?: never;
|
|
3797
|
+
header?: never;
|
|
3798
|
+
path: {
|
|
3799
|
+
accession: string;
|
|
3800
|
+
};
|
|
3801
|
+
cookie?: never;
|
|
3802
|
+
};
|
|
3803
|
+
requestBody?: never;
|
|
3804
|
+
responses: {
|
|
3805
|
+
/** @description Current report metadata */
|
|
3806
|
+
200: {
|
|
3807
|
+
headers: {
|
|
3808
|
+
"Cache-Control"?: string;
|
|
3809
|
+
ETag?: string;
|
|
3810
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
3811
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
3812
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
3813
|
+
[name: string]: unknown;
|
|
3814
|
+
};
|
|
3815
|
+
content: {
|
|
3816
|
+
/**
|
|
3817
|
+
* @example {
|
|
3818
|
+
* "accepted_at": "2026-08-18T12:00:00.000Z",
|
|
3819
|
+
* "accession_number": "0000320193-26-000001",
|
|
3820
|
+
* "content_url": "/v1/sec/current-reports/0000320193-26-000001/content.html",
|
|
3821
|
+
* "event_date": "2026-08-17",
|
|
3822
|
+
* "filed_at": "2026-08-18",
|
|
3823
|
+
* "fiscal_period": null,
|
|
3824
|
+
* "fiscal_year": null,
|
|
3825
|
+
* "form": "8-K",
|
|
3826
|
+
* "issuer": {
|
|
3827
|
+
* "cik": "0000320193",
|
|
3828
|
+
* "name": "Apple Inc.",
|
|
3829
|
+
* "ticker": "AAPL"
|
|
3830
|
+
* },
|
|
3831
|
+
* "item_codes": [
|
|
3832
|
+
* "2.02",
|
|
3833
|
+
* "9.01"
|
|
3834
|
+
* ],
|
|
3835
|
+
* "report_date": null,
|
|
3836
|
+
* "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000001/0000320193-26-000001-index.htm"
|
|
3837
|
+
* }
|
|
3838
|
+
*/
|
|
3839
|
+
"application/json": components["schemas"]["CurrentReport"];
|
|
3840
|
+
};
|
|
3841
|
+
};
|
|
3842
|
+
/** @description Invalid identifier, filters, limit or cursor */
|
|
3843
|
+
400: {
|
|
3844
|
+
headers: {
|
|
3845
|
+
[name: string]: unknown;
|
|
3846
|
+
};
|
|
3847
|
+
content: {
|
|
3848
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3849
|
+
};
|
|
3850
|
+
};
|
|
3851
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
3852
|
+
401: {
|
|
3853
|
+
headers: {
|
|
3854
|
+
[name: string]: unknown;
|
|
3855
|
+
};
|
|
3856
|
+
content: {
|
|
3857
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3858
|
+
};
|
|
3859
|
+
};
|
|
3860
|
+
/** @description The subscription does not include this dataset. */
|
|
3861
|
+
403: {
|
|
3862
|
+
headers: {
|
|
3863
|
+
[name: string]: unknown;
|
|
3864
|
+
};
|
|
3865
|
+
content: {
|
|
3866
|
+
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
3867
|
+
};
|
|
3868
|
+
};
|
|
3869
|
+
/** @description Current report not found */
|
|
3870
|
+
404: {
|
|
3871
|
+
headers: {
|
|
3872
|
+
[name: string]: unknown;
|
|
3873
|
+
};
|
|
3874
|
+
content: {
|
|
3875
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3876
|
+
};
|
|
3877
|
+
};
|
|
3878
|
+
/** @description The request exceeded a rate limit. */
|
|
3879
|
+
429: {
|
|
3880
|
+
headers: {
|
|
3881
|
+
"RateLimit-Limit"?: string;
|
|
3882
|
+
"RateLimit-Reset"?: string;
|
|
3883
|
+
"Retry-After"?: string;
|
|
3884
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
3885
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
3886
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
3887
|
+
[name: string]: unknown;
|
|
3888
|
+
};
|
|
3889
|
+
content: {
|
|
3890
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3891
|
+
};
|
|
3892
|
+
};
|
|
3893
|
+
/** @description Required catalog data or prepared output is unavailable */
|
|
3894
|
+
503: {
|
|
3895
|
+
headers: {
|
|
3896
|
+
[name: string]: unknown;
|
|
3897
|
+
};
|
|
3898
|
+
content: {
|
|
3899
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3900
|
+
};
|
|
3901
|
+
};
|
|
3902
|
+
};
|
|
3903
|
+
};
|
|
3904
|
+
getCurrentReportHtml: {
|
|
3905
|
+
parameters: {
|
|
3906
|
+
query?: never;
|
|
3907
|
+
header?: never;
|
|
3908
|
+
path: {
|
|
3909
|
+
accession: string;
|
|
3910
|
+
};
|
|
3911
|
+
cookie?: never;
|
|
3912
|
+
};
|
|
3913
|
+
requestBody?: never;
|
|
3914
|
+
responses: {
|
|
3915
|
+
/** @description Combined report HTML */
|
|
3916
|
+
200: {
|
|
3917
|
+
headers: {
|
|
3918
|
+
"Cache-Control"?: string;
|
|
3919
|
+
ETag?: string;
|
|
3920
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
3921
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
3922
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
3923
|
+
[name: string]: unknown;
|
|
3924
|
+
};
|
|
3925
|
+
content: {
|
|
3926
|
+
/** @example <!doctype html><html><body><p>Primary report</p><h2>Exhibit 99.1</h2><p>Release</p></body></html> */
|
|
3927
|
+
"text/html": string;
|
|
3928
|
+
};
|
|
3929
|
+
};
|
|
3930
|
+
/** @description Invalid identifier, filters, limit or cursor */
|
|
3931
|
+
400: {
|
|
3932
|
+
headers: {
|
|
3933
|
+
[name: string]: unknown;
|
|
3934
|
+
};
|
|
3935
|
+
content: {
|
|
3936
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3937
|
+
};
|
|
3938
|
+
};
|
|
3939
|
+
/** @description The request is missing a valid Chadwin API key. */
|
|
3940
|
+
401: {
|
|
3941
|
+
headers: {
|
|
3942
|
+
[name: string]: unknown;
|
|
3943
|
+
};
|
|
3944
|
+
content: {
|
|
3945
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3946
|
+
};
|
|
3947
|
+
};
|
|
3948
|
+
/** @description The subscription does not include this dataset. */
|
|
3949
|
+
403: {
|
|
3950
|
+
headers: {
|
|
3951
|
+
[name: string]: unknown;
|
|
3952
|
+
};
|
|
3953
|
+
content: {
|
|
3954
|
+
"application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
|
|
3955
|
+
};
|
|
3956
|
+
};
|
|
3957
|
+
/** @description Current report not found */
|
|
3958
|
+
404: {
|
|
3959
|
+
headers: {
|
|
3960
|
+
[name: string]: unknown;
|
|
3961
|
+
};
|
|
3962
|
+
content: {
|
|
3963
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3964
|
+
};
|
|
3965
|
+
};
|
|
3966
|
+
/** @description The request exceeded a rate limit. */
|
|
3967
|
+
429: {
|
|
3968
|
+
headers: {
|
|
3969
|
+
"RateLimit-Limit"?: string;
|
|
3970
|
+
"RateLimit-Reset"?: string;
|
|
3971
|
+
"Retry-After"?: string;
|
|
3972
|
+
"X-Billing-Period-Quota-Limit"?: string;
|
|
3973
|
+
"X-Billing-Period-Quota-Remaining"?: string;
|
|
3974
|
+
"X-Billing-Period-Quota-Reset"?: string;
|
|
3975
|
+
[name: string]: unknown;
|
|
3976
|
+
};
|
|
3977
|
+
content: {
|
|
3978
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3979
|
+
};
|
|
3980
|
+
};
|
|
3981
|
+
/** @description Required catalog data or prepared output is unavailable */
|
|
3982
|
+
503: {
|
|
3983
|
+
headers: {
|
|
3984
|
+
[name: string]: unknown;
|
|
3985
|
+
};
|
|
3986
|
+
content: {
|
|
3987
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3988
|
+
};
|
|
3989
|
+
};
|
|
3990
|
+
};
|
|
3991
|
+
};
|
|
3498
3992
|
getSecInsiderFiling: {
|
|
3499
3993
|
parameters: {
|
|
3500
3994
|
query?: never;
|
|
@@ -4118,6 +4612,24 @@ interface operations {
|
|
|
4118
4612
|
}
|
|
4119
4613
|
|
|
4120
4614
|
type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
|
|
4615
|
+
type CurrentReport = components["schemas"]["CurrentReport"];
|
|
4616
|
+
type CurrentReportForm = CurrentReport["form"];
|
|
4617
|
+
type CurrentReportFeedFamily = "8-K" | "6-K";
|
|
4618
|
+
type CurrentReportFeedPage = components["schemas"]["CurrentReportFeedPage"];
|
|
4619
|
+
type CurrentReportPage = components["schemas"]["CurrentReportPage"];
|
|
4620
|
+
interface CurrentReportListParams {
|
|
4621
|
+
from: string;
|
|
4622
|
+
until?: string;
|
|
4623
|
+
cik?: string;
|
|
4624
|
+
forms?: CurrentReportForm[];
|
|
4625
|
+
items?: string[];
|
|
4626
|
+
cursor?: string;
|
|
4627
|
+
limit?: number;
|
|
4628
|
+
}
|
|
4629
|
+
interface CurrentReportFeedFilters {
|
|
4630
|
+
forms?: CurrentReportFeedFamily[];
|
|
4631
|
+
limit?: number;
|
|
4632
|
+
}
|
|
4121
4633
|
type CompanyReportFiscalPeriod = "FY" | "Q1" | "Q2" | "Q3";
|
|
4122
4634
|
type CompanySelector = {
|
|
4123
4635
|
ticker: string;
|
|
@@ -4201,6 +4713,7 @@ declare class HttpTransport {
|
|
|
4201
4713
|
|
|
4202
4714
|
declare class Feeds {
|
|
4203
4715
|
readonly companyReports: CompanyReportFeed;
|
|
4716
|
+
readonly currentReports: CurrentReportFeed;
|
|
4204
4717
|
readonly insiderActivity: InsiderActivityFeed;
|
|
4205
4718
|
readonly insiderTransactions: InsiderTransactionFeed;
|
|
4206
4719
|
readonly institutionalFilings: InstitutionalFilingFeed;
|
|
@@ -4216,6 +4729,16 @@ declare class CompanyReportFeed {
|
|
|
4216
4729
|
}): PromiseWithResponse<JsonResponse<"listCompanyReportFeed">>;
|
|
4217
4730
|
startFromNow(filters?: CompanyReportFeedFilters): PromiseWithResponse<JsonResponse<"listCompanyReportFeed">>;
|
|
4218
4731
|
}
|
|
4732
|
+
declare class CurrentReportFeed {
|
|
4733
|
+
#private;
|
|
4734
|
+
private readonly transport;
|
|
4735
|
+
constructor(transport: HttpTransport);
|
|
4736
|
+
listLatest(filters?: CurrentReportFeedFilters): PromiseWithResponse<JsonResponse<"listCurrentReportFeed">>;
|
|
4737
|
+
listAfter({ cursor, ...filters }: CurrentReportFeedFilters & {
|
|
4738
|
+
cursor: string;
|
|
4739
|
+
}): PromiseWithResponse<JsonResponse<"listCurrentReportFeed">>;
|
|
4740
|
+
startFromNow(filters?: CurrentReportFeedFilters): PromiseWithResponse<JsonResponse<"listCurrentReportFeed">>;
|
|
4741
|
+
}
|
|
4219
4742
|
declare class InsiderActivityFeed {
|
|
4220
4743
|
#private;
|
|
4221
4744
|
private readonly transport;
|
|
@@ -4269,6 +4792,17 @@ declare class CompanyReports {
|
|
|
4269
4792
|
accessionNumber: string;
|
|
4270
4793
|
}): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;
|
|
4271
4794
|
}
|
|
4795
|
+
declare class CurrentReports {
|
|
4796
|
+
private readonly transport;
|
|
4797
|
+
constructor(transport: HttpTransport);
|
|
4798
|
+
list({ from, until, cik, forms, items, cursor, limit }: CurrentReportListParams): PromiseWithResponse<JsonResponse<"listCurrentReports">>;
|
|
4799
|
+
get({ accessionNumber }: {
|
|
4800
|
+
accessionNumber: string;
|
|
4801
|
+
}): PromiseWithResponse<JsonResponse<"getCurrentReport">>;
|
|
4802
|
+
getHtml({ accessionNumber }: {
|
|
4803
|
+
accessionNumber: string;
|
|
4804
|
+
}): PromiseWithResponse<TextResponse<"getCurrentReportHtml">>;
|
|
4805
|
+
}
|
|
4272
4806
|
declare class FinancialStatements {
|
|
4273
4807
|
private readonly transport;
|
|
4274
4808
|
constructor(transport: HttpTransport);
|
|
@@ -4394,6 +4928,7 @@ interface ClientOptions {
|
|
|
4394
4928
|
declare class Chadwin {
|
|
4395
4929
|
readonly companies: Companies;
|
|
4396
4930
|
readonly companyReports: CompanyReports;
|
|
4931
|
+
readonly currentReports: CurrentReports;
|
|
4397
4932
|
readonly feeds: Feeds;
|
|
4398
4933
|
readonly financialStatements: FinancialStatements;
|
|
4399
4934
|
readonly insiderFilings: InsiderFilings;
|
|
@@ -4416,4 +4951,4 @@ declare class APIError extends Error {
|
|
|
4416
4951
|
constructor(message: string, options?: APIErrorOptions);
|
|
4417
4952
|
}
|
|
4418
4953
|
|
|
4419
|
-
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 };
|
|
4954
|
+
export { APIError, Chadwin, type ClientOptions, type CompanyReportFeedFilters, type CompanyReportFiscalPeriod, type CompanyReportForm, type CompanySelector, type CurrentReport, type CurrentReportFeedFamily, type CurrentReportFeedFilters, type CurrentReportFeedPage, type CurrentReportForm, type CurrentReportListParams, type CurrentReportPage, type FinancialStatementsGetParams, type InsiderActivityFeedFilters, type InsiderActivityForm, type InsiderTransactionCode, type InsiderTransactionFeedFilters, type InstitutionalFilingFeedFilters, type InstitutionalFilingForm, type InstitutionalHolding, type InstitutionalManager, type InstitutionalPosition, type PromiseWithResponse };
|