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,2158 @@
|
|
|
1
|
+
/** Accounting standards used in EDGAR filings. */
|
|
2
|
+
export type AccountingStandard = "US_GAAP" | "IFRS" | "OTHER";
|
|
3
|
+
export type AgentCheckoutLinkEnvelope = {
|
|
4
|
+
"data": AgentCheckoutLinkHTTP;
|
|
5
|
+
};
|
|
6
|
+
/** HTTP schema for a payment link the agent hands its owner. */
|
|
7
|
+
export type AgentCheckoutLinkHTTP = {
|
|
8
|
+
"checkout_url": string;
|
|
9
|
+
"plan": string;
|
|
10
|
+
"interval": string;
|
|
11
|
+
"amount": string;
|
|
12
|
+
"currency": string;
|
|
13
|
+
};
|
|
14
|
+
/** HTTP schema for requesting a payment link for the owner. */
|
|
15
|
+
export type AgentCheckoutLinkRequestHTTP = {
|
|
16
|
+
"plan"?: "developer" | "growth" | "scale";
|
|
17
|
+
"interval"?: "month" | "year";
|
|
18
|
+
};
|
|
19
|
+
export type AgentClaimEnvelope = {
|
|
20
|
+
"data": AgentClaimHTTP;
|
|
21
|
+
};
|
|
22
|
+
/** HTTP schema for an account an owner claimed. */
|
|
23
|
+
export type AgentClaimHTTP = {
|
|
24
|
+
"org_id": string;
|
|
25
|
+
"claimed": boolean;
|
|
26
|
+
};
|
|
27
|
+
/** HTTP schema for an owner claiming the account an agent opened. */
|
|
28
|
+
export type AgentClaimRequestHTTP = {
|
|
29
|
+
"claim_token": string;
|
|
30
|
+
};
|
|
31
|
+
export type AgentSignupEnvelope = {
|
|
32
|
+
"data": AgentSignupHTTP;
|
|
33
|
+
};
|
|
34
|
+
/** HTTP schema for the key issued to an agent. */
|
|
35
|
+
export type AgentSignupHTTP = {
|
|
36
|
+
"api_key": string;
|
|
37
|
+
"plan": "free";
|
|
38
|
+
"owner_email": string;
|
|
39
|
+
"owner_notified": boolean;
|
|
40
|
+
"expires_at": string;
|
|
41
|
+
"claim_url": string;
|
|
42
|
+
"checkout_link_endpoint": string;
|
|
43
|
+
};
|
|
44
|
+
/** HTTP schema for an agent opening a Free account for its owner. */
|
|
45
|
+
export type AgentSignupRequestHTTP = {
|
|
46
|
+
"email": string;
|
|
47
|
+
"agent_name": string;
|
|
48
|
+
};
|
|
49
|
+
/** HTTP schema for an anomaly explanation. */
|
|
50
|
+
export type AnomalyExplanationHTTP = {
|
|
51
|
+
"company_id": string;
|
|
52
|
+
"cik": string;
|
|
53
|
+
"as_of_timestamp": string;
|
|
54
|
+
"statement_type"?: (StatementType | null);
|
|
55
|
+
"fiscal_year"?: (number | null);
|
|
56
|
+
"fiscal_period"?: (FiscalPeriod | null);
|
|
57
|
+
"metric_code"?: (string | null);
|
|
58
|
+
"dimension_key"?: (string | null);
|
|
59
|
+
"severity": MaterialityClass;
|
|
60
|
+
"reason_codes": Array<string>;
|
|
61
|
+
"rationale": string;
|
|
62
|
+
"impacted_metrics": Array<AnomalyImpactHTTP>;
|
|
63
|
+
"historical_baseline"?: (Record<string, unknown> | null);
|
|
64
|
+
"peer_baseline"?: (Record<string, unknown> | null);
|
|
65
|
+
"created_at": string;
|
|
66
|
+
};
|
|
67
|
+
export type AnomalyExplanationPage = {
|
|
68
|
+
"page": number;
|
|
69
|
+
"page_size": number;
|
|
70
|
+
"total": number;
|
|
71
|
+
"items": Array<AnomalyExplanationHTTP>;
|
|
72
|
+
};
|
|
73
|
+
/** HTTP schema for impacted metrics in anomaly explanations. */
|
|
74
|
+
export type AnomalyImpactHTTP = {
|
|
75
|
+
"metric_code": string;
|
|
76
|
+
"dimension_key"?: (string | null);
|
|
77
|
+
};
|
|
78
|
+
/** Data-quality findings summed over every statement in the snapshot. */
|
|
79
|
+
export type AsOfDataQualityHTTP = {
|
|
80
|
+
"evaluated_rule_count": number;
|
|
81
|
+
"passed_rule_count": number;
|
|
82
|
+
"total_rule_count": number;
|
|
83
|
+
"not_evaluated_metric_count": number;
|
|
84
|
+
"pass_rate": (string | null);
|
|
85
|
+
};
|
|
86
|
+
/** As-of metadata container. */
|
|
87
|
+
export type AsOfMetaHTTP = {
|
|
88
|
+
"reconciliation": ReconciliationMetaHTTP;
|
|
89
|
+
"data_quality": AsOfDataQualityHTTP;
|
|
90
|
+
"availability"?: (EndpointAvailabilityHTTP | null);
|
|
91
|
+
};
|
|
92
|
+
/** One fact of a statement on an as-of page. */
|
|
93
|
+
export type AsOfPageFactHTTP = {
|
|
94
|
+
"metric": string;
|
|
95
|
+
"unit": string;
|
|
96
|
+
"value": string;
|
|
97
|
+
"period_start": string;
|
|
98
|
+
"period_end": string;
|
|
99
|
+
"source_line_item"?: (string | null);
|
|
100
|
+
"value_origin": string;
|
|
101
|
+
"period_origin": string;
|
|
102
|
+
"correction_rule"?: (string | null);
|
|
103
|
+
"as_filed_value"?: (string | null);
|
|
104
|
+
"as_filed_concept"?: (string | null);
|
|
105
|
+
"split_adjusted_value"?: (string | null);
|
|
106
|
+
"split_adjustment_factor"?: (string | null);
|
|
107
|
+
"dimension"?: (Record<string, string> | null);
|
|
108
|
+
"dimension_key"?: (string | null);
|
|
109
|
+
"usd"?: (UsdValueHTTP | null);
|
|
110
|
+
};
|
|
111
|
+
/** Where one metric of a statement on an as-of page came from. */
|
|
112
|
+
export type AsOfPageMetricProvenanceHTTP = {
|
|
113
|
+
"xbrl_concept"?: (string | null);
|
|
114
|
+
"mapping_type"?: ("DIRECT" | "FALLBACK" | "CALCULATED" | "INFERRED" | "UNKNOWN" | null);
|
|
115
|
+
"filing_accession"?: (string | null);
|
|
116
|
+
"override_applied"?: boolean;
|
|
117
|
+
"override_reason"?: (string | null);
|
|
118
|
+
};
|
|
119
|
+
/** The facts of a statement on an as-of page, with their provenance. */
|
|
120
|
+
export type AsOfPageNormalizedStatementHTTP = {
|
|
121
|
+
"_meta"?: (AsOfPageStatementMetaHTTP | null);
|
|
122
|
+
"facts"?: Array<AsOfPageFactHTTP>;
|
|
123
|
+
};
|
|
124
|
+
/** One statement on an as-of page: its identity, its filing and its figures. */
|
|
125
|
+
export type AsOfPageStatementHTTP = {
|
|
126
|
+
"accession_id": string;
|
|
127
|
+
"cik": string;
|
|
128
|
+
"company_name"?: (string | null);
|
|
129
|
+
"statement_type": StatementType;
|
|
130
|
+
"accounting_standard": AccountingStandard;
|
|
131
|
+
"statement_date": string;
|
|
132
|
+
"fiscal_year": number;
|
|
133
|
+
"fiscal_period": FiscalPeriod;
|
|
134
|
+
"period_start"?: (string | null);
|
|
135
|
+
"reporting_entity"?: "REGISTRANT" | "PREDECESSOR";
|
|
136
|
+
"currency": string;
|
|
137
|
+
"filing_type": string;
|
|
138
|
+
"filing_date": string;
|
|
139
|
+
"accepted_at"?: (string | null);
|
|
140
|
+
"is_amendment": boolean;
|
|
141
|
+
"amendment_sequence"?: (number | null);
|
|
142
|
+
"is_restated": boolean;
|
|
143
|
+
"restated_by_accession_id"?: (string | null);
|
|
144
|
+
"values"?: Record<string, string>;
|
|
145
|
+
"units"?: Record<string, string>;
|
|
146
|
+
"usd"?: (StatementUsdHTTP | null);
|
|
147
|
+
"content"?: (AsOfPageNormalizedStatementHTTP | null);
|
|
148
|
+
"quality"?: (StatementQualityHTTP | null);
|
|
149
|
+
};
|
|
150
|
+
/** Per-metric metadata of a statement on an as-of page. */
|
|
151
|
+
export type AsOfPageStatementMetaHTTP = {
|
|
152
|
+
"provenance"?: (Record<string, AsOfPageMetricProvenanceHTTP> | null);
|
|
153
|
+
"withheld_metrics"?: (Record<string, WithheldMetricHTTP> | null);
|
|
154
|
+
};
|
|
155
|
+
/** One XBRL concept a company reported, with what it reported under it. */
|
|
156
|
+
export type AsReportedConceptHTTP = {
|
|
157
|
+
"concept": string;
|
|
158
|
+
"taxonomy": string;
|
|
159
|
+
"label"?: (string | null);
|
|
160
|
+
"description"?: (string | null);
|
|
161
|
+
"units": Array<string>;
|
|
162
|
+
"fact_count": number;
|
|
163
|
+
"first_period_end": string;
|
|
164
|
+
"last_period_end": string;
|
|
165
|
+
};
|
|
166
|
+
export type AsReportedConceptPage = {
|
|
167
|
+
"page": number;
|
|
168
|
+
"page_size": number;
|
|
169
|
+
"total": number;
|
|
170
|
+
"items": Array<AsReportedConceptHTTP>;
|
|
171
|
+
};
|
|
172
|
+
/** One value a filing reported for one XBRL concept, unit and period. */
|
|
173
|
+
export type AsReportedFactHTTP = {
|
|
174
|
+
"concept": string;
|
|
175
|
+
"unit": string;
|
|
176
|
+
"value": string;
|
|
177
|
+
"period_start"?: (string | null);
|
|
178
|
+
"period_end": string;
|
|
179
|
+
"accession_id": string;
|
|
180
|
+
"filing_type": string;
|
|
181
|
+
"filing_date": string;
|
|
182
|
+
"fiscal_year"?: (number | null);
|
|
183
|
+
"fiscal_period"?: (string | null);
|
|
184
|
+
"frame"?: (string | null);
|
|
185
|
+
};
|
|
186
|
+
export type AsReportedFactPage = {
|
|
187
|
+
"page": number;
|
|
188
|
+
"page_size": number;
|
|
189
|
+
"total": number;
|
|
190
|
+
"items": Array<AsReportedFactHTTP>;
|
|
191
|
+
};
|
|
192
|
+
/** One column of an exported dataset. */
|
|
193
|
+
export type BulkColumnHTTP = {
|
|
194
|
+
"name": string;
|
|
195
|
+
"type": string;
|
|
196
|
+
"nullable": boolean;
|
|
197
|
+
"description": string;
|
|
198
|
+
};
|
|
199
|
+
/** One exported dataset's contract. */
|
|
200
|
+
export type BulkDatasetHTTP = {
|
|
201
|
+
"dataset": string;
|
|
202
|
+
"description": string;
|
|
203
|
+
"key": Array<string>;
|
|
204
|
+
"partition_column"?: (string | null);
|
|
205
|
+
"columns": Array<BulkColumnHTTP>;
|
|
206
|
+
"statement_types"?: (Array<string> | null);
|
|
207
|
+
};
|
|
208
|
+
export type BulkDatasetListEnvelope = {
|
|
209
|
+
"data": Array<BulkDatasetHTTP>;
|
|
210
|
+
};
|
|
211
|
+
/** One dataset's totals within a snapshot. */
|
|
212
|
+
export type BulkDatasetTotalsHTTP = {
|
|
213
|
+
"dataset": string;
|
|
214
|
+
"schema_version": number;
|
|
215
|
+
"rows": number;
|
|
216
|
+
"bytes": number;
|
|
217
|
+
"files": number;
|
|
218
|
+
"changed_files": number;
|
|
219
|
+
"statement_types"?: (Array<string> | null);
|
|
220
|
+
};
|
|
221
|
+
export type BulkDownloadUrlEnvelope = {
|
|
222
|
+
"data": BulkDownloadUrlHTTP;
|
|
223
|
+
};
|
|
224
|
+
/** A short-lived URL for one snapshot file. */
|
|
225
|
+
export type BulkDownloadUrlHTTP = {
|
|
226
|
+
"snapshot_id": string;
|
|
227
|
+
"file_path": string;
|
|
228
|
+
"url": string;
|
|
229
|
+
"expires_at": string;
|
|
230
|
+
"bytes": number;
|
|
231
|
+
"sha256": string;
|
|
232
|
+
};
|
|
233
|
+
/** One file of a snapshot, as its manifest lists it. */
|
|
234
|
+
export type BulkFileHTTP = {
|
|
235
|
+
"path": string;
|
|
236
|
+
"dataset": string;
|
|
237
|
+
"partition"?: (Record<string, number> | null);
|
|
238
|
+
"rows": number;
|
|
239
|
+
"bytes": number;
|
|
240
|
+
"sha256": string;
|
|
241
|
+
"changed": boolean;
|
|
242
|
+
};
|
|
243
|
+
/** Who accepted the bulk-data license for an organization, and when. */
|
|
244
|
+
export type BulkLicenseAcceptanceHTTP = {
|
|
245
|
+
"accepted_at": string;
|
|
246
|
+
"accepted_by_name": string;
|
|
247
|
+
"accepted_by_email": string;
|
|
248
|
+
};
|
|
249
|
+
export type BulkLicenseAcceptanceRecordEnvelope = {
|
|
250
|
+
"data": BulkLicenseAcceptanceRecordHTTP;
|
|
251
|
+
};
|
|
252
|
+
/** The acceptance on record for the caller's organization. */
|
|
253
|
+
export type BulkLicenseAcceptanceRecordHTTP = {
|
|
254
|
+
"license_version": string;
|
|
255
|
+
"license_sha256": string;
|
|
256
|
+
"accepted_at": string;
|
|
257
|
+
"accepted_by_name": string;
|
|
258
|
+
"accepted_by_email": string;
|
|
259
|
+
};
|
|
260
|
+
/** An organization's acceptance of the current bulk-data license. */
|
|
261
|
+
export type BulkLicenseAcceptanceRequestHTTP = {
|
|
262
|
+
"license_version": string;
|
|
263
|
+
"license_sha256": string;
|
|
264
|
+
"accepted_by_name": string;
|
|
265
|
+
"accepted_by_email": string;
|
|
266
|
+
};
|
|
267
|
+
export type BulkLicenseEnvelope = {
|
|
268
|
+
"data": BulkLicenseHTTP;
|
|
269
|
+
};
|
|
270
|
+
/** The current bulk-data license, and whether the caller's organization accepted it. */
|
|
271
|
+
export type BulkLicenseHTTP = {
|
|
272
|
+
"license_version": string;
|
|
273
|
+
"license_sha256": string;
|
|
274
|
+
"text": string;
|
|
275
|
+
"accepted": boolean;
|
|
276
|
+
"acceptance"?: (BulkLicenseAcceptanceHTTP | null);
|
|
277
|
+
};
|
|
278
|
+
/** One published snapshot, without its file list. */
|
|
279
|
+
export type BulkSnapshotHTTP = {
|
|
280
|
+
"snapshot_id": string;
|
|
281
|
+
"build_kind": string;
|
|
282
|
+
"format_version": number;
|
|
283
|
+
"previous_snapshot_id"?: (string | null);
|
|
284
|
+
"published_at": string;
|
|
285
|
+
"read_at"?: (string | null);
|
|
286
|
+
"rows": number;
|
|
287
|
+
"bytes": number;
|
|
288
|
+
"datasets": Array<BulkDatasetTotalsHTTP>;
|
|
289
|
+
};
|
|
290
|
+
export type BulkSnapshotManifestEnvelope = {
|
|
291
|
+
"data": BulkSnapshotManifestHTTP;
|
|
292
|
+
};
|
|
293
|
+
/** Every file of one published snapshot. */
|
|
294
|
+
export type BulkSnapshotManifestHTTP = {
|
|
295
|
+
"snapshot_id": string;
|
|
296
|
+
"build_kind": string;
|
|
297
|
+
"format_version": number;
|
|
298
|
+
"previous_snapshot_id"?: (string | null);
|
|
299
|
+
"published_at"?: (string | null);
|
|
300
|
+
"read_at"?: (string | null);
|
|
301
|
+
"rows": number;
|
|
302
|
+
"bytes": number;
|
|
303
|
+
"datasets": Array<BulkDatasetTotalsHTTP>;
|
|
304
|
+
"files": Array<BulkFileHTTP>;
|
|
305
|
+
};
|
|
306
|
+
export type BulkSnapshotPage = {
|
|
307
|
+
"page": number;
|
|
308
|
+
"page_size": number;
|
|
309
|
+
"total": number;
|
|
310
|
+
"items": Array<BulkSnapshotHTTP>;
|
|
311
|
+
};
|
|
312
|
+
/** Canonical financial statement metrics. */
|
|
313
|
+
export type CanonicalStatementMetric = "REVENUE" | "COST_OF_REVENUE" | "GROSS_PROFIT" | "RESEARCH_AND_DEVELOPMENT_EXPENSE" | "SELLING_GENERAL_AND_ADMINISTRATIVE_EXPENSE" | "DEPRECIATION_AND_AMORTIZATION_EXPENSE" | "OPERATING_INCOME" | "OPERATING_EXPENSE" | "INTEREST_INCOME" | "INTEREST_EXPENSE" | "NET_INTEREST_INCOME" | "OTHER_NON_OPERATING_INCOME_EXPENSE" | "INCOME_BEFORE_TAX" | "INCOME_TAX_EXPENSE" | "NET_INCOME" | "NET_INCOME_ATTRIBUTABLE_TO_NONCONTROLLING_INTEREST" | "INCOME_FROM_DISCONTINUED_OPERATIONS" | "INCOME_FROM_EQUITY_METHOD_INVESTMENTS" | "BASIC_EPS" | "DILUTED_EPS" | "WEIGHTED_AVERAGE_SHARES_BASIC" | "WEIGHTED_AVERAGE_SHARES_DILUTED" | "TOTAL_ASSETS" | "TOTAL_CURRENT_ASSETS" | "CASH_AND_CASH_EQUIVALENTS" | "CASH_CASH_EQUIVALENTS_AND_RESTRICTED_CASH" | "SHORT_TERM_INVESTMENTS" | "ACCOUNTS_RECEIVABLE_NET" | "INVENTORIES" | "OTHER_CURRENT_ASSETS" | "TOTAL_NON_CURRENT_ASSETS" | "PROPERTY_PLANT_AND_EQUIPMENT_NET" | "GOODWILL" | "INTANGIBLE_ASSETS_NET" | "OTHER_NON_CURRENT_ASSETS" | "TOTAL_LIABILITIES" | "TOTAL_CURRENT_LIABILITIES" | "ACCOUNTS_PAYABLE" | "SHORT_TERM_DEBT" | "CURRENT_PORTION_OF_LONG_TERM_DEBT" | "OTHER_CURRENT_LIABILITIES" | "TOTAL_NON_CURRENT_LIABILITIES" | "LONG_TERM_DEBT" | "OTHER_NON_CURRENT_LIABILITIES" | "TOTAL_EQUITY" | "TEMPORARY_EQUITY" | "RETAINED_EARNINGS" | "ADDITIONAL_PAID_IN_CAPITAL" | "TREASURY_STOCK" | "ACCUMULATED_OTHER_COMPREHENSIVE_INCOME" | "NET_CASH_FROM_OPERATING_ACTIVITIES" | "NET_CASH_FROM_INVESTING_ACTIVITIES" | "NET_CASH_FROM_FINANCING_ACTIVITIES" | "EFFECT_OF_EXCHANGE_RATE_ON_CASH" | "NET_INCREASE_DECREASE_IN_CASH" | "CASH_FLOW_STARTING_NET_INCOME" | "CASH_PAID_FOR_INTEREST" | "CASH_PAID_FOR_INCOME_TAXES" | "STOCK_BASED_COMPENSATION_IN_CFO" | "DEPRECIATION_AND_AMORTIZATION_IN_CFO" | "CHANGE_IN_ACCOUNTS_RECEIVABLE" | "CHANGE_IN_INVENTORIES" | "CHANGE_IN_ACCOUNTS_PAYABLE" | "CHANGE_IN_OTHER_CURRENT_ASSETS" | "CHANGE_IN_OTHER_CURRENT_LIABILITIES" | "CAPITAL_EXPENDITURES" | "FREE_CASH_FLOW" | "DIVIDENDS_PAID" | "SHARE_REPURCHASES_PAID" | "SHARE_ISSUANCE_PROCEEDS" | "OTHER_OPERATING_INCOME_EXPENSE" | "OTHER_ASSETS" | "OTHER_LIABILITIES" | "OTHER_CASH_FLOW_FROM_OPERATIONS" | "OTHER_CASH_FLOW_FROM_INVESTING" | "OTHER_CASH_FLOW_FROM_FINANCING" | "SHARES_OUTSTANDING" | "DEFERRED_REVENUE_CURRENT" | "DEFERRED_REVENUE_NON_CURRENT" | "OPERATING_LEASE_LIABILITY" | "FINANCE_LEASE_LIABILITY" | "OPERATING_LEASE_RIGHT_OF_USE_ASSET" | "NONCONTROLLING_INTEREST" | "COMPREHENSIVE_INCOME" | "PREFERRED_DIVIDENDS" | "INCOME_FROM_CONTINUING_OPERATIONS" | "PROVISION_FOR_CREDIT_LOSSES" | "NONINTEREST_INCOME" | "NONINTEREST_EXPENSE" | "LOANS_NET" | "DEPOSITS" | "PREMIUMS_EARNED" | "POLICY_BENEFITS_AND_CLAIMS" | "NET_INVESTMENT_INCOME" | "FUTURE_POLICY_BENEFITS" | "UNPAID_CLAIMS_RESERVE";
|
|
314
|
+
/** Result of a single dependency check. */
|
|
315
|
+
export type CheckResult = {
|
|
316
|
+
"name": string;
|
|
317
|
+
"status": "ok" | "down";
|
|
318
|
+
"detail"?: (string | null);
|
|
319
|
+
"duration_ms": number;
|
|
320
|
+
};
|
|
321
|
+
export type CompanyCoverageSummaryEnvelope = {
|
|
322
|
+
"data": CompanyCoverageSummaryHTTP;
|
|
323
|
+
};
|
|
324
|
+
/** HTTP schema for one company coverage summary. */
|
|
325
|
+
export type CompanyCoverageSummaryHTTP = {
|
|
326
|
+
"cik": string;
|
|
327
|
+
"ticker"?: (string | null);
|
|
328
|
+
"company_name"?: (string | null);
|
|
329
|
+
"first_fiscal_year"?: (number | null);
|
|
330
|
+
"latest_fiscal_year"?: (number | null);
|
|
331
|
+
"annual_periods_expected": number;
|
|
332
|
+
"annual_periods_populated": number;
|
|
333
|
+
"quarterly_periods_expected": number;
|
|
334
|
+
"quarterly_periods_populated": number;
|
|
335
|
+
"income_statement_completeness": string;
|
|
336
|
+
"balance_sheet_completeness": string;
|
|
337
|
+
"cash_flow_statement_completeness": string;
|
|
338
|
+
"core_metric_completeness": string;
|
|
339
|
+
"annual_reporting_continuous": boolean;
|
|
340
|
+
"filing_count": number;
|
|
341
|
+
"latest_filing_date"?: (string | null);
|
|
342
|
+
"latest_accepted_at"?: (string | null);
|
|
343
|
+
"computed_at"?: (string | null);
|
|
344
|
+
};
|
|
345
|
+
export type CompanyCoverageSummaryPage = {
|
|
346
|
+
"page": number;
|
|
347
|
+
"page_size": number;
|
|
348
|
+
"total": number;
|
|
349
|
+
"items": Array<CompanyCoverageSummaryHTTP>;
|
|
350
|
+
};
|
|
351
|
+
/** HTTP schema for one company identity record. */
|
|
352
|
+
export type CompanyIdentityHTTP = {
|
|
353
|
+
"company_id"?: (string | null);
|
|
354
|
+
"cik": string;
|
|
355
|
+
"ticker"?: (string | null);
|
|
356
|
+
"company_name": string;
|
|
357
|
+
"exchange"?: (string | null);
|
|
358
|
+
"active_from"?: (string | null);
|
|
359
|
+
"active_to"?: (string | null);
|
|
360
|
+
"is_active": boolean;
|
|
361
|
+
"source": string;
|
|
362
|
+
"source_filing_accession"?: (string | null);
|
|
363
|
+
"confidence_score"?: (string | null);
|
|
364
|
+
};
|
|
365
|
+
export type CompanyIdentityPage = {
|
|
366
|
+
"page": number;
|
|
367
|
+
"page_size": number;
|
|
368
|
+
"total": number;
|
|
369
|
+
"items": Array<CompanyIdentityHTTP>;
|
|
370
|
+
};
|
|
371
|
+
export type CompanyIdentityResolveEnvelope = {
|
|
372
|
+
"data": CompanyIdentityResolveHTTP;
|
|
373
|
+
};
|
|
374
|
+
/** HTTP schema for date-aware ticker resolution. */
|
|
375
|
+
export type CompanyIdentityResolveHTTP = {
|
|
376
|
+
"as_of_date": string;
|
|
377
|
+
"identity": CompanyIdentityHTTP;
|
|
378
|
+
};
|
|
379
|
+
export type CoverageSelectionEnvelope = {
|
|
380
|
+
"data": CoverageSelectionHTTP;
|
|
381
|
+
};
|
|
382
|
+
/** HTTP schema for the companies a plan covers right now. */
|
|
383
|
+
export type CoverageSelectionHTTP = {
|
|
384
|
+
"mode": "selected" | "full" | "dow30" | "sp500";
|
|
385
|
+
"limit"?: (number | null);
|
|
386
|
+
"window_days"?: (number | null);
|
|
387
|
+
"slots_used": number;
|
|
388
|
+
"slots_available"?: (number | null);
|
|
389
|
+
"companies"?: Array<CoverageSlotHTTP>;
|
|
390
|
+
};
|
|
391
|
+
/** HTTP schema for releasing one company's slot. */
|
|
392
|
+
export type CoverageSelectionReleaseRequestHTTP = {
|
|
393
|
+
"cik": string;
|
|
394
|
+
};
|
|
395
|
+
/** HTTP schema for one company a chosen-coverage plan holds. */
|
|
396
|
+
export type CoverageSlotHTTP = {
|
|
397
|
+
"cik": string;
|
|
398
|
+
"claimed_at": string;
|
|
399
|
+
"last_queried_at": string;
|
|
400
|
+
"expires_at": string;
|
|
401
|
+
};
|
|
402
|
+
/** One rule-level data-quality anomaly. */
|
|
403
|
+
export type DQAnomalyHTTP = {
|
|
404
|
+
"metric"?: (string | null);
|
|
405
|
+
"dimension_key"?: (string | null);
|
|
406
|
+
"rule_code": string;
|
|
407
|
+
"severity": MaterialityClass;
|
|
408
|
+
"message": string;
|
|
409
|
+
"details"?: (Record<string, string> | null);
|
|
410
|
+
};
|
|
411
|
+
/** HTTP schema for a DQ summary block. */
|
|
412
|
+
export type DQSummaryHTTP = {
|
|
413
|
+
"dq_max_severity"?: (MaterialityClass | null);
|
|
414
|
+
"dq_issue_count"?: number;
|
|
415
|
+
};
|
|
416
|
+
/** One data-quality rule a metric failed. */
|
|
417
|
+
export type DataQualityFlagItemHTTP = {
|
|
418
|
+
"metric_name": string;
|
|
419
|
+
"rule_name": string;
|
|
420
|
+
"severity": MaterialityClass;
|
|
421
|
+
};
|
|
422
|
+
/** One public data-quality issue. */
|
|
423
|
+
export type DataQualityIssueHTTP = {
|
|
424
|
+
"cik": string;
|
|
425
|
+
"metric"?: (string | null);
|
|
426
|
+
"statement_type"?: (string | null);
|
|
427
|
+
"fiscal_year"?: (number | null);
|
|
428
|
+
"fiscal_period"?: (string | null);
|
|
429
|
+
"filing_accession"?: (string | null);
|
|
430
|
+
"rule_code": string;
|
|
431
|
+
"rule_category": string;
|
|
432
|
+
"severity": MaterialityClass;
|
|
433
|
+
"status": string;
|
|
434
|
+
"message": string;
|
|
435
|
+
"expected_value"?: (string | null);
|
|
436
|
+
"actual_value"?: (string | null);
|
|
437
|
+
"materiality"?: (MaterialityClass | null);
|
|
438
|
+
"created_at": string;
|
|
439
|
+
"provenance"?: (Record<string, unknown> | null);
|
|
440
|
+
};
|
|
441
|
+
export type DataQualityIssuePage = {
|
|
442
|
+
"page": number;
|
|
443
|
+
"page_size": number;
|
|
444
|
+
"total": number;
|
|
445
|
+
"items": Array<DataQualityIssueHTTP>;
|
|
446
|
+
};
|
|
447
|
+
/** Derived financial metrics used in analytics and modeling. */
|
|
448
|
+
export type DerivedMetric = "GROSS_MARGIN" | "OPERATING_MARGIN" | "NET_MARGIN" | "EFFECTIVE_TAX_RATE" | "EBIT_MARGIN" | "CFO_MARGIN" | "EBITDA_MARGIN" | "FCF_MARGIN" | "SBC_TO_REVENUE" | "SBC_TO_CFO" | "CAPEX_TO_REVENUE" | "CAPEX_TO_CFO" | "CASH_TAX_RATE" | "REVENUE_GROWTH_YOY" | "REVENUE_GROWTH_QOQ" | "REVENUE_GROWTH_TTM" | "EPS_DILUTED_GROWTH" | "EBITDA" | "EBIT" | "LEVERED_FREE_CASH_FLOW" | "UNLEVERED_FREE_CASH_FLOW" | "DIVIDENDS_PAID" | "DIVIDENDS_PER_SHARE" | "WORKING_CAPITAL" | "CURRENT_RATIO" | "QUICK_RATIO" | "BOOK_VALUE_PER_SHARE" | "DEBT_TO_EQUITY" | "NET_DEBT_TO_EQUITY" | "NET_DEBT_TO_EBITDA" | "DEBT_TO_ASSETS" | "INTEREST_COVERAGE" | "CASH_RATIO" | "CFO_TO_NET_INCOME" | "FCF_CONVERSION" | "DSO" | "DPO" | "DIO" | "INVENTORY_TURNOVER" | "CASH_CONVERSION_CYCLE" | "ASSET_TURNOVER" | "ROE" | "ROA" | "ROIC" | "PAYOUT_RATIO" | "SHARE_REPURCHASES" | "NET_BUYBACK" | "REVENUE_PER_SHARE" | "FCF_PER_SHARE" | "RECEIVABLES_TURNOVER" | "PAYABLES_TURNOVER" | "TANGIBLE_BOOK_VALUE" | "TANGIBLE_BOOK_VALUE_PER_SHARE" | "REINVESTMENT_RATE" | "RETENTION_RATIO" | "PAYOUT_PLUS_BUYBACK_RATIO";
|
|
449
|
+
export type EarningsReleaseEnvelope = {
|
|
450
|
+
"data": EarningsReleaseHTTP;
|
|
451
|
+
};
|
|
452
|
+
/** An 8-K's earnings release (EX-99.1), the quarter's first filed source. */
|
|
453
|
+
export type EarningsReleaseHTTP = {
|
|
454
|
+
"cik": string;
|
|
455
|
+
"accession_id": string;
|
|
456
|
+
"form_type": string;
|
|
457
|
+
"filed_date": string;
|
|
458
|
+
"accepted_at"?: (string | null);
|
|
459
|
+
"document_name"?: (string | null);
|
|
460
|
+
"period_end"?: (string | null);
|
|
461
|
+
"values": Array<EarningsReleaseValueHTTP>;
|
|
462
|
+
};
|
|
463
|
+
/** One numeric cell of an earnings release table, exactly as filed. */
|
|
464
|
+
export type EarningsReleaseValueHTTP = {
|
|
465
|
+
"table": number;
|
|
466
|
+
"row": number;
|
|
467
|
+
"column": number;
|
|
468
|
+
"label": string;
|
|
469
|
+
"column_label": string;
|
|
470
|
+
"value": string;
|
|
471
|
+
"scale": number;
|
|
472
|
+
"percent": boolean;
|
|
473
|
+
"concept"?: (string | null);
|
|
474
|
+
"reported"?: boolean;
|
|
475
|
+
};
|
|
476
|
+
export type EdgarCompanyCompletenessEnvelope = {
|
|
477
|
+
"data": EdgarCompanyCompletenessHTTP;
|
|
478
|
+
};
|
|
479
|
+
/** HTTP schema for an EDGAR company completeness summary. */
|
|
480
|
+
export type EdgarCompanyCompletenessHTTP = {
|
|
481
|
+
"cik": string;
|
|
482
|
+
"latest_filing_accession"?: (string | null);
|
|
483
|
+
"latest_filed_at"?: (string | null);
|
|
484
|
+
"latest_period_end"?: (string | null);
|
|
485
|
+
"statement_types_available"?: Array<StatementType>;
|
|
486
|
+
"statements_count_by_statement_type"?: Record<string, number>;
|
|
487
|
+
"last_updated_at"?: (string | null);
|
|
488
|
+
};
|
|
489
|
+
export type EdgarCompanyProfileEnvelope = {
|
|
490
|
+
"data": EdgarCompanyProfileHTTP;
|
|
491
|
+
};
|
|
492
|
+
/** HTTP schema for canonical EDGAR company profiles. */
|
|
493
|
+
export type EdgarCompanyProfileHTTP = {
|
|
494
|
+
"cik": string;
|
|
495
|
+
"entity_name": string;
|
|
496
|
+
"tickers"?: Array<string>;
|
|
497
|
+
"exchanges"?: Array<string>;
|
|
498
|
+
"sic"?: (string | null);
|
|
499
|
+
"sic_description"?: (string | null);
|
|
500
|
+
"state_of_incorporation"?: (string | null);
|
|
501
|
+
"fiscal_year_end"?: (string | null);
|
|
502
|
+
"last_updated_at": string;
|
|
503
|
+
"source": EdgarCompanyProfileSourceHTTP;
|
|
504
|
+
};
|
|
505
|
+
/** HTTP schema for company profile provenance metadata. */
|
|
506
|
+
export type EdgarCompanyProfileSourceHTTP = {
|
|
507
|
+
"provider": string;
|
|
508
|
+
"dataset": string;
|
|
509
|
+
"as_of": string;
|
|
510
|
+
"fetched_at": string;
|
|
511
|
+
};
|
|
512
|
+
export type EdgarCompanyResolveEnvelope = {
|
|
513
|
+
"data": EdgarCompanyResolveHTTP;
|
|
514
|
+
};
|
|
515
|
+
/** HTTP schema for ticker-to-CIK resolution results. */
|
|
516
|
+
export type EdgarCompanyResolveHTTP = {
|
|
517
|
+
"ticker": string;
|
|
518
|
+
"exchange"?: (string | null);
|
|
519
|
+
"as_of": string;
|
|
520
|
+
"cik": string;
|
|
521
|
+
};
|
|
522
|
+
/** HTTP schema for a single derived metric specification. */
|
|
523
|
+
export type EdgarDerivedMetricSpecHTTP = {
|
|
524
|
+
"code": string;
|
|
525
|
+
"category": string;
|
|
526
|
+
"description": string;
|
|
527
|
+
"is_experimental": boolean;
|
|
528
|
+
"required_statement_types"?: Array<StatementType>;
|
|
529
|
+
"required_inputs"?: Array<string>;
|
|
530
|
+
"uses_history": boolean;
|
|
531
|
+
"window_requirements"?: Record<string, number>;
|
|
532
|
+
};
|
|
533
|
+
export type EdgarDerivedMetricsCatalogEnvelope = {
|
|
534
|
+
"data": EdgarDerivedMetricsCatalogHTTP;
|
|
535
|
+
};
|
|
536
|
+
/** HTTP schema for the catalog of registered derived metrics. */
|
|
537
|
+
export type EdgarDerivedMetricsCatalogHTTP = {
|
|
538
|
+
"metrics"?: Array<EdgarDerivedMetricSpecHTTP>;
|
|
539
|
+
};
|
|
540
|
+
/** HTTP schema for a single derived metrics time-series point. */
|
|
541
|
+
export type EdgarDerivedMetricsPointHTTP = {
|
|
542
|
+
"cik": string;
|
|
543
|
+
"statement_type": StatementType;
|
|
544
|
+
"accounting_standard": AccountingStandard;
|
|
545
|
+
"statement_date": string;
|
|
546
|
+
"fiscal_year": number;
|
|
547
|
+
"fiscal_period": FiscalPeriod;
|
|
548
|
+
"currency": string;
|
|
549
|
+
"metrics": Record<string, string>;
|
|
550
|
+
"dividend_period_basis"?: (string | null);
|
|
551
|
+
"payout_ratio_period_basis"?: (string | null);
|
|
552
|
+
};
|
|
553
|
+
export type EdgarDerivedMetricsTimeSeriesEnvelope = {
|
|
554
|
+
"data": EdgarDerivedMetricsTimeSeriesHTTP;
|
|
555
|
+
};
|
|
556
|
+
/** HTTP schema for a derived metrics time series. */
|
|
557
|
+
export type EdgarDerivedMetricsTimeSeriesHTTP = {
|
|
558
|
+
"ciks": Array<string>;
|
|
559
|
+
"statement_type": StatementType;
|
|
560
|
+
"frequency": string;
|
|
561
|
+
"from_date": string;
|
|
562
|
+
"to_date": string;
|
|
563
|
+
"points": Array<EdgarDerivedMetricsPointHTTP>;
|
|
564
|
+
"view"?: (string | null);
|
|
565
|
+
};
|
|
566
|
+
export type EdgarFilingDisclosureEnvelope = {
|
|
567
|
+
"data": EdgarFilingDisclosureHTTP;
|
|
568
|
+
};
|
|
569
|
+
/** A disclosure together with its narrative text. */
|
|
570
|
+
export type EdgarFilingDisclosureHTTP = {
|
|
571
|
+
"disclosure_id": string;
|
|
572
|
+
"accession_id": string;
|
|
573
|
+
"cik": string;
|
|
574
|
+
"period_of_report": string;
|
|
575
|
+
"concept": string;
|
|
576
|
+
"title": string;
|
|
577
|
+
"char_count": number;
|
|
578
|
+
"disclosure_text": string;
|
|
579
|
+
};
|
|
580
|
+
/** A disclosure's identity and size, without its text. */
|
|
581
|
+
export type EdgarFilingDisclosureSummaryHTTP = {
|
|
582
|
+
"disclosure_id": string;
|
|
583
|
+
"accession_id": string;
|
|
584
|
+
"cik": string;
|
|
585
|
+
"period_of_report": string;
|
|
586
|
+
"concept": string;
|
|
587
|
+
"title": string;
|
|
588
|
+
"char_count": number;
|
|
589
|
+
};
|
|
590
|
+
export type EdgarFilingDisclosureSummaryPage = {
|
|
591
|
+
"page": number;
|
|
592
|
+
"page_size": number;
|
|
593
|
+
"total": number;
|
|
594
|
+
"items": Array<EdgarFilingDisclosureSummaryHTTP>;
|
|
595
|
+
};
|
|
596
|
+
export type EdgarFilingEnvelope = {
|
|
597
|
+
"data": EdgarFilingHTTP;
|
|
598
|
+
};
|
|
599
|
+
/** One SEC filing: its accession, form, dates and acceptance time. */
|
|
600
|
+
export type EdgarFilingHTTP = {
|
|
601
|
+
"accession_id": string;
|
|
602
|
+
"cik": string;
|
|
603
|
+
"company_name"?: (string | null);
|
|
604
|
+
"filing_type": string;
|
|
605
|
+
"filing_date": string;
|
|
606
|
+
"period_end_date"?: (string | null);
|
|
607
|
+
"is_amendment": boolean;
|
|
608
|
+
"amendment_sequence"?: (number | null);
|
|
609
|
+
"primary_document"?: (string | null);
|
|
610
|
+
"accepted_at"?: (string | null);
|
|
611
|
+
};
|
|
612
|
+
export type EdgarFilingPage = {
|
|
613
|
+
"page": number;
|
|
614
|
+
"page_size": number;
|
|
615
|
+
"total": number;
|
|
616
|
+
"items": Array<EdgarFilingHTTP>;
|
|
617
|
+
};
|
|
618
|
+
export type EdgarFinancialsAsOfEnvelope = {
|
|
619
|
+
"data": EdgarFinancialsAsOfHTTP;
|
|
620
|
+
};
|
|
621
|
+
/** HTTP schema for an as-of financial snapshot response. */
|
|
622
|
+
export type EdgarFinancialsAsOfHTTP = {
|
|
623
|
+
"cik": string;
|
|
624
|
+
"as_of_date": string;
|
|
625
|
+
"as_of_timestamp": string;
|
|
626
|
+
"audit_mode"?: boolean;
|
|
627
|
+
"snapshot_hash": string;
|
|
628
|
+
"verify_url": string;
|
|
629
|
+
"_meta"?: (AsOfMetaHTTP | null);
|
|
630
|
+
"statements"?: Array<EdgarStatementHTTP>;
|
|
631
|
+
};
|
|
632
|
+
export type EdgarFinancialsAsOfPageEnvelope = {
|
|
633
|
+
"data": EdgarFinancialsAsOfPageHTTP;
|
|
634
|
+
};
|
|
635
|
+
/** One page of a company's as-of selection. */
|
|
636
|
+
export type EdgarFinancialsAsOfPageHTTP = {
|
|
637
|
+
"cik": string;
|
|
638
|
+
"as_of_date": string;
|
|
639
|
+
"as_of_timestamp": string;
|
|
640
|
+
"audit_mode"?: boolean;
|
|
641
|
+
"snapshot_hash": string;
|
|
642
|
+
"verify_url": string;
|
|
643
|
+
"_meta"?: (AsOfMetaHTTP | null);
|
|
644
|
+
"statements"?: Array<AsOfPageStatementHTTP>;
|
|
645
|
+
"snapshot_statement_count": number;
|
|
646
|
+
"matched_count": number;
|
|
647
|
+
"selected_count": number;
|
|
648
|
+
};
|
|
649
|
+
/** One SEC filing's statement: its identity, its filing and, optionally, its figures. */
|
|
650
|
+
export type EdgarStatementHTTP = {
|
|
651
|
+
"accession_id": string;
|
|
652
|
+
"cik": string;
|
|
653
|
+
"company_name"?: (string | null);
|
|
654
|
+
"statement_type": StatementType;
|
|
655
|
+
"accounting_standard": AccountingStandard;
|
|
656
|
+
"statement_date": string;
|
|
657
|
+
"fiscal_year": number;
|
|
658
|
+
"fiscal_period": FiscalPeriod;
|
|
659
|
+
"period_start"?: (string | null);
|
|
660
|
+
"reporting_entity"?: "REGISTRANT" | "PREDECESSOR";
|
|
661
|
+
"currency": string;
|
|
662
|
+
"is_restated": boolean;
|
|
663
|
+
"restated_by_accession_id"?: (string | null);
|
|
664
|
+
"filing_type": string;
|
|
665
|
+
"is_amendment": boolean;
|
|
666
|
+
"amendment_sequence"?: (number | null);
|
|
667
|
+
"filing_date": string;
|
|
668
|
+
"accepted_at"?: (string | null);
|
|
669
|
+
"values"?: Record<string, string>;
|
|
670
|
+
"units"?: Record<string, string>;
|
|
671
|
+
"usd"?: (StatementUsdHTTP | null);
|
|
672
|
+
"content"?: (NormalizedStatementHTTP | null);
|
|
673
|
+
"quality"?: (StatementQualityHTTP | null);
|
|
674
|
+
};
|
|
675
|
+
export type EdgarStatementListEnvelope = {
|
|
676
|
+
"data": EdgarStatementListHTTP;
|
|
677
|
+
};
|
|
678
|
+
/** The statements one SEC filing reported, with the filing they came from. */
|
|
679
|
+
export type EdgarStatementListHTTP = {
|
|
680
|
+
"filing"?: (EdgarFilingHTTP | null);
|
|
681
|
+
"items"?: Array<EdgarStatementHTTP>;
|
|
682
|
+
};
|
|
683
|
+
export type EdgarStatementPage = {
|
|
684
|
+
"page": number;
|
|
685
|
+
"page_size": number;
|
|
686
|
+
"total": number;
|
|
687
|
+
"items": Array<EdgarStatementHTTP>;
|
|
688
|
+
};
|
|
689
|
+
/** HTTP schema for embedding metadata. */
|
|
690
|
+
export type EmbeddingMetadataHTTP = {
|
|
691
|
+
"company_id": string;
|
|
692
|
+
"cik": string;
|
|
693
|
+
"as_of_timestamp": string;
|
|
694
|
+
"embedding_type": EmbeddingType;
|
|
695
|
+
"period_end"?: (string | null);
|
|
696
|
+
"embedding_mode": EmbeddingMode;
|
|
697
|
+
"vector_dim": number;
|
|
698
|
+
};
|
|
699
|
+
export type EmbeddingMetadataPage = {
|
|
700
|
+
"page": number;
|
|
701
|
+
"page_size": number;
|
|
702
|
+
"total": number;
|
|
703
|
+
"items": Array<EmbeddingMetadataHTTP>;
|
|
704
|
+
};
|
|
705
|
+
/** Embedding mode selector. */
|
|
706
|
+
export type EmbeddingMode = "deterministic" | "semantic";
|
|
707
|
+
/** Embedding granularity types for AI analytics. */
|
|
708
|
+
export type EmbeddingType = "PERIOD" | "WINDOW_10Y";
|
|
709
|
+
/** The SEC filing behind an availability decision. */
|
|
710
|
+
export type EndpointAvailabilityEvidenceHTTP = {
|
|
711
|
+
"accession_id"?: (string | null);
|
|
712
|
+
};
|
|
713
|
+
/** Whether the requested statements are available, and if not, why. */
|
|
714
|
+
export type EndpointAvailabilityHTTP = {
|
|
715
|
+
"availability_status": string;
|
|
716
|
+
"reporting_lifecycle_status"?: (string | null);
|
|
717
|
+
"source_gap_terminal"?: boolean;
|
|
718
|
+
"required"?: (boolean | null);
|
|
719
|
+
"identity": EndpointAvailabilityIdentityHTTP;
|
|
720
|
+
"evidence"?: (EndpointAvailabilityEvidenceHTTP | null);
|
|
721
|
+
"summary"?: (EndpointAvailabilitySummaryHTTP | null);
|
|
722
|
+
};
|
|
723
|
+
/** HTTP statement identity represented by availability metadata. */
|
|
724
|
+
export type EndpointAvailabilityIdentityHTTP = {
|
|
725
|
+
"cik": string;
|
|
726
|
+
"statement_type"?: (string | null);
|
|
727
|
+
"fiscal_year"?: (number | null);
|
|
728
|
+
"fiscal_period"?: (string | null);
|
|
729
|
+
};
|
|
730
|
+
/** HTTP aggregate availability counts for a query window. */
|
|
731
|
+
export type EndpointAvailabilitySummaryHTTP = {
|
|
732
|
+
"published"?: number;
|
|
733
|
+
"terminal_source_gap"?: number;
|
|
734
|
+
"outside_lifecycle"?: number;
|
|
735
|
+
"ordinary_no_data"?: number;
|
|
736
|
+
"unsupported_query"?: number;
|
|
737
|
+
"total"?: number;
|
|
738
|
+
};
|
|
739
|
+
/** Canonical error envelope: {"error": ErrorObject}. */
|
|
740
|
+
export type ErrorEnvelope = {
|
|
741
|
+
"error": ErrorObject;
|
|
742
|
+
};
|
|
743
|
+
/** Structured error object inside ErrorEnvelope. */
|
|
744
|
+
export type ErrorObject = {
|
|
745
|
+
"code": string;
|
|
746
|
+
"http_status": number;
|
|
747
|
+
"message": string;
|
|
748
|
+
"details"?: (Record<string, unknown> | null);
|
|
749
|
+
"trace_id"?: (string | null);
|
|
750
|
+
};
|
|
751
|
+
/** Data-quality evaluation of one fact. */
|
|
752
|
+
export type FactQualityHTTP = {
|
|
753
|
+
"cik": string;
|
|
754
|
+
"statement_type": string;
|
|
755
|
+
"fiscal_year": number;
|
|
756
|
+
"fiscal_period": string;
|
|
757
|
+
"metric": string;
|
|
758
|
+
"dimension_key": string;
|
|
759
|
+
"severity": MaterialityClass;
|
|
760
|
+
"is_present": boolean;
|
|
761
|
+
"is_non_negative"?: (boolean | null);
|
|
762
|
+
"is_consistent_with_history"?: (boolean | null);
|
|
763
|
+
"has_known_issue": boolean;
|
|
764
|
+
"details"?: (Record<string, string> | null);
|
|
765
|
+
};
|
|
766
|
+
/** HTTP schema for one immutable fact revision event. */
|
|
767
|
+
export type FactRevisionEventHTTP = {
|
|
768
|
+
"accession_id": string;
|
|
769
|
+
"previous_accession_id"?: (string | null);
|
|
770
|
+
"metric_code": string;
|
|
771
|
+
"dimension_key": string;
|
|
772
|
+
"previous_value"?: (string | null);
|
|
773
|
+
"current_value"?: (string | null);
|
|
774
|
+
"delta_value"?: (string | null);
|
|
775
|
+
"previous_unit"?: (string | null);
|
|
776
|
+
"current_unit"?: (string | null);
|
|
777
|
+
"previous_source_concept"?: (string | null);
|
|
778
|
+
"current_source_concept"?: (string | null);
|
|
779
|
+
"change_type": "NEW_DISCLOSURE" | "REMOVED_DISCLOSURE" | "VALUE_REVISION" | "RECLASSIFICATION" | "PERIOD_CORRECTION" | "CONCEPT_CHANGE" | "PRESENTATION_ONLY";
|
|
780
|
+
"effective_at": string;
|
|
781
|
+
"known_at": string;
|
|
782
|
+
};
|
|
783
|
+
export type FactRevisionLedgerEnvelope = {
|
|
784
|
+
"data": FactRevisionLedgerHTTP;
|
|
785
|
+
};
|
|
786
|
+
/** HTTP schema for one filing statement's fact revision ledger. */
|
|
787
|
+
export type FactRevisionLedgerHTTP = {
|
|
788
|
+
"cik": string;
|
|
789
|
+
"statement_type": StatementType;
|
|
790
|
+
"fiscal_year": number;
|
|
791
|
+
"fiscal_period": FiscalPeriod;
|
|
792
|
+
"accession_id": string;
|
|
793
|
+
"items"?: Array<FactRevisionEventHTTP>;
|
|
794
|
+
};
|
|
795
|
+
/** One axis and member qualifying a filing fact. */
|
|
796
|
+
export type FilingFactDimensionHTTP = {
|
|
797
|
+
"axis": string;
|
|
798
|
+
"member": string;
|
|
799
|
+
};
|
|
800
|
+
/** One numeric value a filing tagged in XBRL, as filed. */
|
|
801
|
+
export type FilingFactHTTP = {
|
|
802
|
+
"concept": string;
|
|
803
|
+
"unit": string;
|
|
804
|
+
"value": string;
|
|
805
|
+
"decimals"?: (number | null);
|
|
806
|
+
"period_start"?: (string | null);
|
|
807
|
+
"period_end": string;
|
|
808
|
+
"dimensions": Array<FilingFactDimensionHTTP>;
|
|
809
|
+
};
|
|
810
|
+
export type FilingFactPage = {
|
|
811
|
+
"page": number;
|
|
812
|
+
"page_size": number;
|
|
813
|
+
"total": number;
|
|
814
|
+
"items": Array<FilingFactHTTP>;
|
|
815
|
+
};
|
|
816
|
+
/** Supported EDGAR filing types. */
|
|
817
|
+
export type FilingType = "10-K" | "10-Q" | "10-KT" | "10-QT" | "8-K" | "20-F" | "40-F" | "6-K" | "S-1" | "S-3" | "OTHER";
|
|
818
|
+
/** HTTP schema for deterministic completeness metadata on financial-state rows. */
|
|
819
|
+
export type FinancialStateCompletenessHTTP = {
|
|
820
|
+
"metrics_expected": number;
|
|
821
|
+
"metrics_populated": number;
|
|
822
|
+
"completeness_ratio": string;
|
|
823
|
+
"missing_metrics": Array<string>;
|
|
824
|
+
"by_statement_type": Record<string, Record<string, (string | number | Array<string>)>>;
|
|
825
|
+
};
|
|
826
|
+
/** HTTP schema for one aligned financial-state row. */
|
|
827
|
+
export type FinancialStatePeriodHTTP = {
|
|
828
|
+
"cik": string;
|
|
829
|
+
"fiscal_year": number;
|
|
830
|
+
"fiscal_period": FiscalPeriod;
|
|
831
|
+
"period_start"?: (string | null);
|
|
832
|
+
"period_end": string;
|
|
833
|
+
"accepted_at"?: (string | null);
|
|
834
|
+
"filing_date"?: (string | null);
|
|
835
|
+
"source_accessions": Array<string>;
|
|
836
|
+
"metrics": Record<string, (string | null)>;
|
|
837
|
+
"provenance"?: (Record<string, (MetricProvenanceHTTP | null)> | null);
|
|
838
|
+
"macro_context"?: (MacroContextHTTP | null);
|
|
839
|
+
"completeness": FinancialStateCompletenessHTTP;
|
|
840
|
+
};
|
|
841
|
+
export type FinancialStatePeriodPage = {
|
|
842
|
+
"page": number;
|
|
843
|
+
"page_size": number;
|
|
844
|
+
"total": number;
|
|
845
|
+
"items": Array<FinancialStatePeriodHTTP>;
|
|
846
|
+
};
|
|
847
|
+
/** The filing that first filed a period's figures, before any periodic report. */
|
|
848
|
+
export type FirstFiledSourceHTTP = {
|
|
849
|
+
"form_type": string;
|
|
850
|
+
"accession_id": string;
|
|
851
|
+
"filed_date": string;
|
|
852
|
+
"accepted_at"?: (string | null);
|
|
853
|
+
"period_end": string;
|
|
854
|
+
};
|
|
855
|
+
/** Fiscal period of a statement. */
|
|
856
|
+
export type FiscalPeriod = "FY" | "Q1" | "Q2" | "Q3" | "Q4" | "H1" | "OTHER";
|
|
857
|
+
/** HTTP schema for a single fundamentals time-series point. */
|
|
858
|
+
export type FundamentalsTimeSeriesPointHTTP = {
|
|
859
|
+
"cik": string;
|
|
860
|
+
"statement_type": StatementType;
|
|
861
|
+
"accounting_standard": AccountingStandard;
|
|
862
|
+
"statement_date": string;
|
|
863
|
+
"fiscal_year": number;
|
|
864
|
+
"fiscal_period": FiscalPeriod;
|
|
865
|
+
"currency": string;
|
|
866
|
+
"metrics"?: Record<string, string>;
|
|
867
|
+
};
|
|
868
|
+
export type FundamentalsTimeSeriesPointPage = {
|
|
869
|
+
"page": number;
|
|
870
|
+
"page_size": number;
|
|
871
|
+
"total": number;
|
|
872
|
+
"items": Array<FundamentalsTimeSeriesPointHTTP>;
|
|
873
|
+
};
|
|
874
|
+
/** Overall service health classification. */
|
|
875
|
+
export type HealthState = "ok" | "degraded" | "down";
|
|
876
|
+
/** One evaluated accounting-identity reconciliation rule. */
|
|
877
|
+
export type IdentityCheckHTTP = {
|
|
878
|
+
"rule_id": string;
|
|
879
|
+
"statement_type": string;
|
|
880
|
+
"fiscal_year": number;
|
|
881
|
+
"fiscal_period": string;
|
|
882
|
+
"status": string;
|
|
883
|
+
"severity": string;
|
|
884
|
+
"expected_value"?: (string | null);
|
|
885
|
+
"actual_value"?: (string | null);
|
|
886
|
+
"delta"?: (string | null);
|
|
887
|
+
"tolerance"?: (string | null);
|
|
888
|
+
"reason"?: (string | null);
|
|
889
|
+
};
|
|
890
|
+
/** Accounting-identity reconciliation summary metadata. */
|
|
891
|
+
export type IdentitySummaryHTTP = {
|
|
892
|
+
"pass_rate": (string | null);
|
|
893
|
+
"total_rules_count": number;
|
|
894
|
+
"supported_rules_count": number;
|
|
895
|
+
"skipped_rules_count": number;
|
|
896
|
+
"failed_rules_count": number;
|
|
897
|
+
"checks"?: Array<IdentityCheckHTTP>;
|
|
898
|
+
};
|
|
899
|
+
/** How current one EDGAR feed is. */
|
|
900
|
+
export type IngestionJobStatusHTTP = {
|
|
901
|
+
"job_name": string;
|
|
902
|
+
"source": string;
|
|
903
|
+
"last_triggered"?: (string | null);
|
|
904
|
+
"last_success"?: (string | null);
|
|
905
|
+
"last_failure"?: (string | null);
|
|
906
|
+
"consecutive_failures": number;
|
|
907
|
+
"last_error_code"?: (string | null);
|
|
908
|
+
"lag_seconds"?: (number | null);
|
|
909
|
+
"stale": boolean;
|
|
910
|
+
"stale_reason": string;
|
|
911
|
+
"max_age_seconds": number;
|
|
912
|
+
};
|
|
913
|
+
export type IngestionStatusEnvelope = {
|
|
914
|
+
"data": IngestionStatusHTTP;
|
|
915
|
+
};
|
|
916
|
+
/** How current each EDGAR feed is. */
|
|
917
|
+
export type IngestionStatusHTTP = {
|
|
918
|
+
"jobs": Array<IngestionJobStatusHTTP>;
|
|
919
|
+
};
|
|
920
|
+
/** Liveness response indicating the process is running. */
|
|
921
|
+
export type LivenessResponse = {
|
|
922
|
+
"status"?: "ok";
|
|
923
|
+
};
|
|
924
|
+
export type MCPManifestEnvelope = {
|
|
925
|
+
"data": MCPManifestHTTP;
|
|
926
|
+
};
|
|
927
|
+
/** How to connect to the Arche MCP endpoint and what it offers. */
|
|
928
|
+
export type MCPManifestHTTP = {
|
|
929
|
+
"server_name": string;
|
|
930
|
+
"version": string;
|
|
931
|
+
"path": string;
|
|
932
|
+
"http_method": string;
|
|
933
|
+
"transport": string;
|
|
934
|
+
"protocol_versions": Array<string>;
|
|
935
|
+
"auth_header": string;
|
|
936
|
+
"rate_limit_class": string;
|
|
937
|
+
"rate_limits": Array<MCPRateLimitHTTP>;
|
|
938
|
+
"request_max_bytes": number;
|
|
939
|
+
"response_max_bytes": number;
|
|
940
|
+
"tools": Array<MCPToolHTTP>;
|
|
941
|
+
};
|
|
942
|
+
/** The rate limit one plan is metered against on the MCP endpoint. */
|
|
943
|
+
export type MCPRateLimitHTTP = {
|
|
944
|
+
"tier": string;
|
|
945
|
+
"limit": (number | null);
|
|
946
|
+
"window_seconds": number;
|
|
947
|
+
"negotiated": boolean;
|
|
948
|
+
};
|
|
949
|
+
/** One MCP tool, as `tools/list` returns it, with its minimum plan. */
|
|
950
|
+
export type MCPToolHTTP = {
|
|
951
|
+
"name": string;
|
|
952
|
+
"description": string;
|
|
953
|
+
"input_schema": Record<string, unknown>;
|
|
954
|
+
"minimum_tier": string;
|
|
955
|
+
};
|
|
956
|
+
export type MacroContextEnvelope = {
|
|
957
|
+
"data": MacroContextHTTP;
|
|
958
|
+
};
|
|
959
|
+
/** HTTP schema for compact macro context. */
|
|
960
|
+
export type MacroContextHTTP = {
|
|
961
|
+
"as_of_date"?: (string | null);
|
|
962
|
+
"date": string;
|
|
963
|
+
"cpi": MacroObservationHTTP;
|
|
964
|
+
"core_cpi"?: (MacroObservationHTTP | null);
|
|
965
|
+
"unemployment_rate": MacroObservationHTTP;
|
|
966
|
+
"fed_funds_rate": MacroObservationHTTP;
|
|
967
|
+
"treasury_2y": MacroObservationHTTP;
|
|
968
|
+
"treasury_10y": MacroObservationHTTP;
|
|
969
|
+
"yield_curve_10y_2y": string;
|
|
970
|
+
"retail_sales"?: (MacroObservationHTTP | null);
|
|
971
|
+
"avg_hourly_earnings"?: (MacroObservationHTTP | null);
|
|
972
|
+
"sp500_index"?: (MacroObservationHTTP | null);
|
|
973
|
+
"macro_regime": MacroRegimeHTTP;
|
|
974
|
+
};
|
|
975
|
+
/** HTTP schema for one macro observation. */
|
|
976
|
+
export type MacroObservationHTTP = {
|
|
977
|
+
"source_provider": string;
|
|
978
|
+
"source_series_id": string;
|
|
979
|
+
"observation_date": string;
|
|
980
|
+
"value": string;
|
|
981
|
+
"realtime_start"?: (string | null);
|
|
982
|
+
"realtime_end"?: (string | null);
|
|
983
|
+
"vintage_date"?: (string | null);
|
|
984
|
+
"retrieved_at": string;
|
|
985
|
+
"source_hash": string;
|
|
986
|
+
};
|
|
987
|
+
/** HTTP schema for deterministic macro regime tags. */
|
|
988
|
+
export type MacroRegimeHTTP = {
|
|
989
|
+
"inflation_regime"?: (string | null);
|
|
990
|
+
"rate_regime"?: (string | null);
|
|
991
|
+
"labor_regime"?: (string | null);
|
|
992
|
+
"inflation_yoy"?: (string | null);
|
|
993
|
+
};
|
|
994
|
+
/** Explicitly approved macro series codes. */
|
|
995
|
+
export type MacroSeriesCode = "CPIAUCSL" | "CPILFESL" | "UNRATE" | "FEDFUNDS" | "DGS2" | "DGS10" | "RSAFS" | "CES0500000003" | "SP500";
|
|
996
|
+
/** HTTP schema for an approved macro series definition. */
|
|
997
|
+
export type MacroSeriesDefinitionHTTP = {
|
|
998
|
+
"code": string;
|
|
999
|
+
"display_name": string;
|
|
1000
|
+
"source_provider": string;
|
|
1001
|
+
"source_series_id": string;
|
|
1002
|
+
"frequency": string;
|
|
1003
|
+
"unit": string;
|
|
1004
|
+
"category": string;
|
|
1005
|
+
"enabled": boolean;
|
|
1006
|
+
"redistribution_policy_note"?: (string | null);
|
|
1007
|
+
"description": string;
|
|
1008
|
+
};
|
|
1009
|
+
export type MacroSeriesDefinitionListEnvelope = {
|
|
1010
|
+
"data": Array<MacroSeriesDefinitionHTTP>;
|
|
1011
|
+
};
|
|
1012
|
+
export type MacroSeriesEnvelope = {
|
|
1013
|
+
"data": MacroSeriesHTTP;
|
|
1014
|
+
};
|
|
1015
|
+
/** HTTP schema for a macro series query response. */
|
|
1016
|
+
export type MacroSeriesHTTP = {
|
|
1017
|
+
"series_code": string;
|
|
1018
|
+
"observations"?: Array<MacroObservationHTTP>;
|
|
1019
|
+
};
|
|
1020
|
+
/** Materiality classification for restatement analytics. */
|
|
1021
|
+
export type MaterialityClass = "NONE" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
|
|
1022
|
+
/** HTTP schema for one filing-based bundle definition. */
|
|
1023
|
+
export type MetricBundleCatalogItemHTTP = {
|
|
1024
|
+
"code": string;
|
|
1025
|
+
"label": string;
|
|
1026
|
+
"description": string;
|
|
1027
|
+
"metrics": Array<string>;
|
|
1028
|
+
};
|
|
1029
|
+
export type MetricBundleCatalogItemListEnvelope = {
|
|
1030
|
+
"data": Array<MetricBundleCatalogItemHTTP>;
|
|
1031
|
+
};
|
|
1032
|
+
/** HTTP schema for one filed input a bundle metric was computed from. */
|
|
1033
|
+
export type MetricBundleInputHTTP = {
|
|
1034
|
+
"metric": string;
|
|
1035
|
+
"value": string;
|
|
1036
|
+
"filing_accession": string;
|
|
1037
|
+
"xbrl_concepts": Array<string>;
|
|
1038
|
+
};
|
|
1039
|
+
/** HTTP schema for the provenance of one metric in a bundle row. */
|
|
1040
|
+
export type MetricBundleProvenanceHTTP = {
|
|
1041
|
+
"filing_accession"?: (string | null);
|
|
1042
|
+
"xbrl_concept"?: (string | null);
|
|
1043
|
+
"mapping_type"?: ("DIRECT" | "FALLBACK" | "CALCULATED" | "INFERRED" | "UNKNOWN" | null);
|
|
1044
|
+
"override_applied": boolean;
|
|
1045
|
+
"override_reason"?: (string | null);
|
|
1046
|
+
"inputs"?: Array<MetricBundleInputHTTP>;
|
|
1047
|
+
"unavailable_reason"?: (string | null);
|
|
1048
|
+
"missing_inputs"?: Array<string>;
|
|
1049
|
+
};
|
|
1050
|
+
/** HTTP schema for one aligned filing-based bundle row. */
|
|
1051
|
+
export type MetricBundleTimeSeriesRowHTTP = {
|
|
1052
|
+
"cik": string;
|
|
1053
|
+
"bundle_code": string;
|
|
1054
|
+
"period_type": string;
|
|
1055
|
+
"period_end": string;
|
|
1056
|
+
"fiscal_year": number;
|
|
1057
|
+
"fiscal_period": FiscalPeriod;
|
|
1058
|
+
"filing_accession": string;
|
|
1059
|
+
"filing_type": string;
|
|
1060
|
+
"filing_date": string;
|
|
1061
|
+
"accepted_at"?: (string | null);
|
|
1062
|
+
"metrics": Record<string, (string | null)>;
|
|
1063
|
+
"provenance"?: (Record<string, MetricBundleProvenanceHTTP> | null);
|
|
1064
|
+
};
|
|
1065
|
+
export type MetricBundleTimeSeriesRowPage = {
|
|
1066
|
+
"page": number;
|
|
1067
|
+
"page_size": number;
|
|
1068
|
+
"total": number;
|
|
1069
|
+
"items": Array<MetricBundleTimeSeriesRowHTTP>;
|
|
1070
|
+
};
|
|
1071
|
+
export type MetricCoverageSummaryEnvelope = {
|
|
1072
|
+
"data": MetricCoverageSummaryHTTP;
|
|
1073
|
+
};
|
|
1074
|
+
/** HTTP schema for one metric coverage summary. */
|
|
1075
|
+
export type MetricCoverageSummaryHTTP = {
|
|
1076
|
+
"metric": string;
|
|
1077
|
+
"company_count": number;
|
|
1078
|
+
"years_covered": number;
|
|
1079
|
+
"filing_count": number;
|
|
1080
|
+
"statement_count": number;
|
|
1081
|
+
"annual_completeness": string;
|
|
1082
|
+
"quarterly_completeness": string;
|
|
1083
|
+
"latest_filing_date"?: (string | null);
|
|
1084
|
+
"latest_accepted_at"?: (string | null);
|
|
1085
|
+
};
|
|
1086
|
+
export type MetricCoverageSummaryPage = {
|
|
1087
|
+
"page": number;
|
|
1088
|
+
"page_size": number;
|
|
1089
|
+
"total": number;
|
|
1090
|
+
"items": Array<MetricCoverageSummaryHTTP>;
|
|
1091
|
+
};
|
|
1092
|
+
export type MetricDefinitionEnvelope = {
|
|
1093
|
+
"data": MetricDefinitionHTTP;
|
|
1094
|
+
};
|
|
1095
|
+
/** HTTP payload for one public metric definition. */
|
|
1096
|
+
export type MetricDefinitionHTTP = {
|
|
1097
|
+
"metric": string;
|
|
1098
|
+
"display_name": string;
|
|
1099
|
+
"category": string;
|
|
1100
|
+
"statement_type"?: (string | null);
|
|
1101
|
+
"is_canonical": boolean;
|
|
1102
|
+
"is_derived": boolean;
|
|
1103
|
+
"unit_type": string;
|
|
1104
|
+
"formula"?: (string | null);
|
|
1105
|
+
"dependencies": Array<string>;
|
|
1106
|
+
"denominator_zero_behavior"?: (string | null);
|
|
1107
|
+
"missing_input_behavior"?: (string | null);
|
|
1108
|
+
"market_data_required": boolean;
|
|
1109
|
+
"source_notes"?: (string | null);
|
|
1110
|
+
"provenance_behavior"?: (string | null);
|
|
1111
|
+
};
|
|
1112
|
+
export type MetricDefinitionListEnvelope = {
|
|
1113
|
+
"data": Array<MetricDefinitionHTTP>;
|
|
1114
|
+
};
|
|
1115
|
+
/** HTTP payload for segment/geography metric disclosures. */
|
|
1116
|
+
export type MetricDimensionHTTP = {
|
|
1117
|
+
"accession_id"?: (string | null);
|
|
1118
|
+
"company_id": string;
|
|
1119
|
+
"cik": string;
|
|
1120
|
+
"statement_type": string;
|
|
1121
|
+
"statement_date": string;
|
|
1122
|
+
"fiscal_year": number;
|
|
1123
|
+
"fiscal_period": string;
|
|
1124
|
+
"metric_code": string;
|
|
1125
|
+
"canonical_metric_code"?: (string | null);
|
|
1126
|
+
"unit": string;
|
|
1127
|
+
"value": string;
|
|
1128
|
+
"period_start"?: (string | null);
|
|
1129
|
+
"period_end"?: (string | null);
|
|
1130
|
+
"dimension_type": string;
|
|
1131
|
+
"axis_qname": string;
|
|
1132
|
+
"member_qname": string;
|
|
1133
|
+
"axis_label": string;
|
|
1134
|
+
"member_label": string;
|
|
1135
|
+
"dimension_key": string;
|
|
1136
|
+
};
|
|
1137
|
+
export type MetricDimensionPage = {
|
|
1138
|
+
"page": number;
|
|
1139
|
+
"page_size": number;
|
|
1140
|
+
"total": number;
|
|
1141
|
+
"items": Array<MetricDimensionHTTP>;
|
|
1142
|
+
};
|
|
1143
|
+
/** Supported disclosure dimension types. */
|
|
1144
|
+
export type MetricDimensionType = "SEGMENT" | "GEOGRAPHY";
|
|
1145
|
+
export type MetricDriftEnvelope = {
|
|
1146
|
+
"data": MetricDriftHTTP;
|
|
1147
|
+
};
|
|
1148
|
+
/** HTTP schema for metric drift analytics. */
|
|
1149
|
+
export type MetricDriftHTTP = {
|
|
1150
|
+
"metric": string;
|
|
1151
|
+
"original_value"?: (string | null);
|
|
1152
|
+
"latest_value"?: (string | null);
|
|
1153
|
+
"drift"?: (string | null);
|
|
1154
|
+
"drift_percent"?: (string | null);
|
|
1155
|
+
};
|
|
1156
|
+
/** Why a modeling metric could not be computed for one period. */
|
|
1157
|
+
export type MetricNullReason = "NOT_REPORTED" | "NOT_ON_STATEMENT" | "MISSING_INPUT" | "DENOMINATOR_ZERO" | "NON_POSITIVE_VALUE" | "NO_COMPARABLE_PERIOD" | "NOT_APPLICABLE_TO_PERIOD" | "INCOMPLETE_TRAILING_YEAR" | "NOT_YET_COMPUTED" | "INPUTS_INCONSISTENT";
|
|
1158
|
+
/** HTTP schema for one override event in a metric audit chain. */
|
|
1159
|
+
export type MetricOverrideAuditHTTP = {
|
|
1160
|
+
"applied_at": string;
|
|
1161
|
+
"reason"?: (string | null);
|
|
1162
|
+
"source"?: (string | null);
|
|
1163
|
+
"prior_value_hash"?: (string | null);
|
|
1164
|
+
"new_value_hash"?: (string | null);
|
|
1165
|
+
};
|
|
1166
|
+
/** HTTP schema for per-metric provenance metadata. */
|
|
1167
|
+
export type MetricProvenanceHTTP = {
|
|
1168
|
+
"filing_accession"?: (string | null);
|
|
1169
|
+
"xbrl_concept"?: (string | null);
|
|
1170
|
+
"mapping_type"?: ("DIRECT" | "FALLBACK" | "CALCULATED" | "INFERRED" | "UNKNOWN" | null);
|
|
1171
|
+
"override_applied": boolean;
|
|
1172
|
+
"override_reason"?: (string | null);
|
|
1173
|
+
};
|
|
1174
|
+
/** HTTP schema for one normalized metric time-series point. */
|
|
1175
|
+
export type MetricTimeSeriesPointHTTP = {
|
|
1176
|
+
"cik": string;
|
|
1177
|
+
"metric": string;
|
|
1178
|
+
"value": string;
|
|
1179
|
+
"unit": string;
|
|
1180
|
+
"period_start"?: (string | null);
|
|
1181
|
+
"period_end": string;
|
|
1182
|
+
"fiscal_year": number;
|
|
1183
|
+
"fiscal_period": FiscalPeriod;
|
|
1184
|
+
"statement_type": StatementType;
|
|
1185
|
+
"filing_accession": string;
|
|
1186
|
+
"filing_type": string;
|
|
1187
|
+
"filing_date": string;
|
|
1188
|
+
"accepted_at"?: (string | null);
|
|
1189
|
+
"is_restated": boolean;
|
|
1190
|
+
"source_line_item"?: (string | null);
|
|
1191
|
+
"provenance"?: (MetricProvenanceHTTP | null);
|
|
1192
|
+
};
|
|
1193
|
+
/** HTTP schema for a single metric view (bundle) definition. */
|
|
1194
|
+
export type MetricViewHTTP = {
|
|
1195
|
+
"code": string;
|
|
1196
|
+
"label": string;
|
|
1197
|
+
"description": string;
|
|
1198
|
+
"metrics": Array<string>;
|
|
1199
|
+
"market_data_required": boolean;
|
|
1200
|
+
"requires_external_market_inputs": boolean;
|
|
1201
|
+
"allowed_on_edgar_only_surfaces": boolean;
|
|
1202
|
+
};
|
|
1203
|
+
export type MetricViewsCatalogEnvelope = {
|
|
1204
|
+
"data": MetricViewsCatalogHTTP;
|
|
1205
|
+
};
|
|
1206
|
+
/** HTTP schema for the catalog of registered metric views. */
|
|
1207
|
+
export type MetricViewsCatalogHTTP = {
|
|
1208
|
+
"views"?: Array<MetricViewHTTP>;
|
|
1209
|
+
};
|
|
1210
|
+
/** HTTP schema for a modeling growth row. */
|
|
1211
|
+
export type ModelGrowthHTTP = {
|
|
1212
|
+
"company_id": string;
|
|
1213
|
+
"cik": string;
|
|
1214
|
+
"statement_type": StatementType;
|
|
1215
|
+
"accounting_standard": AccountingStandard;
|
|
1216
|
+
"statement_date": string;
|
|
1217
|
+
"fiscal_year": number;
|
|
1218
|
+
"fiscal_period": FiscalPeriod;
|
|
1219
|
+
"currency": string;
|
|
1220
|
+
"as_of_timestamp": string;
|
|
1221
|
+
"snapshot_hash": string;
|
|
1222
|
+
"cagr_years": number;
|
|
1223
|
+
"metrics"?: Record<string, string>;
|
|
1224
|
+
"dq": DQSummaryHTTP;
|
|
1225
|
+
"unavailable_metrics"?: Array<UnavailableMetricHTTP>;
|
|
1226
|
+
"reconciliation": ReconciliationSummaryHTTP;
|
|
1227
|
+
};
|
|
1228
|
+
export type ModelGrowthPage = {
|
|
1229
|
+
"page": number;
|
|
1230
|
+
"page_size": number;
|
|
1231
|
+
"total": number;
|
|
1232
|
+
"items": Array<ModelGrowthHTTP>;
|
|
1233
|
+
};
|
|
1234
|
+
export type ModelImpactEnvelope = {
|
|
1235
|
+
"data": ModelImpactHTTP;
|
|
1236
|
+
};
|
|
1237
|
+
/** HTTP schema for model-aware analytics. */
|
|
1238
|
+
export type ModelImpactHTTP = {
|
|
1239
|
+
"implied_fcf_yield"?: (string | null);
|
|
1240
|
+
"implied_margin"?: (string | null);
|
|
1241
|
+
"implied_revenue_growth"?: (string | null);
|
|
1242
|
+
"model_input_delta"?: (string | null);
|
|
1243
|
+
"model_output_delta"?: (string | null);
|
|
1244
|
+
"market_input_used": boolean;
|
|
1245
|
+
"market_input_fields"?: Array<string>;
|
|
1246
|
+
"market_input_source"?: (string | null);
|
|
1247
|
+
};
|
|
1248
|
+
/** HTTP schema for multi-year valuation inputs. */
|
|
1249
|
+
export type ModelMultiYearHTTP = {
|
|
1250
|
+
"company_id": string;
|
|
1251
|
+
"cik": string;
|
|
1252
|
+
"statement_type": StatementType;
|
|
1253
|
+
"accounting_standard": AccountingStandard;
|
|
1254
|
+
"statement_date": string;
|
|
1255
|
+
"fiscal_year": number;
|
|
1256
|
+
"fiscal_period": FiscalPeriod;
|
|
1257
|
+
"currency": string;
|
|
1258
|
+
"as_of_timestamp": string;
|
|
1259
|
+
"snapshot_hash": string;
|
|
1260
|
+
"dimension_key": string;
|
|
1261
|
+
"valuation_inputs": ValuationInputsHTTP;
|
|
1262
|
+
"dq": DQSummaryHTTP;
|
|
1263
|
+
"unavailable_metrics"?: Array<UnavailableMetricHTTP>;
|
|
1264
|
+
"reconciliation": ReconciliationSummaryHTTP;
|
|
1265
|
+
};
|
|
1266
|
+
export type ModelMultiYearPage = {
|
|
1267
|
+
"page": number;
|
|
1268
|
+
"page_size": number;
|
|
1269
|
+
"total": number;
|
|
1270
|
+
"items": Array<ModelMultiYearHTTP>;
|
|
1271
|
+
};
|
|
1272
|
+
/** HTTP schema for a modeling period row. */
|
|
1273
|
+
export type ModelPeriodHTTP = {
|
|
1274
|
+
"company_id": string;
|
|
1275
|
+
"cik": string;
|
|
1276
|
+
"statement_type": StatementType;
|
|
1277
|
+
"accounting_standard": AccountingStandard;
|
|
1278
|
+
"statement_date": string;
|
|
1279
|
+
"fiscal_year": number;
|
|
1280
|
+
"fiscal_period": FiscalPeriod;
|
|
1281
|
+
"currency": string;
|
|
1282
|
+
"accession_id"?: (string | null);
|
|
1283
|
+
"as_of_timestamp": string;
|
|
1284
|
+
"snapshot_hash": string;
|
|
1285
|
+
"dimension_key": string;
|
|
1286
|
+
"metrics"?: Record<string, string>;
|
|
1287
|
+
"dq": DQSummaryHTTP;
|
|
1288
|
+
"reconciliation": ReconciliationSummaryHTTP;
|
|
1289
|
+
};
|
|
1290
|
+
export type ModelPeriodPage = {
|
|
1291
|
+
"page": number;
|
|
1292
|
+
"page_size": number;
|
|
1293
|
+
"total": number;
|
|
1294
|
+
"items": Array<ModelPeriodHTTP>;
|
|
1295
|
+
};
|
|
1296
|
+
/** HTTP schema for a modeling ratios row. */
|
|
1297
|
+
export type ModelRatiosHTTP = {
|
|
1298
|
+
"company_id": string;
|
|
1299
|
+
"cik": string;
|
|
1300
|
+
"statement_type": StatementType;
|
|
1301
|
+
"accounting_standard": AccountingStandard;
|
|
1302
|
+
"statement_date": string;
|
|
1303
|
+
"fiscal_year": number;
|
|
1304
|
+
"fiscal_period": FiscalPeriod;
|
|
1305
|
+
"currency": string;
|
|
1306
|
+
"as_of_timestamp": string;
|
|
1307
|
+
"snapshot_hash": string;
|
|
1308
|
+
"metrics"?: Record<string, string>;
|
|
1309
|
+
"dq": DQSummaryHTTP;
|
|
1310
|
+
"unavailable_metrics"?: Array<UnavailableMetricHTTP>;
|
|
1311
|
+
"reconciliation": ReconciliationSummaryHTTP;
|
|
1312
|
+
};
|
|
1313
|
+
export type ModelRatiosPage = {
|
|
1314
|
+
"page": number;
|
|
1315
|
+
"page_size": number;
|
|
1316
|
+
"total": number;
|
|
1317
|
+
"items": Array<ModelRatiosHTTP>;
|
|
1318
|
+
};
|
|
1319
|
+
/** HTTP schema for a modeling TTM row. */
|
|
1320
|
+
export type ModelTTMHTTP = {
|
|
1321
|
+
"company_id": string;
|
|
1322
|
+
"cik": string;
|
|
1323
|
+
"statement_type": StatementType;
|
|
1324
|
+
"accounting_standard": AccountingStandard;
|
|
1325
|
+
"statement_date": string;
|
|
1326
|
+
"fiscal_year": number;
|
|
1327
|
+
"fiscal_period": FiscalPeriod;
|
|
1328
|
+
"currency": string;
|
|
1329
|
+
"as_of_timestamp": string;
|
|
1330
|
+
"snapshot_hash": string;
|
|
1331
|
+
"ttm_window_start": string;
|
|
1332
|
+
"ttm_window_end": string;
|
|
1333
|
+
"metrics"?: Record<string, string>;
|
|
1334
|
+
"dq": DQSummaryHTTP;
|
|
1335
|
+
"unavailable_metrics"?: Array<UnavailableMetricHTTP>;
|
|
1336
|
+
"reconciliation": ReconciliationSummaryHTTP;
|
|
1337
|
+
};
|
|
1338
|
+
export type ModelTTMPage = {
|
|
1339
|
+
"page": number;
|
|
1340
|
+
"page_size": number;
|
|
1341
|
+
"total": number;
|
|
1342
|
+
"items": Array<ModelTTMHTTP>;
|
|
1343
|
+
};
|
|
1344
|
+
/** HTTP schema for narrative citations. */
|
|
1345
|
+
export type NarrativeCitationHTTP = {
|
|
1346
|
+
"metric_code": string;
|
|
1347
|
+
"period": string;
|
|
1348
|
+
"value": string;
|
|
1349
|
+
"comparison"?: (string | null);
|
|
1350
|
+
};
|
|
1351
|
+
/** A plain-language narrative of how a company's figures moved, with its citations. */
|
|
1352
|
+
export type NarrativeHTTP = {
|
|
1353
|
+
"company_id": string;
|
|
1354
|
+
"cik": string;
|
|
1355
|
+
"as_of_timestamp": string;
|
|
1356
|
+
"narrative_type": NarrativeType;
|
|
1357
|
+
"window_label": string;
|
|
1358
|
+
"input_hash": string;
|
|
1359
|
+
"narrative_text": string;
|
|
1360
|
+
"citations": Array<NarrativeCitationHTTP>;
|
|
1361
|
+
"created_at": string;
|
|
1362
|
+
};
|
|
1363
|
+
export type NarrativePage = {
|
|
1364
|
+
"page": number;
|
|
1365
|
+
"page_size": number;
|
|
1366
|
+
"total": number;
|
|
1367
|
+
"items": Array<NarrativeHTTP>;
|
|
1368
|
+
};
|
|
1369
|
+
/** Supported narrative variants for AI explanations. */
|
|
1370
|
+
export type NarrativeType = "CHANGE_SUMMARY" | "MARGINS_MOVE" | "ROIC_CHANGE";
|
|
1371
|
+
/** HTTP schema for a single normalized fact. */
|
|
1372
|
+
export type NormalizedFactHTTP = {
|
|
1373
|
+
"metric": string;
|
|
1374
|
+
"label"?: (string | null);
|
|
1375
|
+
"unit": string;
|
|
1376
|
+
"period_start": string;
|
|
1377
|
+
"period_end": string;
|
|
1378
|
+
"value": string;
|
|
1379
|
+
"dimension"?: (Record<string, string> | null);
|
|
1380
|
+
"dimension_key": string;
|
|
1381
|
+
"source_line_item"?: (string | null);
|
|
1382
|
+
"value_origin"?: string;
|
|
1383
|
+
"correction_rule"?: (string | null);
|
|
1384
|
+
"as_filed_value"?: (string | null);
|
|
1385
|
+
"as_filed_concept"?: (string | null);
|
|
1386
|
+
"split_adjusted_value"?: (string | null);
|
|
1387
|
+
"split_adjustment_factor"?: (string | null);
|
|
1388
|
+
"period_origin"?: string;
|
|
1389
|
+
"usd"?: (UsdValueHTTP | null);
|
|
1390
|
+
};
|
|
1391
|
+
/** HTTP schema for a normalized EDGAR statement. */
|
|
1392
|
+
export type NormalizedStatementHTTP = {
|
|
1393
|
+
"statement_type": StatementType;
|
|
1394
|
+
"accounting_standard": AccountingStandard;
|
|
1395
|
+
"statement_date"?: (string | null);
|
|
1396
|
+
"fiscal_year"?: (number | null);
|
|
1397
|
+
"fiscal_period"?: (FiscalPeriod | null);
|
|
1398
|
+
"period_start"?: (string | null);
|
|
1399
|
+
"reporting_entity"?: "REGISTRANT" | "PREDECESSOR";
|
|
1400
|
+
"currency"?: (string | null);
|
|
1401
|
+
"cik"?: (string | null);
|
|
1402
|
+
"unit_multiplier"?: number;
|
|
1403
|
+
"source_accession_id"?: (string | null);
|
|
1404
|
+
"_meta"?: (StatementMetricMetaHTTP | null);
|
|
1405
|
+
"facts"?: Array<NormalizedFactHTTP>;
|
|
1406
|
+
};
|
|
1407
|
+
export type NormalizedStatementViewEnvelope = {
|
|
1408
|
+
"data": NormalizedStatementViewHTTP;
|
|
1409
|
+
};
|
|
1410
|
+
/** A statement as the latest filing reports it, with each filing's version of it. */
|
|
1411
|
+
export type NormalizedStatementViewHTTP = {
|
|
1412
|
+
"latest": EdgarStatementHTTP;
|
|
1413
|
+
"version_history"?: Array<EdgarStatementHTTP>;
|
|
1414
|
+
"periods"?: Array<EdgarStatementHTTP>;
|
|
1415
|
+
"availability"?: (EndpointAvailabilityHTTP | null);
|
|
1416
|
+
};
|
|
1417
|
+
/** One mapping override rule and how it applied to the statement. */
|
|
1418
|
+
export type OverrideRuleApplicationHTTP = {
|
|
1419
|
+
"rule_id": string;
|
|
1420
|
+
"scope": string;
|
|
1421
|
+
"priority": number;
|
|
1422
|
+
"action": string;
|
|
1423
|
+
"source_concept"?: (string | null);
|
|
1424
|
+
"target_metric_code"?: (string | null);
|
|
1425
|
+
"target_dimension_key"?: (string | null);
|
|
1426
|
+
"is_effective": boolean;
|
|
1427
|
+
"reason"?: (string | null);
|
|
1428
|
+
"contributes_to_metrics": boolean;
|
|
1429
|
+
};
|
|
1430
|
+
/** Paginated success envelope. */
|
|
1431
|
+
export type PaginatedEnvelope = {
|
|
1432
|
+
"page": number;
|
|
1433
|
+
"page_size": number;
|
|
1434
|
+
"total": number;
|
|
1435
|
+
"items": Array<unknown>;
|
|
1436
|
+
};
|
|
1437
|
+
/** Paginated fundamentals time-series envelope with availability metadata. */
|
|
1438
|
+
export type PaginatedEnvelopeFundamentalsTimeSeriesHTTP = {
|
|
1439
|
+
"page": number;
|
|
1440
|
+
"page_size": number;
|
|
1441
|
+
"total": number;
|
|
1442
|
+
"items": Array<FundamentalsTimeSeriesPointHTTP>;
|
|
1443
|
+
"availability"?: (EndpointAvailabilityHTTP | null);
|
|
1444
|
+
};
|
|
1445
|
+
/** Paginated metric time-series envelope with availability metadata. */
|
|
1446
|
+
export type PaginatedEnvelopeMetricTimeSeriesHTTP = {
|
|
1447
|
+
"page": number;
|
|
1448
|
+
"page_size": number;
|
|
1449
|
+
"total": number;
|
|
1450
|
+
"items": Array<MetricTimeSeriesPointHTTP>;
|
|
1451
|
+
"availability"?: (EndpointAvailabilityHTTP | null);
|
|
1452
|
+
};
|
|
1453
|
+
/** HTTP schema for a peer similarity entry. */
|
|
1454
|
+
export type PeerHTTP = {
|
|
1455
|
+
"peer_company_id": string;
|
|
1456
|
+
"similarity_score": string;
|
|
1457
|
+
"rank": number;
|
|
1458
|
+
};
|
|
1459
|
+
/** HTTP schema for a peer set. */
|
|
1460
|
+
export type PeerSetHTTP = {
|
|
1461
|
+
"company_id": string;
|
|
1462
|
+
"cik": string;
|
|
1463
|
+
"as_of_timestamp": string;
|
|
1464
|
+
"embedding_type": EmbeddingType;
|
|
1465
|
+
"embedding_mode": EmbeddingMode;
|
|
1466
|
+
"industry_code"?: (string | null);
|
|
1467
|
+
"peers": Array<PeerHTTP>;
|
|
1468
|
+
};
|
|
1469
|
+
export type PeerSetPage = {
|
|
1470
|
+
"page": number;
|
|
1471
|
+
"page_size": number;
|
|
1472
|
+
"total": number;
|
|
1473
|
+
"items": Array<PeerSetHTTP>;
|
|
1474
|
+
};
|
|
1475
|
+
/** Outcome of one group of reconciliation rules on the statement. */
|
|
1476
|
+
export type QualityCheckGroupHTTP = {
|
|
1477
|
+
"passed_count": number;
|
|
1478
|
+
"failed_count": number;
|
|
1479
|
+
"skipped_count": number;
|
|
1480
|
+
"pass_rate": (string | null);
|
|
1481
|
+
"failed_rules"?: Array<QualityFailedCheckHTTP>;
|
|
1482
|
+
"skipped_rules"?: Array<QualitySkippedCheckHTTP>;
|
|
1483
|
+
};
|
|
1484
|
+
/** One reconciliation rule the statement failed. */
|
|
1485
|
+
export type QualityFailedCheckHTTP = {
|
|
1486
|
+
"rule_id": string;
|
|
1487
|
+
"severity": MaterialityClass;
|
|
1488
|
+
"expected_value"?: (string | null);
|
|
1489
|
+
"actual_value"?: (string | null);
|
|
1490
|
+
"delta"?: (string | null);
|
|
1491
|
+
"tolerance"?: (string | null);
|
|
1492
|
+
};
|
|
1493
|
+
/** One reconciliation rule that could not be checked, and why. */
|
|
1494
|
+
export type QualitySkippedCheckHTTP = {
|
|
1495
|
+
"rule_id": string;
|
|
1496
|
+
"reason"?: (string | null);
|
|
1497
|
+
};
|
|
1498
|
+
/** HTTP request body for deterministic query execution. */
|
|
1499
|
+
export type QueryExecuteRequestHTTP = {
|
|
1500
|
+
"query_type": string;
|
|
1501
|
+
"parameters"?: Record<string, unknown>;
|
|
1502
|
+
"as_of_date"?: (string | null);
|
|
1503
|
+
"include_result"?: boolean;
|
|
1504
|
+
};
|
|
1505
|
+
export type QueryExecuteResponseEnvelope = {
|
|
1506
|
+
"data": QueryExecuteResponseHTTP;
|
|
1507
|
+
};
|
|
1508
|
+
/** HTTP response for deterministic query execution. */
|
|
1509
|
+
export type QueryExecuteResponseHTTP = {
|
|
1510
|
+
"manifest": QueryManifestHTTP;
|
|
1511
|
+
"result"?: (Record<string, unknown> | null);
|
|
1512
|
+
};
|
|
1513
|
+
/** The manifest of one deterministic query: its identity, inputs and result hashes. */
|
|
1514
|
+
export type QueryManifestHTTP = {
|
|
1515
|
+
"replay_token": string;
|
|
1516
|
+
"query_type": string;
|
|
1517
|
+
"query_hash": string;
|
|
1518
|
+
"input_hash": string;
|
|
1519
|
+
"result_hash": string;
|
|
1520
|
+
"as_of_date"?: (string | null);
|
|
1521
|
+
"snapshot_hashes"?: Array<string>;
|
|
1522
|
+
"created_at": string;
|
|
1523
|
+
"parameters"?: Record<string, unknown>;
|
|
1524
|
+
"status": string;
|
|
1525
|
+
};
|
|
1526
|
+
export type QueryReplayResponseEnvelope = {
|
|
1527
|
+
"data": QueryReplayResponseHTTP;
|
|
1528
|
+
};
|
|
1529
|
+
/** HTTP response for a replayed query: its original result plus a fresh re-verification. */
|
|
1530
|
+
export type QueryReplayResponseHTTP = {
|
|
1531
|
+
"replay_mode": string;
|
|
1532
|
+
"manifest": QueryManifestHTTP;
|
|
1533
|
+
"stored_result_available": boolean;
|
|
1534
|
+
"result"?: (Record<string, unknown> | null);
|
|
1535
|
+
"recomputed_result"?: (Record<string, unknown> | null);
|
|
1536
|
+
"recomputed_result_hash"?: (string | null);
|
|
1537
|
+
"matches_original_result"?: (boolean | null);
|
|
1538
|
+
"data_hash"?: (string | null);
|
|
1539
|
+
"recomputed_data_hash"?: (string | null);
|
|
1540
|
+
};
|
|
1541
|
+
export type QueryVerificationEnvelope = {
|
|
1542
|
+
"data": QueryVerificationHTTP;
|
|
1543
|
+
};
|
|
1544
|
+
/** Whether re-running a replay token's query today returns the same data. */
|
|
1545
|
+
export type QueryVerificationHTTP = {
|
|
1546
|
+
"replay_token": string;
|
|
1547
|
+
"verdict": "MATCHES" | "DOES_NOT_MATCH" | "NOT_RECOMPUTED";
|
|
1548
|
+
"matches_original_result"?: (boolean | null);
|
|
1549
|
+
"query_type": string;
|
|
1550
|
+
"parameters"?: Record<string, unknown>;
|
|
1551
|
+
"as_of_date"?: (string | null);
|
|
1552
|
+
"created_at": string;
|
|
1553
|
+
"result_hash": string;
|
|
1554
|
+
"recomputed_result_hash"?: (string | null);
|
|
1555
|
+
"data_hash"?: (string | null);
|
|
1556
|
+
"recomputed_data_hash"?: (string | null);
|
|
1557
|
+
"accessions"?: Array<string>;
|
|
1558
|
+
"verified_at": string;
|
|
1559
|
+
};
|
|
1560
|
+
/** Aggregated readiness response. */
|
|
1561
|
+
export type ReadinessResponse = {
|
|
1562
|
+
"status": HealthState;
|
|
1563
|
+
"checks"?: Array<CheckResult>;
|
|
1564
|
+
};
|
|
1565
|
+
/** HTTP schema for one inflation-adjusted EDGAR metric point. */
|
|
1566
|
+
export type RealFundamentalMetricPointHTTP = {
|
|
1567
|
+
"cik": string;
|
|
1568
|
+
"metric": string;
|
|
1569
|
+
"statement_date": string;
|
|
1570
|
+
"fiscal_year": number;
|
|
1571
|
+
"fiscal_period": string;
|
|
1572
|
+
"nominal_value": string;
|
|
1573
|
+
"real_value"?: (string | null);
|
|
1574
|
+
"cpi_observation_date"?: (string | null);
|
|
1575
|
+
"cpi_value"?: (string | null);
|
|
1576
|
+
"base_cpi_value": string;
|
|
1577
|
+
"source_provider": string;
|
|
1578
|
+
"source_series_id": string;
|
|
1579
|
+
"realtime_start"?: (string | null);
|
|
1580
|
+
"realtime_end"?: (string | null);
|
|
1581
|
+
"vintage_date"?: (string | null);
|
|
1582
|
+
"retrieved_at"?: (string | null);
|
|
1583
|
+
"source_hash"?: (string | null);
|
|
1584
|
+
"filing_accession"?: (string | null);
|
|
1585
|
+
"snapshot_hash"?: (string | null);
|
|
1586
|
+
};
|
|
1587
|
+
export type RealFundamentalMetricSeriesEnvelope = {
|
|
1588
|
+
"data": RealFundamentalMetricSeriesHTTP;
|
|
1589
|
+
};
|
|
1590
|
+
/** HTTP schema for an inflation-adjusted EDGAR metric series. */
|
|
1591
|
+
export type RealFundamentalMetricSeriesHTTP = {
|
|
1592
|
+
"cik": string;
|
|
1593
|
+
"metric": string;
|
|
1594
|
+
"base_year": number;
|
|
1595
|
+
"cpi_series": string;
|
|
1596
|
+
"points"?: Array<RealFundamentalMetricPointHTTP>;
|
|
1597
|
+
};
|
|
1598
|
+
/** Reconciliation metadata container. */
|
|
1599
|
+
export type ReconciliationMetaHTTP = {
|
|
1600
|
+
"identity": IdentitySummaryHTTP;
|
|
1601
|
+
"rollforward": RollforwardSummaryHTTP;
|
|
1602
|
+
"cross_statement": RollforwardSummaryHTTP;
|
|
1603
|
+
"reconciliation_supported_rules_count": number;
|
|
1604
|
+
"reconciliation_total_rules_count": number;
|
|
1605
|
+
"reconciliation_skipped_rules_count": number;
|
|
1606
|
+
};
|
|
1607
|
+
/** Single reconciliation rule evaluation result in HTTP form. */
|
|
1608
|
+
export type ReconciliationResultHTTP = {
|
|
1609
|
+
"cik": string;
|
|
1610
|
+
"statement_type": string;
|
|
1611
|
+
"fiscal_year": number;
|
|
1612
|
+
"fiscal_period": string;
|
|
1613
|
+
"accession_id"?: (string | null);
|
|
1614
|
+
"rule_id": string;
|
|
1615
|
+
"rule_category": ReconciliationRuleCategory;
|
|
1616
|
+
"status": ReconciliationStatus;
|
|
1617
|
+
"severity": string;
|
|
1618
|
+
"expected_value"?: (string | null);
|
|
1619
|
+
"actual_value"?: (string | null);
|
|
1620
|
+
"delta"?: (string | null);
|
|
1621
|
+
"dimension_key"?: (string | null);
|
|
1622
|
+
"dimension_labels"?: (Record<string, string> | null);
|
|
1623
|
+
"notes"?: (Record<string, unknown> | null);
|
|
1624
|
+
};
|
|
1625
|
+
export type ReconciliationResultPage = {
|
|
1626
|
+
"page": number;
|
|
1627
|
+
"page_size": number;
|
|
1628
|
+
"total": number;
|
|
1629
|
+
"items": Array<ReconciliationResultHTTP>;
|
|
1630
|
+
};
|
|
1631
|
+
/** High-level reconciliation rule categories. */
|
|
1632
|
+
export type ReconciliationRuleCategory = "IDENTITY" | "ROLLFORWARD" | "FX" | "CALENDAR" | "SEGMENT";
|
|
1633
|
+
/** Outcome of a reconciliation rule evaluation. */
|
|
1634
|
+
export type ReconciliationStatus = "PASS" | "FAIL" | "SKIPPED";
|
|
1635
|
+
/** Aggregated PASS/FAIL/SKIPPED counts for a fiscal period and rule category. */
|
|
1636
|
+
export type ReconciliationSummaryBucketHTTP = {
|
|
1637
|
+
"fiscal_year": number;
|
|
1638
|
+
"fiscal_period": string;
|
|
1639
|
+
"accession_id": string;
|
|
1640
|
+
"statement_date"?: (string | null);
|
|
1641
|
+
"rule_category": ReconciliationRuleCategory;
|
|
1642
|
+
"pass_count": number;
|
|
1643
|
+
"fail_count": number;
|
|
1644
|
+
"skip_count": number;
|
|
1645
|
+
};
|
|
1646
|
+
export type ReconciliationSummaryBucketListEnvelope = {
|
|
1647
|
+
"data": Array<ReconciliationSummaryBucketHTTP>;
|
|
1648
|
+
};
|
|
1649
|
+
/** HTTP schema for a reconciliation summary block. */
|
|
1650
|
+
export type ReconciliationSummaryHTTP = {
|
|
1651
|
+
"reconciliation_max_severity"?: (MaterialityClass | null);
|
|
1652
|
+
"reconciliation_fail_count"?: number;
|
|
1653
|
+
};
|
|
1654
|
+
export type RestatementAlertEventEnvelope = {
|
|
1655
|
+
"data": RestatementAlertEventHTTP;
|
|
1656
|
+
};
|
|
1657
|
+
/** HTTP schema for one immutable restatement alert event. */
|
|
1658
|
+
export type RestatementAlertEventHTTP = {
|
|
1659
|
+
"restatement_alert_event_id": string;
|
|
1660
|
+
"company_id": string;
|
|
1661
|
+
"cik": string;
|
|
1662
|
+
"ticker"?: (string | null);
|
|
1663
|
+
"accession_id": string;
|
|
1664
|
+
"prior_accession_id"?: (string | null);
|
|
1665
|
+
"statement_type": StatementType;
|
|
1666
|
+
"statement_date": string;
|
|
1667
|
+
"fiscal_year": number;
|
|
1668
|
+
"fiscal_period": FiscalPeriod;
|
|
1669
|
+
"accepted_at": string;
|
|
1670
|
+
"facts_changed_count": number;
|
|
1671
|
+
"material_facts_count": number;
|
|
1672
|
+
"materiality_score": MaterialityClass;
|
|
1673
|
+
"change_class_counts"?: Record<string, number>;
|
|
1674
|
+
"summary_metrics"?: Array<RestatementAlertSummaryMetricHTTP>;
|
|
1675
|
+
"materiality_summary": string;
|
|
1676
|
+
"model_impacts"?: Array<RestatementModelImpactHTTP>;
|
|
1677
|
+
};
|
|
1678
|
+
export type RestatementAlertEventPage = {
|
|
1679
|
+
"page": number;
|
|
1680
|
+
"page_size": number;
|
|
1681
|
+
"total": number;
|
|
1682
|
+
"items": Array<RestatementAlertEventHTTP>;
|
|
1683
|
+
};
|
|
1684
|
+
/** HTTP schema for a compact changed-metric summary. */
|
|
1685
|
+
export type RestatementAlertSummaryMetricHTTP = {
|
|
1686
|
+
"metric_code": string;
|
|
1687
|
+
"change_type": "NEW_DISCLOSURE" | "REMOVED_DISCLOSURE" | "VALUE_REVISION" | "RECLASSIFICATION" | "PERIOD_CORRECTION" | "CONCEPT_CHANGE" | "PRESENTATION_ONLY";
|
|
1688
|
+
"old_value"?: (string | null);
|
|
1689
|
+
"new_value"?: (string | null);
|
|
1690
|
+
"delta_value"?: (string | null);
|
|
1691
|
+
};
|
|
1692
|
+
/** HTTP schema for a restatement delta between two filings of one statement. */
|
|
1693
|
+
export type RestatementDeltaHTTP = {
|
|
1694
|
+
"cik": string;
|
|
1695
|
+
"statement_type": StatementType;
|
|
1696
|
+
"fiscal_year": number;
|
|
1697
|
+
"fiscal_period": FiscalPeriod;
|
|
1698
|
+
"from_version": RestatementDeltaVersionHTTP;
|
|
1699
|
+
"to_version": RestatementDeltaVersionHTTP;
|
|
1700
|
+
"summary": RestatementSummaryHTTP;
|
|
1701
|
+
"deltas"?: Array<RestatementMetricDeltaHTTP>;
|
|
1702
|
+
"metrics_only_in_from"?: Array<string>;
|
|
1703
|
+
"metrics_only_in_to"?: Array<string>;
|
|
1704
|
+
"comparability_warning"?: boolean;
|
|
1705
|
+
};
|
|
1706
|
+
/** Success envelope for restatement delta responses. */
|
|
1707
|
+
export type RestatementDeltaSuccessEnvelope = {
|
|
1708
|
+
"data": RestatementDeltaHTTP;
|
|
1709
|
+
};
|
|
1710
|
+
/** HTTP schema for one end of a restatement delta. */
|
|
1711
|
+
export type RestatementDeltaVersionHTTP = {
|
|
1712
|
+
"accession_id": string;
|
|
1713
|
+
"form_type": string;
|
|
1714
|
+
"accepted_at"?: (string | null);
|
|
1715
|
+
};
|
|
1716
|
+
/** HTTP schema for a single hop in a restatement ledger. */
|
|
1717
|
+
export type RestatementLedgerEntryHTTP = {
|
|
1718
|
+
"cik": string;
|
|
1719
|
+
"statement_type": StatementType;
|
|
1720
|
+
"fiscal_year": number;
|
|
1721
|
+
"fiscal_period": FiscalPeriod;
|
|
1722
|
+
"from_version": RestatementDeltaVersionHTTP;
|
|
1723
|
+
"to_version": RestatementDeltaVersionHTTP;
|
|
1724
|
+
"summary": RestatementSummaryHTTP;
|
|
1725
|
+
"deltas"?: Array<RestatementMetricDeltaHTTP>;
|
|
1726
|
+
};
|
|
1727
|
+
export type RestatementLedgerEnvelope = {
|
|
1728
|
+
"data": RestatementLedgerHTTP;
|
|
1729
|
+
};
|
|
1730
|
+
/** HTTP schema for a restatement ledger over the filings of one statement. */
|
|
1731
|
+
export type RestatementLedgerHTTP = {
|
|
1732
|
+
"cik": string;
|
|
1733
|
+
"statement_type": StatementType;
|
|
1734
|
+
"fiscal_year": number;
|
|
1735
|
+
"fiscal_period": FiscalPeriod;
|
|
1736
|
+
"total_hops": number;
|
|
1737
|
+
"entries"?: Array<RestatementLedgerEntryHTTP>;
|
|
1738
|
+
};
|
|
1739
|
+
/** HTTP schema for a single restatement metric delta. */
|
|
1740
|
+
export type RestatementMetricDeltaHTTP = {
|
|
1741
|
+
"metric": string;
|
|
1742
|
+
"old_value"?: (string | null);
|
|
1743
|
+
"new_value"?: (string | null);
|
|
1744
|
+
"diff"?: (string | null);
|
|
1745
|
+
};
|
|
1746
|
+
export type RestatementMetricTimelineEnvelope = {
|
|
1747
|
+
"data": RestatementMetricTimelineHTTP;
|
|
1748
|
+
};
|
|
1749
|
+
/** HTTP schema for a restatement metric timeline. */
|
|
1750
|
+
export type RestatementMetricTimelineHTTP = {
|
|
1751
|
+
"cik": string;
|
|
1752
|
+
"statement_type": StatementType;
|
|
1753
|
+
"fiscal_year": number;
|
|
1754
|
+
"fiscal_period": FiscalPeriod;
|
|
1755
|
+
"by_metric": Record<string, Array<Array<string>>>;
|
|
1756
|
+
"restatement_frequency": Record<string, number>;
|
|
1757
|
+
"per_metric_max_delta": Record<string, string>;
|
|
1758
|
+
"first_filed_source"?: (FirstFiledSourceHTTP | null);
|
|
1759
|
+
"total_hops": number;
|
|
1760
|
+
"timeline_severity": string;
|
|
1761
|
+
};
|
|
1762
|
+
/** HTTP schema for a compact derived model-impact summary. */
|
|
1763
|
+
export type RestatementModelImpactHTTP = {
|
|
1764
|
+
"impact_code": string;
|
|
1765
|
+
"previous_value": string;
|
|
1766
|
+
"current_value": string;
|
|
1767
|
+
"delta_value": string;
|
|
1768
|
+
};
|
|
1769
|
+
/** HTTP schema for a high-level restatement summary. */
|
|
1770
|
+
export type RestatementSummaryHTTP = {
|
|
1771
|
+
"total_metrics_compared": number;
|
|
1772
|
+
"total_metrics_changed": number;
|
|
1773
|
+
"has_material_change": boolean;
|
|
1774
|
+
};
|
|
1775
|
+
/** Failed rollforward rule summary item. */
|
|
1776
|
+
export type RollforwardFailedRuleHTTP = {
|
|
1777
|
+
"rule_name": string;
|
|
1778
|
+
"delta"?: (string | null);
|
|
1779
|
+
};
|
|
1780
|
+
/** Evidence-backed diagnostic for a skipped rollforward rule. */
|
|
1781
|
+
export type RollforwardSkippedRuleDiagnosticHTTP = {
|
|
1782
|
+
"rule_name": string;
|
|
1783
|
+
"reason": string;
|
|
1784
|
+
"scope_evidence"?: Record<string, string>;
|
|
1785
|
+
};
|
|
1786
|
+
/** Rollforward reconciliation summary metadata. */
|
|
1787
|
+
export type RollforwardSummaryHTTP = {
|
|
1788
|
+
"pass_rate": (string | null);
|
|
1789
|
+
"total_rules_count": number;
|
|
1790
|
+
"supported_rules_count": number;
|
|
1791
|
+
"skipped_rules_count": number;
|
|
1792
|
+
"failed_rules"?: Array<RollforwardFailedRuleHTTP>;
|
|
1793
|
+
"skipped_rules"?: Array<string>;
|
|
1794
|
+
"skipped_rule_diagnostics"?: Array<RollforwardSkippedRuleDiagnosticHTTP>;
|
|
1795
|
+
};
|
|
1796
|
+
export type SnapshotVerificationEnvelope = {
|
|
1797
|
+
"data": SnapshotVerificationHTTP;
|
|
1798
|
+
};
|
|
1799
|
+
/** Whether a snapshot hash names figures a company served. */
|
|
1800
|
+
export type SnapshotVerificationHTTP = {
|
|
1801
|
+
"snapshot_hash": string;
|
|
1802
|
+
"verdict": string;
|
|
1803
|
+
"cik"?: (string | null);
|
|
1804
|
+
"as_of_date"?: (string | null);
|
|
1805
|
+
"verified_at": string;
|
|
1806
|
+
};
|
|
1807
|
+
/** How many of its type's canonical metrics the statement serves. */
|
|
1808
|
+
export type StatementCompletenessQualityHTTP = {
|
|
1809
|
+
"metrics_expected": number;
|
|
1810
|
+
"metrics_populated": number;
|
|
1811
|
+
"completeness_ratio": string;
|
|
1812
|
+
"missing_metrics"?: Array<string>;
|
|
1813
|
+
"metrics_not_reported": number;
|
|
1814
|
+
"metrics_unresolved": number;
|
|
1815
|
+
"reported_completeness_ratio"?: (string | null);
|
|
1816
|
+
};
|
|
1817
|
+
export type StatementDQOverlayEnvelope = {
|
|
1818
|
+
"data": StatementDQOverlayHTTP;
|
|
1819
|
+
};
|
|
1820
|
+
/** A filing's statement with its data-quality findings. */
|
|
1821
|
+
export type StatementDQOverlayHTTP = {
|
|
1822
|
+
"cik": string;
|
|
1823
|
+
"statement_type": string;
|
|
1824
|
+
"fiscal_year": number;
|
|
1825
|
+
"fiscal_period": string;
|
|
1826
|
+
"accession_id": string;
|
|
1827
|
+
"accounting_standard": string;
|
|
1828
|
+
"statement_date": string;
|
|
1829
|
+
"currency": string;
|
|
1830
|
+
"max_severity"?: (MaterialityClass | null);
|
|
1831
|
+
"validation_confidence_score"?: (number | null);
|
|
1832
|
+
"confidence_status": "AVAILABLE" | "NOT_EVALUATED";
|
|
1833
|
+
"facts"?: Array<NormalizedFactHTTP>;
|
|
1834
|
+
"fact_quality"?: Array<FactQualityHTTP>;
|
|
1835
|
+
"anomalies"?: Array<DQAnomalyHTTP>;
|
|
1836
|
+
};
|
|
1837
|
+
/** The statement's data-quality findings. */
|
|
1838
|
+
export type StatementDataQualityHTTP = {
|
|
1839
|
+
"evaluated_rule_count": number;
|
|
1840
|
+
"passed_rule_count": number;
|
|
1841
|
+
"failed_rule_count": number;
|
|
1842
|
+
"total_rule_count": number;
|
|
1843
|
+
"not_evaluated_metric_count": number;
|
|
1844
|
+
"pass_rate": (string | null);
|
|
1845
|
+
"flags"?: Array<DataQualityFlagItemHTTP>;
|
|
1846
|
+
};
|
|
1847
|
+
/** How the statement's metrics were taken from the filing. */
|
|
1848
|
+
export type StatementMappingQualityHTTP = {
|
|
1849
|
+
"mapping_type_counts": Record<string, number>;
|
|
1850
|
+
"overridden_metrics"?: Array<string>;
|
|
1851
|
+
"corrected_metrics"?: Array<string>;
|
|
1852
|
+
"withheld_metrics"?: Array<string>;
|
|
1853
|
+
"metrics_from_other_filings"?: Array<string>;
|
|
1854
|
+
};
|
|
1855
|
+
export type StatementMetricAuditChainEnvelope = {
|
|
1856
|
+
"data": StatementMetricAuditChainHTTP;
|
|
1857
|
+
};
|
|
1858
|
+
/** HTTP schema for one filing statement's metric audit chain. */
|
|
1859
|
+
export type StatementMetricAuditChainHTTP = {
|
|
1860
|
+
"metric_name": string;
|
|
1861
|
+
"cik": string;
|
|
1862
|
+
"statement_type": StatementType;
|
|
1863
|
+
"fiscal_year": number;
|
|
1864
|
+
"fiscal_period": FiscalPeriod;
|
|
1865
|
+
"accession_id": string;
|
|
1866
|
+
"filing_accession"?: (string | null);
|
|
1867
|
+
"xbrl_concept"?: (string | null);
|
|
1868
|
+
"mapping_type"?: ("DIRECT" | "FALLBACK" | "CALCULATED" | "INFERRED" | "UNKNOWN" | null);
|
|
1869
|
+
"overrides"?: Array<MetricOverrideAuditHTTP>;
|
|
1870
|
+
"steps"?: Array<StatementMetricAuditStepHTTP>;
|
|
1871
|
+
};
|
|
1872
|
+
/** HTTP schema for one link in a metric's audit chain. */
|
|
1873
|
+
export type StatementMetricAuditStepHTTP = {
|
|
1874
|
+
"step": "SOURCE_FACT" | "CALCULATION" | "MAPPING" | "OVERRIDE" | "SERVED_VALUE";
|
|
1875
|
+
"xbrl_concept"?: (string | null);
|
|
1876
|
+
"filing_accession"?: (string | null);
|
|
1877
|
+
"calculation_steps"?: (Array<string> | null);
|
|
1878
|
+
"mapping_type"?: ("DIRECT" | "FALLBACK" | "CALCULATED" | "INFERRED" | "UNKNOWN" | null);
|
|
1879
|
+
"applied_at"?: (string | null);
|
|
1880
|
+
"reason"?: (string | null);
|
|
1881
|
+
"value"?: (string | null);
|
|
1882
|
+
};
|
|
1883
|
+
/** HTTP schema for statement-level metric metadata. */
|
|
1884
|
+
export type StatementMetricMetaHTTP = {
|
|
1885
|
+
"provenance"?: (Record<string, MetricProvenanceHTTP> | null);
|
|
1886
|
+
"withheld_metrics"?: (Record<string, WithheldMetricHTTP> | null);
|
|
1887
|
+
};
|
|
1888
|
+
export type StatementMetricPublicProvenanceEnvelope = {
|
|
1889
|
+
"data": StatementMetricPublicProvenanceHTTP;
|
|
1890
|
+
};
|
|
1891
|
+
/** HTTP schema for the public metric-provenance drill-down. */
|
|
1892
|
+
export type StatementMetricPublicProvenanceHTTP = {
|
|
1893
|
+
"cik": string;
|
|
1894
|
+
"statement_type": StatementType;
|
|
1895
|
+
"fiscal_year": number;
|
|
1896
|
+
"fiscal_period": FiscalPeriod;
|
|
1897
|
+
"accession_id": string;
|
|
1898
|
+
"metric": string;
|
|
1899
|
+
"value"?: (string | null);
|
|
1900
|
+
"source_accession"?: (string | null);
|
|
1901
|
+
"filing_type"?: (string | null);
|
|
1902
|
+
"filing_date"?: (string | null);
|
|
1903
|
+
"accepted_at"?: (string | null);
|
|
1904
|
+
"source_xbrl_concept"?: (string | null);
|
|
1905
|
+
"source_line_item"?: (string | null);
|
|
1906
|
+
"mapping_type"?: ("DIRECT" | "FALLBACK" | "CALCULATED" | "INFERRED" | "UNKNOWN" | null);
|
|
1907
|
+
"override_applied": boolean;
|
|
1908
|
+
"override_reason"?: (string | null);
|
|
1909
|
+
"calculation_steps"?: (Array<string> | null);
|
|
1910
|
+
"source_context"?: (Record<string, string> | null);
|
|
1911
|
+
};
|
|
1912
|
+
export type StatementOverrideTraceEnvelope = {
|
|
1913
|
+
"data": StatementOverrideTraceHTTP;
|
|
1914
|
+
};
|
|
1915
|
+
/** Which mapping override rules applied to one filing's statement. */
|
|
1916
|
+
export type StatementOverrideTraceHTTP = {
|
|
1917
|
+
"cik": string;
|
|
1918
|
+
"statement_type": string;
|
|
1919
|
+
"fiscal_year": number;
|
|
1920
|
+
"fiscal_period": string;
|
|
1921
|
+
"accession_id": string;
|
|
1922
|
+
"gaap_concept"?: (string | null);
|
|
1923
|
+
"canonical_metric_code"?: (string | null);
|
|
1924
|
+
"dimension_key"?: (string | null);
|
|
1925
|
+
"total_facts_evaluated": number;
|
|
1926
|
+
"total_facts_remapped": number;
|
|
1927
|
+
"total_facts_suppressed": number;
|
|
1928
|
+
"rules"?: Array<OverrideRuleApplicationHTTP>;
|
|
1929
|
+
};
|
|
1930
|
+
/** Everything known about the statement's quality, part by part. */
|
|
1931
|
+
export type StatementQualityHTTP = {
|
|
1932
|
+
"completeness"?: (StatementCompletenessQualityHTTP | null);
|
|
1933
|
+
"reconciliation"?: (StatementReconciliationQualityHTTP | null);
|
|
1934
|
+
"data_quality"?: (StatementDataQualityHTTP | null);
|
|
1935
|
+
"mapping"?: (StatementMappingQualityHTTP | null);
|
|
1936
|
+
};
|
|
1937
|
+
/** The statement's reconciliation results, by group of rules. */
|
|
1938
|
+
export type StatementReconciliationQualityHTTP = {
|
|
1939
|
+
"identity": QualityCheckGroupHTTP;
|
|
1940
|
+
"cross_statement": QualityCheckGroupHTTP;
|
|
1941
|
+
"rollforward": QualityCheckGroupHTTP;
|
|
1942
|
+
"calendar": QualityCheckGroupHTTP;
|
|
1943
|
+
};
|
|
1944
|
+
/** Supported financial statement types. */
|
|
1945
|
+
export type StatementType = "INCOME_STATEMENT" | "BALANCE_SHEET" | "CASH_FLOW_STATEMENT";
|
|
1946
|
+
/** A statement's values in US dollars, with the rate they were converted at. */
|
|
1947
|
+
export type StatementUsdHTTP = {
|
|
1948
|
+
"values": Record<string, string>;
|
|
1949
|
+
"usd_per_unit": string;
|
|
1950
|
+
"rate_basis": "PERIOD_AVERAGE" | "PERIOD_END" | "AS_FILED";
|
|
1951
|
+
"rate_start"?: (string | null);
|
|
1952
|
+
"rate_end"?: (string | null);
|
|
1953
|
+
"source"?: (string | null);
|
|
1954
|
+
};
|
|
1955
|
+
/** Success envelope for non-paginated responses: {"data": T}. */
|
|
1956
|
+
export type SuccessEnvelope = {
|
|
1957
|
+
"data": unknown;
|
|
1958
|
+
};
|
|
1959
|
+
export type SystemMetadataEnvelope = {
|
|
1960
|
+
"data": SystemMetadataHTTP;
|
|
1961
|
+
};
|
|
1962
|
+
/** HTTP schema for static system metadata and client limits. */
|
|
1963
|
+
export type SystemMetadataHTTP = {
|
|
1964
|
+
"mcp_version": string;
|
|
1965
|
+
"api_version": string;
|
|
1966
|
+
"max_page_size": number;
|
|
1967
|
+
};
|
|
1968
|
+
/** HTTP schema naming a metric with no value for a period, and why. */
|
|
1969
|
+
export type UnavailableMetricHTTP = {
|
|
1970
|
+
"metric": string;
|
|
1971
|
+
"reason": MetricNullReason;
|
|
1972
|
+
"missing_inputs"?: Array<string>;
|
|
1973
|
+
};
|
|
1974
|
+
export type UniversePITSnapshotBuildingEnvelope = {
|
|
1975
|
+
"data": UniversePITSnapshotBuildingHTTP;
|
|
1976
|
+
};
|
|
1977
|
+
/** HTTP schema for a universe snapshot whose companies are still being modeled. */
|
|
1978
|
+
export type UniversePITSnapshotBuildingHTTP = {
|
|
1979
|
+
"status"?: string;
|
|
1980
|
+
"pending_ciks": Array<string>;
|
|
1981
|
+
"retry_after_seconds": number;
|
|
1982
|
+
};
|
|
1983
|
+
/** HTTP schema for universe snapshot attestation metadata. */
|
|
1984
|
+
export type UniversePITSnapshotMetaHTTP = {
|
|
1985
|
+
"snapshot_id": string;
|
|
1986
|
+
"snapshot_hash": string;
|
|
1987
|
+
"accession_id"?: (string | null);
|
|
1988
|
+
};
|
|
1989
|
+
/** HTTP schema for a single universe PIT snapshot metric row. */
|
|
1990
|
+
export type UniversePITSnapshotMetricHTTP = {
|
|
1991
|
+
"cik": string;
|
|
1992
|
+
"statement_type": StatementType;
|
|
1993
|
+
"metric_name": string;
|
|
1994
|
+
"metric_value": string;
|
|
1995
|
+
"statement_date": string;
|
|
1996
|
+
"fiscal_year": number;
|
|
1997
|
+
"fiscal_period": FiscalPeriod;
|
|
1998
|
+
"_meta": UniversePITSnapshotMetaHTTP;
|
|
1999
|
+
};
|
|
2000
|
+
export type UniversePITSnapshotMetricPage = {
|
|
2001
|
+
"page": number;
|
|
2002
|
+
"page_size": number;
|
|
2003
|
+
"total": number;
|
|
2004
|
+
"items": Array<UniversePITSnapshotMetricHTTP>;
|
|
2005
|
+
};
|
|
2006
|
+
/** HTTP schema for universe point-in-time snapshot requests. */
|
|
2007
|
+
export type UniversePITSnapshotRequestHTTP = {
|
|
2008
|
+
"ciks"?: (Array<string> | null);
|
|
2009
|
+
"tickers"?: (Array<string> | null);
|
|
2010
|
+
"as_of_date": string;
|
|
2011
|
+
"statement_types": Array<StatementType>;
|
|
2012
|
+
"metrics_bundle": string;
|
|
2013
|
+
};
|
|
2014
|
+
/** One screen condition: ``metric <operator> value``. */
|
|
2015
|
+
export type UniverseScreenConditionHTTP = {
|
|
2016
|
+
"metric": string;
|
|
2017
|
+
"operator": string;
|
|
2018
|
+
"value": string;
|
|
2019
|
+
};
|
|
2020
|
+
/** A company meeting every condition, with the figures it was screened on. */
|
|
2021
|
+
export type UniverseScreenMatchHTTP = {
|
|
2022
|
+
"cik": string;
|
|
2023
|
+
"statement_date": string;
|
|
2024
|
+
"fiscal_year": number;
|
|
2025
|
+
"fiscal_period": string;
|
|
2026
|
+
"accession_id"?: (string | null);
|
|
2027
|
+
"metrics": Record<string, string>;
|
|
2028
|
+
};
|
|
2029
|
+
export type UniverseScreenPageEnvelope = {
|
|
2030
|
+
"data": UniverseScreenPageHTTP;
|
|
2031
|
+
};
|
|
2032
|
+
/** One page of a point-in-time universe screen, and what pins the whole screen. */
|
|
2033
|
+
export type UniverseScreenPageHTTP = {
|
|
2034
|
+
"page": number;
|
|
2035
|
+
"page_size": number;
|
|
2036
|
+
"total": number;
|
|
2037
|
+
"items": Array<UniverseScreenMatchHTTP>;
|
|
2038
|
+
"as_of_date": string;
|
|
2039
|
+
"screened_companies": number;
|
|
2040
|
+
"snapshot_hash": string;
|
|
2041
|
+
"replay_token": string;
|
|
2042
|
+
"verify_url": string;
|
|
2043
|
+
};
|
|
2044
|
+
/** Request body for the point-in-time universe screen. */
|
|
2045
|
+
export type UniverseScreenRequestHTTP = {
|
|
2046
|
+
"as_of_date": string;
|
|
2047
|
+
"period_basis"?: string;
|
|
2048
|
+
"conditions": Array<UniverseScreenConditionHTTP>;
|
|
2049
|
+
};
|
|
2050
|
+
/** A fact's value in US dollars, with the rate it was converted at. */
|
|
2051
|
+
export type UsdValueHTTP = {
|
|
2052
|
+
"value": string;
|
|
2053
|
+
"usd_per_unit": string;
|
|
2054
|
+
"rate_basis": "PERIOD_AVERAGE" | "PERIOD_END" | "AS_FILED";
|
|
2055
|
+
"rate_start"?: (string | null);
|
|
2056
|
+
"rate_end"?: (string | null);
|
|
2057
|
+
"source"?: (string | null);
|
|
2058
|
+
};
|
|
2059
|
+
/** HTTP schema for valuation input primitives. */
|
|
2060
|
+
export type ValuationInputsHTTP = {
|
|
2061
|
+
"revenue"?: (string | null);
|
|
2062
|
+
"gross_profit"?: (string | null);
|
|
2063
|
+
"operating_income"?: (string | null);
|
|
2064
|
+
"net_income"?: (string | null);
|
|
2065
|
+
"income_before_tax"?: (string | null);
|
|
2066
|
+
"income_tax_expense"?: (string | null);
|
|
2067
|
+
"interest_expense"?: (string | null);
|
|
2068
|
+
"interest_income"?: (string | null);
|
|
2069
|
+
"depreciation_and_amortization"?: (string | null);
|
|
2070
|
+
"stock_based_compensation_in_cfo"?: (string | null);
|
|
2071
|
+
"depreciation_and_amortization_in_cfo"?: (string | null);
|
|
2072
|
+
"change_in_accounts_receivable"?: (string | null);
|
|
2073
|
+
"change_in_inventories"?: (string | null);
|
|
2074
|
+
"change_in_accounts_payable"?: (string | null);
|
|
2075
|
+
"change_in_other_current_assets"?: (string | null);
|
|
2076
|
+
"change_in_other_current_liabilities"?: (string | null);
|
|
2077
|
+
"net_working_capital_change"?: (string | null);
|
|
2078
|
+
"cash_from_operations"?: (string | null);
|
|
2079
|
+
"capital_expenditures"?: (string | null);
|
|
2080
|
+
"free_cash_flow"?: (string | null);
|
|
2081
|
+
"unlevered_free_cash_flow"?: (string | null);
|
|
2082
|
+
"total_assets"?: (string | null);
|
|
2083
|
+
"total_equity"?: (string | null);
|
|
2084
|
+
"total_current_assets"?: (string | null);
|
|
2085
|
+
"total_current_liabilities"?: (string | null);
|
|
2086
|
+
"cash_and_cash_equivalents"?: (string | null);
|
|
2087
|
+
"short_term_debt"?: (string | null);
|
|
2088
|
+
"current_portion_long_term_debt"?: (string | null);
|
|
2089
|
+
"long_term_debt"?: (string | null);
|
|
2090
|
+
"weighted_average_shares_basic"?: (string | null);
|
|
2091
|
+
"weighted_average_shares_diluted"?: (string | null);
|
|
2092
|
+
"ebit"?: (string | null);
|
|
2093
|
+
"ebitda"?: (string | null);
|
|
2094
|
+
"tax_rate"?: (string | null);
|
|
2095
|
+
"nopat"?: (string | null);
|
|
2096
|
+
"working_capital"?: (string | null);
|
|
2097
|
+
"total_debt"?: (string | null);
|
|
2098
|
+
"net_debt"?: (string | null);
|
|
2099
|
+
"invested_capital"?: (string | null);
|
|
2100
|
+
"net_capex"?: (string | null);
|
|
2101
|
+
};
|
|
2102
|
+
export type VersionMetricDeltaEnvelope = {
|
|
2103
|
+
"data": VersionMetricDeltaHTTP;
|
|
2104
|
+
};
|
|
2105
|
+
/** Change in one metric between a period's first-filed and latest-filed figures. */
|
|
2106
|
+
export type VersionMetricDeltaHTTP = {
|
|
2107
|
+
"metric": string;
|
|
2108
|
+
"original_value"?: (string | null);
|
|
2109
|
+
"comparison_value"?: (string | null);
|
|
2110
|
+
"absolute_delta"?: (string | null);
|
|
2111
|
+
"percent_delta"?: (string | null);
|
|
2112
|
+
"first_filing_accession_id": string;
|
|
2113
|
+
"comparison_filing_accession_id"?: (string | null);
|
|
2114
|
+
"change_accepted_at"?: (string | null);
|
|
2115
|
+
};
|
|
2116
|
+
/** Request payload to create an account-scoped outbound webhook subscription. */
|
|
2117
|
+
export type WebhookSubscriptionCreateRequestHTTP = {
|
|
2118
|
+
"event_type": string;
|
|
2119
|
+
"target_url": string;
|
|
2120
|
+
};
|
|
2121
|
+
export type WebhookSubscriptionEnvelope = {
|
|
2122
|
+
"data": WebhookSubscriptionHTTP;
|
|
2123
|
+
};
|
|
2124
|
+
/** Account-scoped outbound webhook subscription payload. */
|
|
2125
|
+
export type WebhookSubscriptionHTTP = {
|
|
2126
|
+
"id": string;
|
|
2127
|
+
"event_type": string;
|
|
2128
|
+
"target_url": string;
|
|
2129
|
+
"is_active": boolean;
|
|
2130
|
+
"created_at": string;
|
|
2131
|
+
"updated_at": string;
|
|
2132
|
+
};
|
|
2133
|
+
export type WebhookSubscriptionListEnvelope = {
|
|
2134
|
+
"data": WebhookSubscriptionListHTTP;
|
|
2135
|
+
};
|
|
2136
|
+
/** List envelope for account-scoped webhook subscriptions. */
|
|
2137
|
+
export type WebhookSubscriptionListHTTP = {
|
|
2138
|
+
"items": Array<WebhookSubscriptionHTTP>;
|
|
2139
|
+
};
|
|
2140
|
+
export type WebhookSubscriptionWithSecretEnvelope = {
|
|
2141
|
+
"data": WebhookSubscriptionWithSecretHTTP;
|
|
2142
|
+
};
|
|
2143
|
+
/** Webhook subscription with its signing secret. */
|
|
2144
|
+
export type WebhookSubscriptionWithSecretHTTP = {
|
|
2145
|
+
"id": string;
|
|
2146
|
+
"event_type": string;
|
|
2147
|
+
"target_url": string;
|
|
2148
|
+
"is_active": boolean;
|
|
2149
|
+
"created_at": string;
|
|
2150
|
+
"updated_at": string;
|
|
2151
|
+
"signing_secret": string;
|
|
2152
|
+
};
|
|
2153
|
+
/** A metric withheld from the statement because the filer's own subtotals contradict it. */
|
|
2154
|
+
export type WithheldMetricHTTP = {
|
|
2155
|
+
"rule": string;
|
|
2156
|
+
"as_filed_value"?: (string | null);
|
|
2157
|
+
"as_filed_concept"?: (string | null);
|
|
2158
|
+
};
|