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,368 @@
|
|
|
1
|
+
// Generated by scripts/generate_typescript_sdk.py from openapi.json. Do not edit.
|
|
2
|
+
/** One method per public Arche API operation. */
|
|
3
|
+
export class Operations {
|
|
4
|
+
/** GET /v1/account/webhook-subscriptions - List account webhook subscriptions */
|
|
5
|
+
listWebhookSubscriptions() {
|
|
6
|
+
return this.transport.request('GET', `/v1/account/webhook-subscriptions`);
|
|
7
|
+
}
|
|
8
|
+
/** POST /v1/account/webhook-subscriptions - Create account webhook subscription */
|
|
9
|
+
createWebhookSubscription(body) {
|
|
10
|
+
return this.transport.request('POST', `/v1/account/webhook-subscriptions`, { body });
|
|
11
|
+
}
|
|
12
|
+
/** DELETE /v1/account/webhook-subscriptions/{subscription_id} - Delete account webhook subscription */
|
|
13
|
+
deleteWebhookSubscription(subscription_id) {
|
|
14
|
+
return this.transport.request('DELETE', `/v1/account/webhook-subscriptions/${encodeURIComponent(subscription_id)}`);
|
|
15
|
+
}
|
|
16
|
+
/** POST /v1/account/webhook-subscriptions/{subscription_id}/rotate-secret - Rotate a webhook subscription's signing secret */
|
|
17
|
+
rotateWebhookSecret(subscription_id) {
|
|
18
|
+
return this.transport.request('POST', `/v1/account/webhook-subscriptions/${encodeURIComponent(subscription_id)}/rotate-secret`);
|
|
19
|
+
}
|
|
20
|
+
/** POST /v1/agent/checkout-link - Get a payment link for the account's owner */
|
|
21
|
+
createAgentCheckoutLink(body) {
|
|
22
|
+
return this.transport.request('POST', `/v1/agent/checkout-link`, { body });
|
|
23
|
+
}
|
|
24
|
+
/** POST /v1/agent/claim - Claim the account an agent opened */
|
|
25
|
+
claimAgentAccount(body) {
|
|
26
|
+
return this.transport.request('POST', `/v1/agent/claim`, { body });
|
|
27
|
+
}
|
|
28
|
+
/** POST /v1/agent/signup - Open a Free account for an agent's owner */
|
|
29
|
+
agentSignup(body) {
|
|
30
|
+
return this.transport.request('POST', `/v1/agent/signup`, { body });
|
|
31
|
+
}
|
|
32
|
+
/** GET /v1/ai/companies/{company_id}/anomaly-explanations - Anomaly explanations */
|
|
33
|
+
listAnomalyExplanations(company_id, query) {
|
|
34
|
+
return this.transport.request('GET', `/v1/ai/companies/${encodeURIComponent(company_id)}/anomaly-explanations`, { query });
|
|
35
|
+
}
|
|
36
|
+
/** GET /v1/ai/companies/{company_id}/embeddings/metadata - Embedding metadata (experimental) */
|
|
37
|
+
listEmbeddingMetadata(company_id, query) {
|
|
38
|
+
return this.transport.request('GET', `/v1/ai/companies/${encodeURIComponent(company_id)}/embeddings/metadata`, { query });
|
|
39
|
+
}
|
|
40
|
+
/** GET /v1/ai/companies/{company_id}/narratives - Financial narratives */
|
|
41
|
+
listNarratives(company_id, query) {
|
|
42
|
+
return this.transport.request('GET', `/v1/ai/companies/${encodeURIComponent(company_id)}/narratives`, { query });
|
|
43
|
+
}
|
|
44
|
+
/** GET /v1/ai/companies/{company_id}/peers - Peer similarity (experimental) */
|
|
45
|
+
listPeerSets(company_id, query) {
|
|
46
|
+
return this.transport.request('GET', `/v1/ai/companies/${encodeURIComponent(company_id)}/peers`, { query });
|
|
47
|
+
}
|
|
48
|
+
/** GET /v1/analysis/metric-drift - Metric drift analytics */
|
|
49
|
+
getMetricDrift(query) {
|
|
50
|
+
return this.transport.request('GET', `/v1/analysis/metric-drift`, { query });
|
|
51
|
+
}
|
|
52
|
+
/** GET /v1/analysis/model-impact - Model impact of restatements */
|
|
53
|
+
getModelImpact(query) {
|
|
54
|
+
return this.transport.request('GET', `/v1/analysis/model-impact`, { query });
|
|
55
|
+
}
|
|
56
|
+
/** GET /v1/analysis/version-delta - First-filed versus latest-filed metric delta */
|
|
57
|
+
getVersionDelta(query) {
|
|
58
|
+
return this.transport.request('GET', `/v1/analysis/version-delta`, { query });
|
|
59
|
+
}
|
|
60
|
+
/** GET /v1/bulk/datasets - List the bulk export dataset contract */
|
|
61
|
+
listBulkDatasets() {
|
|
62
|
+
return this.transport.request('GET', `/v1/bulk/datasets`);
|
|
63
|
+
}
|
|
64
|
+
/** GET /v1/bulk/license - Read the bulk-data license and whether it is accepted */
|
|
65
|
+
getBulkLicense() {
|
|
66
|
+
return this.transport.request('GET', `/v1/bulk/license`);
|
|
67
|
+
}
|
|
68
|
+
/** POST /v1/bulk/license/acceptance - Accept the bulk-data license for the organization */
|
|
69
|
+
acceptBulkLicense(body) {
|
|
70
|
+
return this.transport.request('POST', `/v1/bulk/license/acceptance`, { body });
|
|
71
|
+
}
|
|
72
|
+
/** GET /v1/bulk/snapshots - List published bulk export snapshots */
|
|
73
|
+
listBulkSnapshots(query) {
|
|
74
|
+
return this.transport.request('GET', `/v1/bulk/snapshots`, { query });
|
|
75
|
+
}
|
|
76
|
+
/** GET /v1/bulk/snapshots/{snapshot_id} - Read one bulk export snapshot's manifest */
|
|
77
|
+
getBulkSnapshot(snapshot_id) {
|
|
78
|
+
return this.transport.request('GET', `/v1/bulk/snapshots/${encodeURIComponent(snapshot_id)}`);
|
|
79
|
+
}
|
|
80
|
+
/** GET /v1/bulk/snapshots/{snapshot_id}/files/{file_path} - Issue a download URL for one snapshot file */
|
|
81
|
+
getBulkSnapshotFileUrl(snapshot_id, file_path) {
|
|
82
|
+
return this.transport.request('GET', `/v1/bulk/snapshots/${encodeURIComponent(snapshot_id)}/files/${encodeURIComponent(file_path)}`);
|
|
83
|
+
}
|
|
84
|
+
/** GET /v1/coverage/companies - List company coverage summaries */
|
|
85
|
+
listCompanyCoverage(query) {
|
|
86
|
+
return this.transport.request('GET', `/v1/coverage/companies`, { query });
|
|
87
|
+
}
|
|
88
|
+
/** GET /v1/coverage/companies/{cik} - Get company coverage summary */
|
|
89
|
+
getCompanyCoverage(cik) {
|
|
90
|
+
return this.transport.request('GET', `/v1/coverage/companies/${encodeURIComponent(cik)}`);
|
|
91
|
+
}
|
|
92
|
+
/** GET /v1/coverage/metrics - List metric coverage summaries */
|
|
93
|
+
listMetricCoverage(query) {
|
|
94
|
+
return this.transport.request('GET', `/v1/coverage/metrics`, { query });
|
|
95
|
+
}
|
|
96
|
+
/** GET /v1/coverage/metrics/{metric} - Get metric coverage summary */
|
|
97
|
+
getMetricCoverage(metric) {
|
|
98
|
+
return this.transport.request('GET', `/v1/coverage/metrics/${encodeURIComponent(metric)}`);
|
|
99
|
+
}
|
|
100
|
+
/** GET /v1/coverage/selection - Show the companies this plan covers */
|
|
101
|
+
getCoverageSelection() {
|
|
102
|
+
return this.transport.request('GET', `/v1/coverage/selection`);
|
|
103
|
+
}
|
|
104
|
+
/** POST /v1/coverage/selection/release - Release one company's coverage slot */
|
|
105
|
+
releaseCoverageSlot(body) {
|
|
106
|
+
return this.transport.request('POST', `/v1/coverage/selection/release`, { body });
|
|
107
|
+
}
|
|
108
|
+
/** GET /v1/data-quality/issues - List public data-quality issues */
|
|
109
|
+
listDataQualityIssues(query) {
|
|
110
|
+
return this.transport.request('GET', `/v1/data-quality/issues`, { query });
|
|
111
|
+
}
|
|
112
|
+
/** GET /v1/edgar/as-of/{date}/financials/{cik} - Get EDGAR financials as-of a date or time */
|
|
113
|
+
getAsOfFinancials(cik, date, query) {
|
|
114
|
+
return this.transport.request('GET', `/v1/edgar/as-of/${encodeURIComponent(date)}/financials/${encodeURIComponent(cik)}`, { query });
|
|
115
|
+
}
|
|
116
|
+
/** GET /v1/edgar/as-of/{date}/financials/{cik}/page - Get one page of EDGAR financials as-of a date or time */
|
|
117
|
+
getAsOfFinancialsPage(cik, date, query) {
|
|
118
|
+
return this.transport.request('GET', `/v1/edgar/as-of/${encodeURIComponent(date)}/financials/${encodeURIComponent(cik)}/page`, { query });
|
|
119
|
+
}
|
|
120
|
+
/** GET /v1/edgar/companies/{cik} - Get canonical EDGAR company profile */
|
|
121
|
+
getCompany(cik) {
|
|
122
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}`);
|
|
123
|
+
}
|
|
124
|
+
/** GET /v1/edgar/companies/{cik}/completeness - Get EDGAR completeness summary for a company */
|
|
125
|
+
getCompanyCompleteness(cik) {
|
|
126
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/completeness`);
|
|
127
|
+
}
|
|
128
|
+
/** GET /v1/edgar/companies/{cik}/disclosures - List a company's narrative disclosures */
|
|
129
|
+
listDisclosures(cik, query) {
|
|
130
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/disclosures`, { query });
|
|
131
|
+
}
|
|
132
|
+
/** GET /v1/edgar/companies/{cik}/facts - List the values a company reported in XBRL */
|
|
133
|
+
listAsReportedFacts(cik, query) {
|
|
134
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/facts`, { query });
|
|
135
|
+
}
|
|
136
|
+
/** GET /v1/edgar/companies/{cik}/facts/concepts - List every XBRL concept a company reported */
|
|
137
|
+
listAsReportedConcepts(cik, query) {
|
|
138
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/facts/concepts`, { query });
|
|
139
|
+
}
|
|
140
|
+
/** GET /v1/edgar/companies/{cik}/filings - List EDGAR filings for a company */
|
|
141
|
+
listFilings(cik, query) {
|
|
142
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings`, { query });
|
|
143
|
+
}
|
|
144
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id} - Get EDGAR filing detail */
|
|
145
|
+
getFiling(cik, accession_id, query) {
|
|
146
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}`, { query });
|
|
147
|
+
}
|
|
148
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/earnings-release - Get an 8-K's earnings release as filed */
|
|
149
|
+
getFilingEarningsRelease(cik, accession_id) {
|
|
150
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}/earnings-release`);
|
|
151
|
+
}
|
|
152
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/facts - List every numeric fact in a filing's XBRL */
|
|
153
|
+
listFilingFacts(cik, accession_id, query) {
|
|
154
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}/facts`, { query });
|
|
155
|
+
}
|
|
156
|
+
/** GET /v1/edgar/companies/{cik}/filings/{accession_id}/statements - Get the statements a filing reported */
|
|
157
|
+
listFilingStatements(cik, accession_id, query) {
|
|
158
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}/statements`, { query });
|
|
159
|
+
}
|
|
160
|
+
/** 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 */
|
|
161
|
+
listFactRevisions(cik, accession_id, statement_type, fiscal_year, fiscal_period, query) {
|
|
162
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}/statements/${encodeURIComponent(statement_type)}/${encodeURIComponent(fiscal_year)}/${encodeURIComponent(fiscal_period)}/fact-revisions`, { query });
|
|
163
|
+
}
|
|
164
|
+
/** 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 */
|
|
165
|
+
getMetricAuditChain(cik, accession_id, statement_type, fiscal_year, fiscal_period, metric_name, query) {
|
|
166
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}/statements/${encodeURIComponent(statement_type)}/${encodeURIComponent(fiscal_year)}/${encodeURIComponent(fiscal_period)}/metrics/${encodeURIComponent(metric_name)}/audit-chain`, { query });
|
|
167
|
+
}
|
|
168
|
+
/** 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 */
|
|
169
|
+
getMetricProvenance(cik, accession_id, statement_type, fiscal_year, fiscal_period, metric_name, query) {
|
|
170
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/filings/${encodeURIComponent(accession_id)}/statements/${encodeURIComponent(statement_type)}/${encodeURIComponent(fiscal_year)}/${encodeURIComponent(fiscal_period)}/metrics/${encodeURIComponent(metric_name)}/provenance`, { query });
|
|
171
|
+
}
|
|
172
|
+
/** GET /v1/edgar/companies/{cik}/financial-state/time-series - Get aligned financial-state time series */
|
|
173
|
+
getFinancialStateTimeSeries(cik, query) {
|
|
174
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/financial-state/time-series`, { query });
|
|
175
|
+
}
|
|
176
|
+
/** GET /v1/edgar/companies/{cik}/metric-bundles/{bundle_code}/time-series - Get filing-based metric bundle time series */
|
|
177
|
+
getMetricBundleTimeSeries(cik, bundle_code, query) {
|
|
178
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/metric-bundles/${encodeURIComponent(bundle_code)}/time-series`, { query });
|
|
179
|
+
}
|
|
180
|
+
/** GET /v1/edgar/companies/{cik}/metrics/{metric}/time-series - Get normalized metric time series */
|
|
181
|
+
getMetricTimeSeries(cik, metric, query) {
|
|
182
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/metrics/${encodeURIComponent(metric)}/time-series`, { query });
|
|
183
|
+
}
|
|
184
|
+
/** GET /v1/edgar/companies/{cik}/statements - List EDGAR statements for a company */
|
|
185
|
+
listStatements(cik, query) {
|
|
186
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/statements`, { query });
|
|
187
|
+
}
|
|
188
|
+
/** GET /v1/edgar/companies/{cik}/statements/dq/overlay - Get a normalized statement with DQ overlay */
|
|
189
|
+
getStatementDqOverlay(cik, query) {
|
|
190
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/statements/dq/overlay`, { query });
|
|
191
|
+
}
|
|
192
|
+
/** GET /v1/edgar/companies/{cik}/statements/overrides/trace - Inspect XBRL mapping overrides for a statement identity */
|
|
193
|
+
getStatementOverrideTrace(cik, query) {
|
|
194
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/statements/overrides/trace`, { query });
|
|
195
|
+
}
|
|
196
|
+
/** GET /v1/edgar/companies/{cik}/statements/restatement-timeline - Get restatement metric timeline for a statement identity */
|
|
197
|
+
getRestatementTimeline(cik, query) {
|
|
198
|
+
return this.transport.request('GET', `/v1/edgar/companies/${encodeURIComponent(cik)}/statements/restatement-timeline`, { query });
|
|
199
|
+
}
|
|
200
|
+
/** GET /v1/edgar/companies:resolve - Resolve canonical CIK by ticker */
|
|
201
|
+
resolveCompany(query) {
|
|
202
|
+
return this.transport.request('GET', `/v1/edgar/companies:resolve`, { query });
|
|
203
|
+
}
|
|
204
|
+
/** GET /v1/edgar/derived-metrics/catalog - List derived metrics catalog */
|
|
205
|
+
listDerivedMetrics() {
|
|
206
|
+
return this.transport.request('GET', `/v1/edgar/derived-metrics/catalog`);
|
|
207
|
+
}
|
|
208
|
+
/** GET /v1/edgar/derived-metrics/time-series - Get derived metrics time series */
|
|
209
|
+
getDerivedMetricsTimeSeries(query) {
|
|
210
|
+
return this.transport.request('GET', `/v1/edgar/derived-metrics/time-series`, { query });
|
|
211
|
+
}
|
|
212
|
+
/** GET /v1/edgar/disclosures/{disclosure_id} - Read one narrative disclosure */
|
|
213
|
+
getDisclosure(disclosure_id) {
|
|
214
|
+
return this.transport.request('GET', `/v1/edgar/disclosures/${encodeURIComponent(disclosure_id)}`);
|
|
215
|
+
}
|
|
216
|
+
/** GET /v1/edgar/metric-bundles - List filing-based metric bundles */
|
|
217
|
+
listMetricBundles() {
|
|
218
|
+
return this.transport.request('GET', `/v1/edgar/metric-bundles`);
|
|
219
|
+
}
|
|
220
|
+
/** GET /v1/edgar/reconciliation/ledger - Get reconciliation ledger for a statement identity */
|
|
221
|
+
getReconciliationLedger(query) {
|
|
222
|
+
return this.transport.request('GET', `/v1/edgar/reconciliation/ledger`, { query });
|
|
223
|
+
}
|
|
224
|
+
/** GET /v1/edgar/reconciliation/summary - Get reconciliation summary for a fiscal-year window */
|
|
225
|
+
getReconciliationSummary(query) {
|
|
226
|
+
return this.transport.request('GET', `/v1/edgar/reconciliation/summary`, { query });
|
|
227
|
+
}
|
|
228
|
+
/** GET /v1/edgar/restatement-alerts - List restatement alert events */
|
|
229
|
+
listRestatementAlerts(query) {
|
|
230
|
+
return this.transport.request('GET', `/v1/edgar/restatement-alerts`, { query });
|
|
231
|
+
}
|
|
232
|
+
/** GET /v1/edgar/restatement-alerts/{restatement_alert_event_id} - Get one restatement alert event */
|
|
233
|
+
getRestatementAlert(restatement_alert_event_id) {
|
|
234
|
+
return this.transport.request('GET', `/v1/edgar/restatement-alerts/${encodeURIComponent(restatement_alert_event_id)}`);
|
|
235
|
+
}
|
|
236
|
+
/** GET /v1/edgar/statements/restatements/delta - Get restatement delta between two filings */
|
|
237
|
+
getRestatementDelta(query) {
|
|
238
|
+
return this.transport.request('GET', `/v1/edgar/statements/restatements/delta`, { query });
|
|
239
|
+
}
|
|
240
|
+
/** GET /v1/edgar/statements/restatements/ledger - Get restatement ledger for a statement identity */
|
|
241
|
+
getRestatementLedger(query) {
|
|
242
|
+
return this.transport.request('GET', `/v1/edgar/statements/restatements/ledger`, { query });
|
|
243
|
+
}
|
|
244
|
+
/** GET /v1/fundamentals/companies/{cik}/metrics/{metric}/time-series/real - Inflation-adjusted EDGAR metric time series */
|
|
245
|
+
getRealMetricTimeSeries(cik, metric, query) {
|
|
246
|
+
return this.transport.request('GET', `/v1/fundamentals/companies/${encodeURIComponent(cik)}/metrics/${encodeURIComponent(metric)}/time-series/real`, { query });
|
|
247
|
+
}
|
|
248
|
+
/** GET /v1/fundamentals/derived/time-series - Derived metrics time series */
|
|
249
|
+
getFundamentalsDerivedTimeSeries(query) {
|
|
250
|
+
return this.transport.request('GET', `/v1/fundamentals/derived/time-series`, { query });
|
|
251
|
+
}
|
|
252
|
+
/** GET /v1/fundamentals/macro/context/{target_date} - Macro context for a date */
|
|
253
|
+
getMacroContext(target_date, query) {
|
|
254
|
+
return this.transport.request('GET', `/v1/fundamentals/macro/context/${encodeURIComponent(target_date)}`, { query });
|
|
255
|
+
}
|
|
256
|
+
/** GET /v1/fundamentals/macro/series - Approved macro series registry */
|
|
257
|
+
listMacroSeries() {
|
|
258
|
+
return this.transport.request('GET', `/v1/fundamentals/macro/series`);
|
|
259
|
+
}
|
|
260
|
+
/** GET /v1/fundamentals/macro/series/{series_code} - Approved macro series observations */
|
|
261
|
+
getMacroSeries(series_code, query) {
|
|
262
|
+
return this.transport.request('GET', `/v1/fundamentals/macro/series/${encodeURIComponent(series_code)}`, { query });
|
|
263
|
+
}
|
|
264
|
+
/** GET /v1/fundamentals/normalized-statements - Normalized EDGAR statement as each filing reported it */
|
|
265
|
+
getNormalizedStatement(query) {
|
|
266
|
+
return this.transport.request('GET', `/v1/fundamentals/normalized-statements`, { query });
|
|
267
|
+
}
|
|
268
|
+
/** GET /v1/fundamentals/normalized-statements/dq-overlay - Normalized statement with data-quality overlay */
|
|
269
|
+
getNormalizedStatementDqOverlay(query) {
|
|
270
|
+
return this.transport.request('GET', `/v1/fundamentals/normalized-statements/dq-overlay`, { query });
|
|
271
|
+
}
|
|
272
|
+
/** GET /v1/fundamentals/restatement-delta - Restatement delta for a single statement */
|
|
273
|
+
getFundamentalsRestatementDelta(query) {
|
|
274
|
+
return this.transport.request('GET', `/v1/fundamentals/restatement-delta`, { query });
|
|
275
|
+
}
|
|
276
|
+
/** GET /v1/fundamentals/time-series - Fundamentals time series */
|
|
277
|
+
getFundamentalsTimeSeries(query) {
|
|
278
|
+
return this.transport.request('GET', `/v1/fundamentals/time-series`, { query });
|
|
279
|
+
}
|
|
280
|
+
/** GET /v1/identity/companies/{cik} - List company identity history by CIK */
|
|
281
|
+
listCompanyIdentityHistory(cik, query) {
|
|
282
|
+
return this.transport.request('GET', `/v1/identity/companies/${encodeURIComponent(cik)}`, { query });
|
|
283
|
+
}
|
|
284
|
+
/** GET /v1/identity/resolve - Resolve a ticker to one company as of a date */
|
|
285
|
+
resolveCompanyAsOf(query) {
|
|
286
|
+
return this.transport.request('GET', `/v1/identity/resolve`, { query });
|
|
287
|
+
}
|
|
288
|
+
/** GET /v1/identity/search - Search companies by ticker, CIK, or name */
|
|
289
|
+
searchCompanies(query) {
|
|
290
|
+
return this.transport.request('GET', `/v1/identity/search`, { query });
|
|
291
|
+
}
|
|
292
|
+
/** GET /v1/identity/tickers/{ticker} - List ticker identity history */
|
|
293
|
+
listTickerIdentityHistory(ticker, query) {
|
|
294
|
+
return this.transport.request('GET', `/v1/identity/tickers/${encodeURIComponent(ticker)}`, { query });
|
|
295
|
+
}
|
|
296
|
+
/** GET /v1/metrics/definitions - List metric definitions */
|
|
297
|
+
listMetricDefinitions() {
|
|
298
|
+
return this.transport.request('GET', `/v1/metrics/definitions`);
|
|
299
|
+
}
|
|
300
|
+
/** GET /v1/metrics/definitions/{metric} - Get one metric definition */
|
|
301
|
+
getMetricDefinition(metric) {
|
|
302
|
+
return this.transport.request('GET', `/v1/metrics/definitions/${encodeURIComponent(metric)}`);
|
|
303
|
+
}
|
|
304
|
+
/** GET /v1/metrics/segments - List segment/geography metric disclosures */
|
|
305
|
+
listSegmentMetrics(query) {
|
|
306
|
+
return this.transport.request('GET', `/v1/metrics/segments`, { query });
|
|
307
|
+
}
|
|
308
|
+
/** GET /v1/modeling/companies/{company_id}/growth - Modeling growth */
|
|
309
|
+
getModelingGrowth(company_id, query) {
|
|
310
|
+
return this.transport.request('GET', `/v1/modeling/companies/${encodeURIComponent(company_id)}/growth`, { query });
|
|
311
|
+
}
|
|
312
|
+
/** GET /v1/modeling/companies/{company_id}/multi-year - Modeling multi-year inputs */
|
|
313
|
+
getModelingMultiYearInputs(company_id, query) {
|
|
314
|
+
return this.transport.request('GET', `/v1/modeling/companies/${encodeURIComponent(company_id)}/multi-year`, { query });
|
|
315
|
+
}
|
|
316
|
+
/** GET /v1/modeling/companies/{company_id}/periods - Modeling periods */
|
|
317
|
+
getModelingPeriods(company_id, query) {
|
|
318
|
+
return this.transport.request('GET', `/v1/modeling/companies/${encodeURIComponent(company_id)}/periods`, { query });
|
|
319
|
+
}
|
|
320
|
+
/** GET /v1/modeling/companies/{company_id}/ratios - Modeling ratios */
|
|
321
|
+
getModelingRatios(company_id, query) {
|
|
322
|
+
return this.transport.request('GET', `/v1/modeling/companies/${encodeURIComponent(company_id)}/ratios`, { query });
|
|
323
|
+
}
|
|
324
|
+
/** GET /v1/modeling/companies/{company_id}/ttm - Modeling TTM */
|
|
325
|
+
getModelingTtm(company_id, query) {
|
|
326
|
+
return this.transport.request('GET', `/v1/modeling/companies/${encodeURIComponent(company_id)}/ttm`, { query });
|
|
327
|
+
}
|
|
328
|
+
/** POST /v1/modeling/universe/pit-snapshot - Universe point-in-time snapshot */
|
|
329
|
+
getUniversePitSnapshot(body, query) {
|
|
330
|
+
return this.transport.request('POST', `/v1/modeling/universe/pit-snapshot`, { query, body });
|
|
331
|
+
}
|
|
332
|
+
/** POST /v1/modeling/universe/screen - Screen every reporting company point in time */
|
|
333
|
+
screenUniverse(body, query) {
|
|
334
|
+
return this.transport.request('POST', `/v1/modeling/universe/screen`, { query, body });
|
|
335
|
+
}
|
|
336
|
+
/** POST /v1/query/execute - Execute a deterministic public query */
|
|
337
|
+
executeQuery(body) {
|
|
338
|
+
return this.transport.request('POST', `/v1/query/execute`, { body });
|
|
339
|
+
}
|
|
340
|
+
/** GET /v1/query/replay/{replay_token} - Replay a query from its replay token */
|
|
341
|
+
replayQuery(replay_token) {
|
|
342
|
+
return this.transport.request('GET', `/v1/query/replay/${encodeURIComponent(replay_token)}`);
|
|
343
|
+
}
|
|
344
|
+
/** GET /v1/query/verify-snapshot/{snapshot_hash} - Verify a point-in-time snapshot hash */
|
|
345
|
+
verifySnapshot(snapshot_hash) {
|
|
346
|
+
return this.transport.request('GET', `/v1/query/verify-snapshot/${encodeURIComponent(snapshot_hash)}`);
|
|
347
|
+
}
|
|
348
|
+
/** GET /v1/query/verify/{replay_token} - Verify a replay token */
|
|
349
|
+
verifyQuery(replay_token) {
|
|
350
|
+
return this.transport.request('GET', `/v1/query/verify/${encodeURIComponent(replay_token)}`);
|
|
351
|
+
}
|
|
352
|
+
/** GET /v1/system/ingestion/status - Get EDGAR feed freshness. */
|
|
353
|
+
getIngestionStatus() {
|
|
354
|
+
return this.transport.request('GET', `/v1/system/ingestion/status`);
|
|
355
|
+
}
|
|
356
|
+
/** GET /v1/system/metadata - Get system metadata. */
|
|
357
|
+
getSystemMetadata() {
|
|
358
|
+
return this.transport.request('GET', `/v1/system/metadata`);
|
|
359
|
+
}
|
|
360
|
+
/** GET /v1/views/metrics - List registered metric views (bundles) */
|
|
361
|
+
listMetricViews() {
|
|
362
|
+
return this.transport.request('GET', `/v1/views/metrics`);
|
|
363
|
+
}
|
|
364
|
+
/** GET /v1/views/metrics/{bundle_code} - Get derived metrics time series for a metric view */
|
|
365
|
+
getMetricViewTimeSeries(bundle_code, query) {
|
|
366
|
+
return this.transport.request('GET', `/v1/views/metrics/${encodeURIComponent(bundle_code)}`, { query });
|
|
367
|
+
}
|
|
368
|
+
}
|