arche-sdk 0.0.0-stage → 0.1.145
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/LICENSE +202 -0
- package/README.md +35 -2
- package/dist/client.d.ts +55 -0
- package/dist/client.js +104 -0
- package/dist/generated/operations.d.ts +576 -0
- package/dist/generated/operations.js +368 -0
- package/dist/generated/types.d.ts +2158 -0
- package/dist/generated/types.js +2 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +1 -0
- package/package.json +37 -4
|
@@ -0,0 +1,576 @@
|
|
|
1
|
+
import type * as T from './types.js';
|
|
2
|
+
/** Where generated operations send their requests. */
|
|
3
|
+
export interface Transport {
|
|
4
|
+
request<R>(method: string, path: string, options?: {
|
|
5
|
+
query?: Record<string, unknown>;
|
|
6
|
+
body?: unknown;
|
|
7
|
+
}): Promise<R>;
|
|
8
|
+
}
|
|
9
|
+
/** One method per public Arche API operation. */
|
|
10
|
+
export declare abstract class Operations {
|
|
11
|
+
protected abstract readonly transport: Transport;
|
|
12
|
+
/** GET /v1/account/webhook-subscriptions - List account webhook subscriptions */
|
|
13
|
+
listWebhookSubscriptions(): Promise<T.WebhookSubscriptionListEnvelope>;
|
|
14
|
+
/** POST /v1/account/webhook-subscriptions - Create account webhook subscription */
|
|
15
|
+
createWebhookSubscription(body: T.WebhookSubscriptionCreateRequestHTTP): Promise<T.WebhookSubscriptionWithSecretEnvelope>;
|
|
16
|
+
/** DELETE /v1/account/webhook-subscriptions/{subscription_id} - Delete account webhook subscription */
|
|
17
|
+
deleteWebhookSubscription(subscription_id: string): Promise<T.WebhookSubscriptionEnvelope>;
|
|
18
|
+
/** POST /v1/account/webhook-subscriptions/{subscription_id}/rotate-secret - Rotate a webhook subscription's signing secret */
|
|
19
|
+
rotateWebhookSecret(subscription_id: string): Promise<T.WebhookSubscriptionWithSecretEnvelope>;
|
|
20
|
+
/** POST /v1/agent/checkout-link - Get a payment link for the account's owner */
|
|
21
|
+
createAgentCheckoutLink(body: (T.AgentCheckoutLinkRequestHTTP | null)): Promise<T.AgentCheckoutLinkEnvelope>;
|
|
22
|
+
/** POST /v1/agent/claim - Claim the account an agent opened */
|
|
23
|
+
claimAgentAccount(body: T.AgentClaimRequestHTTP): Promise<T.AgentClaimEnvelope>;
|
|
24
|
+
/** POST /v1/agent/signup - Open a Free account for an agent's owner */
|
|
25
|
+
agentSignup(body: T.AgentSignupRequestHTTP): Promise<T.AgentSignupEnvelope>;
|
|
26
|
+
/** GET /v1/ai/companies/{company_id}/anomaly-explanations - Anomaly explanations */
|
|
27
|
+
listAnomalyExplanations(company_id: string, query: {
|
|
28
|
+
"as_of": string;
|
|
29
|
+
"min_severity"?: (T.MaterialityClass | null);
|
|
30
|
+
"page"?: number;
|
|
31
|
+
"page_size"?: number;
|
|
32
|
+
}): Promise<T.AnomalyExplanationPage>;
|
|
33
|
+
/** GET /v1/ai/companies/{company_id}/embeddings/metadata - Embedding metadata (experimental) */
|
|
34
|
+
listEmbeddingMetadata(company_id: string, query: {
|
|
35
|
+
"as_of": string;
|
|
36
|
+
"embedding_type"?: (T.EmbeddingType | null);
|
|
37
|
+
"page"?: number;
|
|
38
|
+
"page_size"?: number;
|
|
39
|
+
}): Promise<T.EmbeddingMetadataPage>;
|
|
40
|
+
/** GET /v1/ai/companies/{company_id}/narratives - Financial narratives */
|
|
41
|
+
listNarratives(company_id: string, query: {
|
|
42
|
+
"as_of": string;
|
|
43
|
+
"narrative_type": T.NarrativeType;
|
|
44
|
+
"statement_type"?: T.StatementType;
|
|
45
|
+
"page"?: number;
|
|
46
|
+
"page_size"?: number;
|
|
47
|
+
}): Promise<T.NarrativePage>;
|
|
48
|
+
/** GET /v1/ai/companies/{company_id}/peers - Peer similarity (experimental) */
|
|
49
|
+
listPeerSets(company_id: string, query: {
|
|
50
|
+
"as_of": string;
|
|
51
|
+
"embedding_type"?: (T.EmbeddingType | null);
|
|
52
|
+
"page"?: number;
|
|
53
|
+
"page_size"?: number;
|
|
54
|
+
}): Promise<T.PeerSetPage>;
|
|
55
|
+
/** GET /v1/analysis/metric-drift - Metric drift analytics */
|
|
56
|
+
getMetricDrift(query: {
|
|
57
|
+
"cik"?: (string | null);
|
|
58
|
+
"ticker"?: (string | null);
|
|
59
|
+
"statement_type": T.StatementType;
|
|
60
|
+
"fiscal_year": number;
|
|
61
|
+
"fiscal_period": T.FiscalPeriod;
|
|
62
|
+
"metric": string;
|
|
63
|
+
"statement_date"?: (string | null);
|
|
64
|
+
}): Promise<T.MetricDriftEnvelope>;
|
|
65
|
+
/** GET /v1/analysis/model-impact - Model impact of restatements */
|
|
66
|
+
getModelImpact(query: {
|
|
67
|
+
"cik"?: (string | null);
|
|
68
|
+
"ticker"?: (string | null);
|
|
69
|
+
"statement_type": T.StatementType;
|
|
70
|
+
"fiscal_year": number;
|
|
71
|
+
"fiscal_period": T.FiscalPeriod;
|
|
72
|
+
"allow_market_inputs"?: boolean;
|
|
73
|
+
"statement_date"?: (string | null);
|
|
74
|
+
}): Promise<T.ModelImpactEnvelope>;
|
|
75
|
+
/** GET /v1/analysis/version-delta - First-filed versus latest-filed metric delta */
|
|
76
|
+
getVersionDelta(query: {
|
|
77
|
+
"cik"?: (string | null);
|
|
78
|
+
"ticker"?: (string | null);
|
|
79
|
+
"statement_type": T.StatementType;
|
|
80
|
+
"fiscal_year": number;
|
|
81
|
+
"fiscal_period": T.FiscalPeriod;
|
|
82
|
+
"metric": string;
|
|
83
|
+
"statement_date"?: (string | null);
|
|
84
|
+
}): Promise<T.VersionMetricDeltaEnvelope>;
|
|
85
|
+
/** GET /v1/bulk/datasets - List the bulk export dataset contract */
|
|
86
|
+
listBulkDatasets(): Promise<T.BulkDatasetListEnvelope>;
|
|
87
|
+
/** GET /v1/bulk/license - Read the bulk-data license and whether it is accepted */
|
|
88
|
+
getBulkLicense(): Promise<T.BulkLicenseEnvelope>;
|
|
89
|
+
/** POST /v1/bulk/license/acceptance - Accept the bulk-data license for the organization */
|
|
90
|
+
acceptBulkLicense(body: T.BulkLicenseAcceptanceRequestHTTP): Promise<T.BulkLicenseAcceptanceRecordEnvelope>;
|
|
91
|
+
/** GET /v1/bulk/snapshots - List published bulk export snapshots */
|
|
92
|
+
listBulkSnapshots(query?: {
|
|
93
|
+
"page"?: (number | null);
|
|
94
|
+
"page_size"?: (number | null);
|
|
95
|
+
}): Promise<T.BulkSnapshotPage>;
|
|
96
|
+
/** GET /v1/bulk/snapshots/{snapshot_id} - Read one bulk export snapshot's manifest */
|
|
97
|
+
getBulkSnapshot(snapshot_id: string): Promise<T.BulkSnapshotManifestEnvelope>;
|
|
98
|
+
/** GET /v1/bulk/snapshots/{snapshot_id}/files/{file_path} - Issue a download URL for one snapshot file */
|
|
99
|
+
getBulkSnapshotFileUrl(snapshot_id: string, file_path: string): Promise<T.BulkDownloadUrlEnvelope>;
|
|
100
|
+
/** GET /v1/coverage/companies - List company coverage summaries */
|
|
101
|
+
listCompanyCoverage(query?: {
|
|
102
|
+
"page"?: number;
|
|
103
|
+
"page_size"?: number;
|
|
104
|
+
}): Promise<T.CompanyCoverageSummaryPage>;
|
|
105
|
+
/** GET /v1/coverage/companies/{cik} - Get company coverage summary */
|
|
106
|
+
getCompanyCoverage(cik: string): Promise<T.CompanyCoverageSummaryEnvelope>;
|
|
107
|
+
/** GET /v1/coverage/metrics - List metric coverage summaries */
|
|
108
|
+
listMetricCoverage(query?: {
|
|
109
|
+
"page"?: number;
|
|
110
|
+
"page_size"?: number;
|
|
111
|
+
}): Promise<T.MetricCoverageSummaryPage>;
|
|
112
|
+
/** GET /v1/coverage/metrics/{metric} - Get metric coverage summary */
|
|
113
|
+
getMetricCoverage(metric: string): Promise<T.MetricCoverageSummaryEnvelope>;
|
|
114
|
+
/** GET /v1/coverage/selection - Show the companies this plan covers */
|
|
115
|
+
getCoverageSelection(): Promise<T.CoverageSelectionEnvelope>;
|
|
116
|
+
/** POST /v1/coverage/selection/release - Release one company's coverage slot */
|
|
117
|
+
releaseCoverageSlot(body: T.CoverageSelectionReleaseRequestHTTP): Promise<T.CoverageSelectionEnvelope>;
|
|
118
|
+
/** GET /v1/data-quality/issues - List public data-quality issues */
|
|
119
|
+
listDataQualityIssues(query?: {
|
|
120
|
+
"cik"?: (string | null);
|
|
121
|
+
"ticker"?: (string | null);
|
|
122
|
+
"metric"?: (string | null);
|
|
123
|
+
"statement_type"?: (string | null);
|
|
124
|
+
"fiscal_year"?: (number | null);
|
|
125
|
+
"fiscal_period"?: (string | null);
|
|
126
|
+
"severity"?: (string | null);
|
|
127
|
+
"rule_code"?: (string | null);
|
|
128
|
+
"page"?: number;
|
|
129
|
+
"page_size"?: number;
|
|
130
|
+
}): Promise<T.DataQualityIssuePage>;
|
|
131
|
+
/** GET /v1/edgar/as-of/{date}/financials/{cik} - Get EDGAR financials as-of a date or time */
|
|
132
|
+
getAsOfFinancials(cik: string, date: string, query?: {
|
|
133
|
+
"audit_mode"?: boolean;
|
|
134
|
+
"detail"?: boolean;
|
|
135
|
+
"include_usd"?: boolean;
|
|
136
|
+
}): Promise<T.EdgarFinancialsAsOfEnvelope>;
|
|
137
|
+
/** GET /v1/edgar/as-of/{date}/financials/{cik}/page - Get one page of EDGAR financials as-of a date or time */
|
|
138
|
+
getAsOfFinancialsPage(cik: string, date: string, query: {
|
|
139
|
+
"limit": number;
|
|
140
|
+
"offset"?: number;
|
|
141
|
+
"statement_type"?: (T.StatementType | null);
|
|
142
|
+
"fiscal_year_from"?: (number | null);
|
|
143
|
+
"fiscal_year_to"?: (number | null);
|
|
144
|
+
"fiscal_period"?: (T.FiscalPeriod | null);
|
|
145
|
+
"latest_only"?: boolean;
|
|
146
|
+
"audit_mode"?: boolean;
|
|
147
|
+
"detail"?: boolean;
|
|
148
|
+
"include_usd"?: boolean;
|
|
149
|
+
}): Promise<T.EdgarFinancialsAsOfPageEnvelope>;
|
|
150
|
+
/** GET /v1/edgar/companies/{cik} - Get canonical EDGAR company profile */
|
|
151
|
+
getCompany(cik: string): Promise<T.EdgarCompanyProfileEnvelope>;
|
|
152
|
+
/** GET /v1/edgar/companies/{cik}/completeness - Get EDGAR completeness summary for a company */
|
|
153
|
+
getCompanyCompleteness(cik: string): Promise<T.EdgarCompanyCompletenessEnvelope>;
|
|
154
|
+
/** GET /v1/edgar/companies/{cik}/disclosures - List a company's narrative disclosures */
|
|
155
|
+
listDisclosures(cik: string, query?: {
|
|
156
|
+
"period_of_report"?: (string | null);
|
|
157
|
+
"accession_id"?: (string | null);
|
|
158
|
+
"page"?: (number | null);
|
|
159
|
+
"page_size"?: (number | null);
|
|
160
|
+
}): Promise<T.EdgarFilingDisclosureSummaryPage>;
|
|
161
|
+
/** GET /v1/edgar/companies/{cik}/facts - List the values a company reported in XBRL */
|
|
162
|
+
listAsReportedFacts(cik: string, query?: {
|
|
163
|
+
"concepts"?: (Array<string> | null);
|
|
164
|
+
"units"?: (Array<string> | null);
|
|
165
|
+
"filing_types"?: (Array<string> | null);
|
|
166
|
+
"period_end_from"?: (string | null);
|
|
167
|
+
"period_end_to"?: (string | null);
|
|
168
|
+
"as_of"?: (string | null);
|
|
169
|
+
"page"?: (number | null);
|
|
170
|
+
"page_size"?: (number | null);
|
|
171
|
+
}): Promise<T.AsReportedFactPage>;
|
|
172
|
+
/** GET /v1/edgar/companies/{cik}/facts/concepts - List every XBRL concept a company reported */
|
|
173
|
+
listAsReportedConcepts(cik: string, query?: {
|
|
174
|
+
"taxonomy"?: (string | null);
|
|
175
|
+
"search"?: (string | null);
|
|
176
|
+
"as_of"?: (string | null);
|
|
177
|
+
"page"?: (number | null);
|
|
178
|
+
"page_size"?: (number | null);
|
|
179
|
+
}): Promise<T.AsReportedConceptPage>;
|
|
180
|
+
/** GET /v1/edgar/companies/{cik}/filings - List EDGAR filings for a company */
|
|
181
|
+
listFilings(cik: string, query?: {
|
|
182
|
+
"filing_types"?: (Array<T.FilingType> | null);
|
|
183
|
+
"from_date"?: (string | null);
|
|
184
|
+
"to_date"?: (string | null);
|
|
185
|
+
"include_amendments"?: boolean;
|
|
186
|
+
"page"?: (number | null);
|
|
187
|
+
"page_size"?: (number | null);
|
|
188
|
+
}): Promise<T.EdgarFilingPage>;
|
|
189
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id} - Get EDGAR filing detail */
|
|
190
|
+
getFiling(cik: string, accession_id: string, query?: {
|
|
191
|
+
"include_statements"?: boolean;
|
|
192
|
+
"include_long_form"?: boolean;
|
|
193
|
+
}): Promise<T.EdgarFilingEnvelope>;
|
|
194
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/earnings-release - Get an 8-K's earnings release as filed */
|
|
195
|
+
getFilingEarningsRelease(cik: string, accession_id: string): Promise<T.EarningsReleaseEnvelope>;
|
|
196
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/facts - List every numeric fact in a filing's XBRL */
|
|
197
|
+
listFilingFacts(cik: string, accession_id: string, query?: {
|
|
198
|
+
"concepts"?: (Array<string> | null);
|
|
199
|
+
"taxonomies"?: (Array<string> | null);
|
|
200
|
+
"axes"?: (Array<string> | null);
|
|
201
|
+
"dimensioned"?: (boolean | null);
|
|
202
|
+
"page"?: (number | null);
|
|
203
|
+
"page_size"?: (number | null);
|
|
204
|
+
}): Promise<T.FilingFactPage>;
|
|
205
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements - Get the statements a filing reported */
|
|
206
|
+
listFilingStatements(cik: string, accession_id: string, query?: {
|
|
207
|
+
"statement_type"?: (T.StatementType | null);
|
|
208
|
+
"detail"?: boolean;
|
|
209
|
+
"include_usd"?: boolean;
|
|
210
|
+
}): Promise<T.EdgarStatementListEnvelope>;
|
|
211
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/fact-revisions - Get the fact revision ledger of a filing's statement */
|
|
212
|
+
listFactRevisions(cik: string, accession_id: string, statement_type: string, fiscal_year: string, fiscal_period: string, query?: {
|
|
213
|
+
"statement_date"?: (string | null);
|
|
214
|
+
}): Promise<T.FactRevisionLedgerEnvelope>;
|
|
215
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/metrics/{metric_name}/audit-chain - Get the metric audit chain of a filing's statement */
|
|
216
|
+
getMetricAuditChain(cik: string, accession_id: string, statement_type: string, fiscal_year: string, fiscal_period: string, metric_name: string, query?: {
|
|
217
|
+
"statement_date"?: (string | null);
|
|
218
|
+
}): Promise<T.StatementMetricAuditChainEnvelope>;
|
|
219
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements/{statement_type}/{fiscal_year}/{fiscal_period}/metrics/{metric_name}/provenance - Get simplified metric provenance for a filing's statement */
|
|
220
|
+
getMetricProvenance(cik: string, accession_id: string, statement_type: string, fiscal_year: string, fiscal_period: string, metric_name: string, query?: {
|
|
221
|
+
"statement_date"?: (string | null);
|
|
222
|
+
}): Promise<T.StatementMetricPublicProvenanceEnvelope>;
|
|
223
|
+
/** GET /v1/edgar/companies/{cik}/financial-state/time-series - Get aligned financial-state time series */
|
|
224
|
+
getFinancialStateTimeSeries(cik: string, query?: {
|
|
225
|
+
"fiscal_period"?: (string | null);
|
|
226
|
+
"fiscal_year_from"?: (number | null);
|
|
227
|
+
"fiscal_year_to"?: (number | null);
|
|
228
|
+
"period_type"?: (string | null);
|
|
229
|
+
"as_of_date"?: (string | null);
|
|
230
|
+
"include_provenance"?: boolean;
|
|
231
|
+
"include_macro_context"?: boolean;
|
|
232
|
+
"page"?: number;
|
|
233
|
+
"page_size"?: number;
|
|
234
|
+
}): Promise<T.FinancialStatePeriodPage>;
|
|
235
|
+
/** GET /v1/edgar/companies/{cik}/metric-bundles/{bundle_code}/time-series - Get filing-based metric bundle time series */
|
|
236
|
+
getMetricBundleTimeSeries(cik: string, bundle_code: string, query?: {
|
|
237
|
+
"fiscal_period"?: (string | null);
|
|
238
|
+
"fiscal_year_from"?: (number | null);
|
|
239
|
+
"fiscal_year_to"?: (number | null);
|
|
240
|
+
"period_type"?: (string | null);
|
|
241
|
+
"as_of_date"?: (string | null);
|
|
242
|
+
"include_provenance"?: boolean;
|
|
243
|
+
"page"?: number;
|
|
244
|
+
"page_size"?: number;
|
|
245
|
+
}): Promise<T.MetricBundleTimeSeriesRowPage>;
|
|
246
|
+
/** GET /v1/edgar/companies/{cik}/metrics/{metric}/time-series - Get normalized metric time series */
|
|
247
|
+
getMetricTimeSeries(cik: string, metric: string, query?: {
|
|
248
|
+
"statement_type"?: (string | null);
|
|
249
|
+
"fiscal_period"?: (string | null);
|
|
250
|
+
"fiscal_year_from"?: (number | null);
|
|
251
|
+
"fiscal_year_to"?: (number | null);
|
|
252
|
+
"period_type"?: (string | null);
|
|
253
|
+
"as_reported"?: boolean;
|
|
254
|
+
"as_of_date"?: (string | null);
|
|
255
|
+
"include_provenance"?: boolean;
|
|
256
|
+
"page"?: number;
|
|
257
|
+
"page_size"?: number;
|
|
258
|
+
}): Promise<T.PaginatedEnvelopeMetricTimeSeriesHTTP>;
|
|
259
|
+
/** GET /v1/edgar/companies/{cik}/statements - List EDGAR statements for a company */
|
|
260
|
+
listStatements(cik: string, query: {
|
|
261
|
+
"statement_type": string;
|
|
262
|
+
"from_date"?: (string | null);
|
|
263
|
+
"to_date"?: (string | null);
|
|
264
|
+
"include_restated"?: boolean;
|
|
265
|
+
"detail"?: boolean;
|
|
266
|
+
"include_usd"?: boolean;
|
|
267
|
+
"page"?: (number | null);
|
|
268
|
+
"page_size"?: (number | null);
|
|
269
|
+
}): Promise<T.EdgarStatementPage>;
|
|
270
|
+
/** GET /v1/edgar/companies/{cik}/statements/dq/overlay - Get a normalized statement with DQ overlay */
|
|
271
|
+
getStatementDqOverlay(cik: string, query: {
|
|
272
|
+
"statement_type": string;
|
|
273
|
+
"fiscal_year": number;
|
|
274
|
+
"fiscal_period": string;
|
|
275
|
+
"accession_id": string;
|
|
276
|
+
"statement_date"?: (string | null);
|
|
277
|
+
}): Promise<T.StatementDQOverlayEnvelope>;
|
|
278
|
+
/** GET /v1/edgar/companies/{cik}/statements/overrides/trace - Inspect XBRL mapping overrides for a statement identity */
|
|
279
|
+
getStatementOverrideTrace(cik: string, query: {
|
|
280
|
+
"statement_type": string;
|
|
281
|
+
"fiscal_year": number;
|
|
282
|
+
"fiscal_period": string;
|
|
283
|
+
"accession_id": string;
|
|
284
|
+
"gaap_concept"?: (string | null);
|
|
285
|
+
"canonical_metric_code"?: (string | null);
|
|
286
|
+
"dimension_key"?: (string | null);
|
|
287
|
+
"statement_date"?: (string | null);
|
|
288
|
+
}): Promise<T.StatementOverrideTraceEnvelope>;
|
|
289
|
+
/** GET /v1/edgar/companies/{cik}/statements/restatement-timeline - Get restatement metric timeline for a statement identity */
|
|
290
|
+
getRestatementTimeline(cik: string, query: {
|
|
291
|
+
"statement_type": string;
|
|
292
|
+
"fiscal_year": number;
|
|
293
|
+
"fiscal_period": string;
|
|
294
|
+
"include_unchanged_filings"?: boolean;
|
|
295
|
+
"statement_date"?: (string | null);
|
|
296
|
+
}): Promise<T.RestatementMetricTimelineEnvelope>;
|
|
297
|
+
/** GET /v1/edgar/companies:resolve - Resolve canonical CIK by ticker */
|
|
298
|
+
resolveCompany(query: {
|
|
299
|
+
"ticker": string;
|
|
300
|
+
"as_of"?: (string | null);
|
|
301
|
+
}): Promise<T.EdgarCompanyResolveEnvelope>;
|
|
302
|
+
/** GET /v1/edgar/derived-metrics/catalog - List derived metrics catalog */
|
|
303
|
+
listDerivedMetrics(): Promise<T.EdgarDerivedMetricsCatalogEnvelope>;
|
|
304
|
+
/** GET /v1/edgar/derived-metrics/time-series - Get derived metrics time series */
|
|
305
|
+
getDerivedMetricsTimeSeries(query: {
|
|
306
|
+
"ciks"?: (Array<string> | null);
|
|
307
|
+
"tickers"?: (Array<string> | null);
|
|
308
|
+
"statement_type": string;
|
|
309
|
+
"metrics"?: (Array<T.DerivedMetric> | null);
|
|
310
|
+
"frequency"?: string;
|
|
311
|
+
"from_date"?: (string | null);
|
|
312
|
+
"to_date"?: (string | null);
|
|
313
|
+
}): Promise<T.EdgarDerivedMetricsTimeSeriesEnvelope>;
|
|
314
|
+
/** GET /v1/edgar/disclosures/{disclosure_id} - Read one narrative disclosure */
|
|
315
|
+
getDisclosure(disclosure_id: string): Promise<T.EdgarFilingDisclosureEnvelope>;
|
|
316
|
+
/** GET /v1/edgar/metric-bundles - List filing-based metric bundles */
|
|
317
|
+
listMetricBundles(): Promise<T.MetricBundleCatalogItemListEnvelope>;
|
|
318
|
+
/** GET /v1/edgar/reconciliation/ledger - Get reconciliation ledger for a statement identity */
|
|
319
|
+
getReconciliationLedger(query: {
|
|
320
|
+
"cik"?: (string | null);
|
|
321
|
+
"ticker"?: (string | null);
|
|
322
|
+
"statement_type": string;
|
|
323
|
+
"fiscal_year": number;
|
|
324
|
+
"fiscal_period": string;
|
|
325
|
+
"accession_id": string;
|
|
326
|
+
"rule_category"?: (T.ReconciliationRuleCategory | null);
|
|
327
|
+
"statuses"?: (Array<T.ReconciliationStatus> | null);
|
|
328
|
+
"limit"?: (number | null);
|
|
329
|
+
"page"?: number;
|
|
330
|
+
"statement_date"?: (string | null);
|
|
331
|
+
"page_size"?: number;
|
|
332
|
+
}): Promise<T.ReconciliationResultPage>;
|
|
333
|
+
/** GET /v1/edgar/reconciliation/summary - Get reconciliation summary for a fiscal-year window */
|
|
334
|
+
getReconciliationSummary(query: {
|
|
335
|
+
"cik"?: (string | null);
|
|
336
|
+
"ticker"?: (string | null);
|
|
337
|
+
"statement_type": string;
|
|
338
|
+
"fiscal_year_from": number;
|
|
339
|
+
"fiscal_year_to": number;
|
|
340
|
+
"rule_category"?: (T.ReconciliationRuleCategory | null);
|
|
341
|
+
"limit"?: number;
|
|
342
|
+
}): Promise<T.ReconciliationSummaryBucketListEnvelope>;
|
|
343
|
+
/** GET /v1/edgar/restatement-alerts - List restatement alert events */
|
|
344
|
+
listRestatementAlerts(query?: {
|
|
345
|
+
"cik"?: (string | null);
|
|
346
|
+
"ticker"?: (string | null);
|
|
347
|
+
"from"?: (string | null);
|
|
348
|
+
"to"?: (string | null);
|
|
349
|
+
"statement_type"?: (T.StatementType | null);
|
|
350
|
+
"materiality_score"?: (T.MaterialityClass | null);
|
|
351
|
+
"page"?: (number | null);
|
|
352
|
+
"page_size"?: (number | null);
|
|
353
|
+
}): Promise<T.RestatementAlertEventPage>;
|
|
354
|
+
/** GET /v1/edgar/restatement-alerts/{restatement_alert_event_id} - Get one restatement alert event */
|
|
355
|
+
getRestatementAlert(restatement_alert_event_id: string): Promise<T.RestatementAlertEventEnvelope>;
|
|
356
|
+
/** GET /v1/edgar/statements/restatements/delta - Get restatement delta between two filings */
|
|
357
|
+
getRestatementDelta(query: {
|
|
358
|
+
"cik"?: (string | null);
|
|
359
|
+
"ticker"?: (string | null);
|
|
360
|
+
"statement_type": string;
|
|
361
|
+
"fiscal_year": number;
|
|
362
|
+
"fiscal_period": string;
|
|
363
|
+
"from_accession"?: (string | null);
|
|
364
|
+
"to_accession"?: (string | null);
|
|
365
|
+
"statement_date"?: (string | null);
|
|
366
|
+
}): Promise<T.RestatementDeltaSuccessEnvelope>;
|
|
367
|
+
/** GET /v1/edgar/statements/restatements/ledger - Get restatement ledger for a statement identity */
|
|
368
|
+
getRestatementLedger(query: {
|
|
369
|
+
"cik"?: (string | null);
|
|
370
|
+
"ticker"?: (string | null);
|
|
371
|
+
"statement_type": string;
|
|
372
|
+
"fiscal_year": number;
|
|
373
|
+
"fiscal_period": string;
|
|
374
|
+
"include_unchanged_filings"?: boolean;
|
|
375
|
+
"statement_date"?: (string | null);
|
|
376
|
+
}): Promise<T.RestatementLedgerEnvelope>;
|
|
377
|
+
/** GET /v1/fundamentals/companies/{cik}/metrics/{metric}/time-series/real - Inflation-adjusted EDGAR metric time series */
|
|
378
|
+
getRealMetricTimeSeries(cik: string, metric: string, query?: {
|
|
379
|
+
"base_year"?: (number | null);
|
|
380
|
+
"fiscal_period"?: (T.FiscalPeriod | null);
|
|
381
|
+
"fiscal_year_from"?: (number | null);
|
|
382
|
+
"fiscal_year_to"?: (number | null);
|
|
383
|
+
"as_of_date"?: (string | null);
|
|
384
|
+
"cpi_series"?: T.MacroSeriesCode;
|
|
385
|
+
}): Promise<T.RealFundamentalMetricSeriesEnvelope>;
|
|
386
|
+
/** GET /v1/fundamentals/derived/time-series - Derived metrics time series */
|
|
387
|
+
getFundamentalsDerivedTimeSeries(query: {
|
|
388
|
+
"ciks"?: (Array<string> | null);
|
|
389
|
+
"tickers"?: (Array<string> | null);
|
|
390
|
+
"statement_type": T.StatementType;
|
|
391
|
+
"metrics"?: (Array<T.DerivedMetric> | null);
|
|
392
|
+
"frequency"?: string;
|
|
393
|
+
"from"?: (string | null);
|
|
394
|
+
"to"?: (string | null);
|
|
395
|
+
"page"?: number;
|
|
396
|
+
"page_size"?: number;
|
|
397
|
+
}): Promise<T.FundamentalsTimeSeriesPointPage>;
|
|
398
|
+
/** GET /v1/fundamentals/macro/context/{target_date} - Macro context for a date */
|
|
399
|
+
getMacroContext(target_date: string, query?: {
|
|
400
|
+
"as_of_date"?: (string | null);
|
|
401
|
+
}): Promise<T.MacroContextEnvelope>;
|
|
402
|
+
/** GET /v1/fundamentals/macro/series - Approved macro series registry */
|
|
403
|
+
listMacroSeries(): Promise<T.MacroSeriesDefinitionListEnvelope>;
|
|
404
|
+
/** GET /v1/fundamentals/macro/series/{series_code} - Approved macro series observations */
|
|
405
|
+
getMacroSeries(series_code: string, query: {
|
|
406
|
+
"from_date": string;
|
|
407
|
+
"to_date": string;
|
|
408
|
+
"as_of_date"?: (string | null);
|
|
409
|
+
}): Promise<T.MacroSeriesEnvelope>;
|
|
410
|
+
/** GET /v1/fundamentals/normalized-statements - Normalized EDGAR statement as each filing reported it */
|
|
411
|
+
getNormalizedStatement(query: {
|
|
412
|
+
"cik"?: (string | null);
|
|
413
|
+
"ticker"?: (string | null);
|
|
414
|
+
"statement_type": T.StatementType;
|
|
415
|
+
"fiscal_year": number;
|
|
416
|
+
"fiscal_period": T.FiscalPeriod;
|
|
417
|
+
"include_version_history"?: boolean;
|
|
418
|
+
"statement_date"?: (string | null);
|
|
419
|
+
"detail"?: boolean;
|
|
420
|
+
"include_usd"?: boolean;
|
|
421
|
+
}): Promise<T.NormalizedStatementViewEnvelope>;
|
|
422
|
+
/** GET /v1/fundamentals/normalized-statements/dq-overlay - Normalized statement with data-quality overlay */
|
|
423
|
+
getNormalizedStatementDqOverlay(query: {
|
|
424
|
+
"cik"?: (string | null);
|
|
425
|
+
"ticker"?: (string | null);
|
|
426
|
+
"statement_type": T.StatementType;
|
|
427
|
+
"fiscal_year": number;
|
|
428
|
+
"fiscal_period": T.FiscalPeriod;
|
|
429
|
+
"accession_id": string;
|
|
430
|
+
"statement_date"?: (string | null);
|
|
431
|
+
}): Promise<T.StatementDQOverlayEnvelope>;
|
|
432
|
+
/** GET /v1/fundamentals/restatement-delta - Restatement delta for a single statement */
|
|
433
|
+
getFundamentalsRestatementDelta(query: {
|
|
434
|
+
"cik"?: (string | null);
|
|
435
|
+
"ticker"?: (string | null);
|
|
436
|
+
"statement_type": T.StatementType;
|
|
437
|
+
"fiscal_year": number;
|
|
438
|
+
"fiscal_period": T.FiscalPeriod;
|
|
439
|
+
"from_accession"?: (string | null);
|
|
440
|
+
"to_accession"?: (string | null);
|
|
441
|
+
"metrics"?: (Array<T.CanonicalStatementMetric> | null);
|
|
442
|
+
"statement_date"?: (string | null);
|
|
443
|
+
}): Promise<T.RestatementDeltaSuccessEnvelope>;
|
|
444
|
+
/** GET /v1/fundamentals/time-series - Fundamentals time series */
|
|
445
|
+
getFundamentalsTimeSeries(query: {
|
|
446
|
+
"ciks"?: (Array<string> | null);
|
|
447
|
+
"tickers"?: (Array<string> | null);
|
|
448
|
+
"statement_type": T.StatementType;
|
|
449
|
+
"metrics"?: (Array<T.CanonicalStatementMetric> | null);
|
|
450
|
+
"frequency"?: string;
|
|
451
|
+
"from"?: (string | null);
|
|
452
|
+
"to"?: (string | null);
|
|
453
|
+
"core_metrics_only"?: boolean;
|
|
454
|
+
"page"?: number;
|
|
455
|
+
"page_size"?: number;
|
|
456
|
+
}): Promise<T.PaginatedEnvelopeFundamentalsTimeSeriesHTTP>;
|
|
457
|
+
/** GET /v1/identity/companies/{cik} - List company identity history by CIK */
|
|
458
|
+
listCompanyIdentityHistory(cik: string, query?: {
|
|
459
|
+
"page"?: number;
|
|
460
|
+
"page_size"?: number;
|
|
461
|
+
}): Promise<T.CompanyIdentityPage>;
|
|
462
|
+
/** GET /v1/identity/resolve - Resolve a ticker to one company as of a date */
|
|
463
|
+
resolveCompanyAsOf(query: {
|
|
464
|
+
"ticker": string;
|
|
465
|
+
"as_of_date"?: (string | null);
|
|
466
|
+
}): Promise<T.CompanyIdentityResolveEnvelope>;
|
|
467
|
+
/** GET /v1/identity/search - Search companies by ticker, CIK, or name */
|
|
468
|
+
searchCompanies(query: {
|
|
469
|
+
"query": string;
|
|
470
|
+
"page"?: number;
|
|
471
|
+
"page_size"?: number;
|
|
472
|
+
}): Promise<T.CompanyIdentityPage>;
|
|
473
|
+
/** GET /v1/identity/tickers/{ticker} - List ticker identity history */
|
|
474
|
+
listTickerIdentityHistory(ticker: string, query?: {
|
|
475
|
+
"page"?: number;
|
|
476
|
+
"page_size"?: number;
|
|
477
|
+
}): Promise<T.CompanyIdentityPage>;
|
|
478
|
+
/** GET /v1/metrics/definitions - List metric definitions */
|
|
479
|
+
listMetricDefinitions(): Promise<T.MetricDefinitionListEnvelope>;
|
|
480
|
+
/** GET /v1/metrics/definitions/{metric} - Get one metric definition */
|
|
481
|
+
getMetricDefinition(metric: string): Promise<T.MetricDefinitionEnvelope>;
|
|
482
|
+
/** GET /v1/metrics/segments - List segment/geography metric disclosures */
|
|
483
|
+
listSegmentMetrics(query?: {
|
|
484
|
+
"company_id"?: (string | null);
|
|
485
|
+
"cik"?: (string | null);
|
|
486
|
+
"ticker"?: (string | null);
|
|
487
|
+
"period"?: (string | null);
|
|
488
|
+
"dimension_type"?: (T.MetricDimensionType | null);
|
|
489
|
+
"page"?: number;
|
|
490
|
+
"page_size"?: number;
|
|
491
|
+
}): Promise<T.MetricDimensionPage>;
|
|
492
|
+
/** GET /v1/modeling/companies/{company_id}/growth - Modeling growth */
|
|
493
|
+
getModelingGrowth(company_id: string, query: {
|
|
494
|
+
"as_of": string;
|
|
495
|
+
"statement_type"?: (T.StatementType | null);
|
|
496
|
+
"from"?: (string | null);
|
|
497
|
+
"to"?: (string | null);
|
|
498
|
+
"sort"?: (string | null);
|
|
499
|
+
"page"?: number;
|
|
500
|
+
"page_size"?: number;
|
|
501
|
+
}): Promise<T.ModelGrowthPage>;
|
|
502
|
+
/** GET /v1/modeling/companies/{company_id}/multi-year - Modeling multi-year inputs */
|
|
503
|
+
getModelingMultiYearInputs(company_id: string, query: {
|
|
504
|
+
"as_of": string;
|
|
505
|
+
"statement_type"?: (T.StatementType | null);
|
|
506
|
+
"from"?: (string | null);
|
|
507
|
+
"to"?: (string | null);
|
|
508
|
+
"sort"?: (string | null);
|
|
509
|
+
"page"?: number;
|
|
510
|
+
"page_size"?: number;
|
|
511
|
+
}): Promise<T.ModelMultiYearPage>;
|
|
512
|
+
/** GET /v1/modeling/companies/{company_id}/periods - Modeling periods */
|
|
513
|
+
getModelingPeriods(company_id: string, query: {
|
|
514
|
+
"as_of": string;
|
|
515
|
+
"statement_type"?: (T.StatementType | null);
|
|
516
|
+
"from"?: (string | null);
|
|
517
|
+
"to"?: (string | null);
|
|
518
|
+
"sort"?: (string | null);
|
|
519
|
+
"page"?: number;
|
|
520
|
+
"page_size"?: number;
|
|
521
|
+
}): Promise<T.ModelPeriodPage>;
|
|
522
|
+
/** GET /v1/modeling/companies/{company_id}/ratios - Modeling ratios */
|
|
523
|
+
getModelingRatios(company_id: string, query: {
|
|
524
|
+
"as_of": string;
|
|
525
|
+
"statement_type"?: (T.StatementType | null);
|
|
526
|
+
"from"?: (string | null);
|
|
527
|
+
"to"?: (string | null);
|
|
528
|
+
"sort"?: (string | null);
|
|
529
|
+
"page"?: number;
|
|
530
|
+
"page_size"?: number;
|
|
531
|
+
}): Promise<T.ModelRatiosPage>;
|
|
532
|
+
/** GET /v1/modeling/companies/{company_id}/ttm - Modeling TTM */
|
|
533
|
+
getModelingTtm(company_id: string, query: {
|
|
534
|
+
"as_of": string;
|
|
535
|
+
"statement_type"?: (T.StatementType | null);
|
|
536
|
+
"from"?: (string | null);
|
|
537
|
+
"to"?: (string | null);
|
|
538
|
+
"sort"?: (string | null);
|
|
539
|
+
"page"?: number;
|
|
540
|
+
"page_size"?: number;
|
|
541
|
+
}): Promise<T.ModelTTMPage>;
|
|
542
|
+
/** POST /v1/modeling/universe/pit-snapshot - Universe point-in-time snapshot */
|
|
543
|
+
getUniversePitSnapshot(body: T.UniversePITSnapshotRequestHTTP, query?: {
|
|
544
|
+
"page"?: number;
|
|
545
|
+
"page_size"?: number;
|
|
546
|
+
}): Promise<T.UniversePITSnapshotMetricPage>;
|
|
547
|
+
/** POST /v1/modeling/universe/screen - Screen every reporting company point in time */
|
|
548
|
+
screenUniverse(body: T.UniverseScreenRequestHTTP, query?: {
|
|
549
|
+
"page"?: number;
|
|
550
|
+
"page_size"?: number;
|
|
551
|
+
}): Promise<T.UniverseScreenPageEnvelope>;
|
|
552
|
+
/** POST /v1/query/execute - Execute a deterministic public query */
|
|
553
|
+
executeQuery(body: T.QueryExecuteRequestHTTP): Promise<T.QueryExecuteResponseEnvelope>;
|
|
554
|
+
/** GET /v1/query/replay/{replay_token} - Replay a query from its replay token */
|
|
555
|
+
replayQuery(replay_token: string): Promise<T.QueryReplayResponseEnvelope>;
|
|
556
|
+
/** GET /v1/query/verify-snapshot/{snapshot_hash} - Verify a point-in-time snapshot hash */
|
|
557
|
+
verifySnapshot(snapshot_hash: string): Promise<T.SnapshotVerificationEnvelope>;
|
|
558
|
+
/** GET /v1/query/verify/{replay_token} - Verify a replay token */
|
|
559
|
+
verifyQuery(replay_token: string): Promise<T.QueryVerificationEnvelope>;
|
|
560
|
+
/** GET /v1/system/ingestion/status - Get EDGAR feed freshness. */
|
|
561
|
+
getIngestionStatus(): Promise<T.IngestionStatusEnvelope>;
|
|
562
|
+
/** GET /v1/system/metadata - Get system metadata. */
|
|
563
|
+
getSystemMetadata(): Promise<T.SystemMetadataEnvelope>;
|
|
564
|
+
/** GET /v1/views/metrics - List registered metric views (bundles) */
|
|
565
|
+
listMetricViews(): Promise<T.MetricViewsCatalogEnvelope>;
|
|
566
|
+
/** GET /v1/views/metrics/{bundle_code} - Get derived metrics time series for a metric view */
|
|
567
|
+
getMetricViewTimeSeries(bundle_code: string, query: {
|
|
568
|
+
"ciks"?: (Array<string> | null);
|
|
569
|
+
"tickers"?: (Array<string> | null);
|
|
570
|
+
"statement_type": string;
|
|
571
|
+
"metrics"?: (Array<T.DerivedMetric> | null);
|
|
572
|
+
"frequency"?: string;
|
|
573
|
+
"from_date"?: (string | null);
|
|
574
|
+
"to_date"?: (string | null);
|
|
575
|
+
}): Promise<T.EdgarDerivedMetricsTimeSeriesEnvelope>;
|
|
576
|
+
}
|