@invinite-org/data-api-client 0.9.0 → 0.10.1

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.
Files changed (41) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/dist/apis/EarningsCallsApi.d.ts +12 -12
  3. package/dist/apis/EarningsCallsApi.js +12 -12
  4. package/dist/esm/apis/EarningsCallsApi.d.ts +12 -12
  5. package/dist/esm/apis/EarningsCallsApi.js +12 -12
  6. package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +8 -8
  7. package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +2 -4
  8. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -7
  9. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +0 -4
  10. package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +6 -6
  11. package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +2 -4
  12. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +1 -1
  13. package/dist/esm/models/EarningsCallsSlides200ResponseDeck.d.ts +1 -7
  14. package/dist/esm/models/EarningsCallsSlides200ResponseDeck.js +0 -4
  15. package/dist/esm/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +1 -1
  16. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +1 -1
  17. package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +8 -8
  18. package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +2 -4
  19. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -7
  20. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +0 -4
  21. package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +6 -6
  22. package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +2 -4
  23. package/dist/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +1 -1
  24. package/dist/models/EarningsCallsSlides200ResponseDeck.d.ts +1 -7
  25. package/dist/models/EarningsCallsSlides200ResponseDeck.js +0 -4
  26. package/dist/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +1 -1
  27. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +1 -1
  28. package/docs/EarningsCallsApi.md +6 -6
  29. package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +2 -2
  30. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +0 -2
  31. package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +2 -2
  32. package/docs/EarningsCallsSlides200ResponseDeck.md +0 -2
  33. package/package.json +1 -1
  34. package/src/apis/EarningsCallsApi.ts +12 -12
  35. package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +10 -11
  36. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -10
  37. package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +8 -9
  38. package/src/models/EarningsCallsSearch200ResponseHitsInnerSlide.ts +1 -1
  39. package/src/models/EarningsCallsSlides200ResponseDeck.ts +1 -10
  40. package/src/models/EarningsCallsSlides200ResponseSlidesInner.ts +1 -1
  41. package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +1 -1
@@ -70,17 +70,17 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
70
70
  */
71
71
  accession_number: string | null;
72
72
  /**
73
- * Signed download URL; null for link-only rows (sec_filing) or a failed download: use source_url
74
- * @type {string}
73
+ * EDGAR filing date of a sec_filing link (the 10-Q / 10-K); null for every other kind or when unknown
74
+ * @type {Date}
75
75
  * @memberof EarningsCallsDocuments200ResponseDocumentsInner
76
76
  */
77
- url: string | null;
77
+ filing_date?: Date | null;
78
78
  /**
79
- * When url stops working
80
- * @type {Date}
79
+ * Permanent public download URL; null for link-only rows (sec_filing) or a failed download: use source_url
80
+ * @type {string}
81
81
  * @memberof EarningsCallsDocuments200ResponseDocumentsInner
82
82
  */
83
- expires_at: Date | null;
83
+ url: string | null;
84
84
  /**
85
85
  * MIME type
86
86
  * @type {string}
@@ -94,8 +94,6 @@ export function instanceOfEarningsCallsDocuments200ResponseDocumentsInner(value)
94
94
  return false;
95
95
  if (!('url' in value) || value['url'] === undefined)
96
96
  return false;
97
- if (!('expires_at' in value) || value['expires_at'] === undefined)
98
- return false;
99
97
  if (!('content_type' in value) || value['content_type'] === undefined)
100
98
  return false;
101
99
  if (!('bytes' in value) || value['bytes'] === undefined)
@@ -129,8 +127,8 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped(jso
129
127
  'source_label': json['source_label'],
130
128
  'source_url': json['source_url'],
131
129
  'accession_number': json['accession_number'],
130
+ 'filing_date': json['filing_date'] == null ? undefined : (new Date(json['filing_date'])),
132
131
  'url': json['url'],
133
- 'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
134
132
  'content_type': json['content_type'],
135
133
  'bytes': json['bytes'],
136
134
  'pages': json['pages'],
@@ -158,8 +156,8 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerToJSONTyped(value
158
156
  'source_label': value['source_label'],
159
157
  'source_url': value['source_url'],
160
158
  'accession_number': value['accession_number'],
159
+ 'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0, 10),
161
160
  'url': value['url'],
162
- 'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
163
161
  'content_type': value['content_type'],
164
162
  'bytes': value['bytes'],
165
163
  'pages': value['pages'],
@@ -22,7 +22,7 @@ export interface EarningsCallsSearch200ResponseHitsInnerSlide {
22
22
  */
23
23
  page: number;
24
24
  /**
25
- * Signed page image URL; null without the PRO plan or without an image
25
+ * Permanent public page image URL; null without the PRO plan or without an image
26
26
  * @type {string}
27
27
  * @memberof EarningsCallsSearch200ResponseHitsInnerSlide
28
28
  */
@@ -16,17 +16,11 @@
16
16
  */
17
17
  export interface EarningsCallsSlides200ResponseDeck {
18
18
  /**
19
- * Signed download URL; a bearer credential, do not share or cache
19
+ * Permanent public URL of the deck PDF
20
20
  * @type {string}
21
21
  * @memberof EarningsCallsSlides200ResponseDeck
22
22
  */
23
23
  url: string;
24
- /**
25
- * When the signed URL stops working
26
- * @type {Date}
27
- * @memberof EarningsCallsSlides200ResponseDeck
28
- */
29
- expires_at: Date;
30
24
  /**
31
25
  * Page count; null = unknown
32
26
  * @type {number}
@@ -27,8 +27,6 @@ export const EarningsCallsSlides200ResponseDeckTrustTierEnum = {
27
27
  export function instanceOfEarningsCallsSlides200ResponseDeck(value) {
28
28
  if (!('url' in value) || value['url'] === undefined)
29
29
  return false;
30
- if (!('expires_at' in value) || value['expires_at'] === undefined)
31
- return false;
32
30
  if (!('pages' in value) || value['pages'] === undefined)
33
31
  return false;
34
32
  if (!('origin' in value) || value['origin'] === undefined)
@@ -48,7 +46,6 @@ export function EarningsCallsSlides200ResponseDeckFromJSONTyped(json, ignoreDisc
48
46
  }
49
47
  return {
50
48
  'url': json['url'],
51
- 'expires_at': (new Date(json['expires_at'])),
52
49
  'pages': json['pages'],
53
50
  'origin': json['origin'],
54
51
  'source_url': json['source_url'],
@@ -64,7 +61,6 @@ export function EarningsCallsSlides200ResponseDeckToJSONTyped(value, ignoreDiscr
64
61
  }
65
62
  return {
66
63
  'url': value['url'],
67
- 'expires_at': value['expires_at'].toISOString(),
68
64
  'pages': value['pages'],
69
65
  'origin': value['origin'],
70
66
  'source_url': value['source_url'],
@@ -28,7 +28,7 @@ export interface EarningsCallsSlides200ResponseSlidesInner {
28
28
  */
29
29
  title: string | null;
30
30
  /**
31
- * Signed URL of the page image (same expiry as the deck)
31
+ * Permanent public URL of the page image
32
32
  * @type {string}
33
33
  * @memberof EarningsCallsSlides200ResponseSlidesInner
34
34
  */
@@ -22,7 +22,7 @@ export interface EarningsCallsSlides200ResponseTimelineInner {
22
22
  */
23
23
  at_ms: number;
24
24
  /**
25
- * Signed URL of the slide screenshot (same expiry as the deck)
25
+ * Permanent public URL of the slide screenshot
26
26
  * @type {string}
27
27
  * @memberof EarningsCallsSlides200ResponseTimelineInner
28
28
  */
@@ -87,6 +87,12 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
87
87
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
88
88
  */
89
89
  event_date: Date | null;
90
+ /**
91
+ * EDGAR filing date of a call's SEC filing link (kind sec_filing, e.g. the 10-K filed after the call); null for every other document or when unknown
92
+ * @type {Date}
93
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
94
+ */
95
+ filing_date?: Date | null;
90
96
  /**
91
97
  * Document title
92
98
  * @type {string}
@@ -160,23 +166,17 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
160
166
  */
161
167
  link_status: EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum | null;
162
168
  /**
163
- * Signed download URL; null for a link-only row (use source_url)
169
+ * Permanent public download URL; null for a link-only row (use source_url)
164
170
  * @type {string}
165
171
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
166
172
  */
167
173
  url: string | null;
168
174
  /**
169
- * Signed URL of the per-page text (JSON); null before the text was extracted
175
+ * Permanent public URL of the per-page text (JSON); null before the text was extracted
170
176
  * @type {string}
171
177
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
172
178
  */
173
179
  pages_url: string | null;
174
- /**
175
- * When the signed URLs stop working
176
- * @type {Date}
177
- * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
178
- */
179
- expires_at: Date | null;
180
180
  /**
181
181
  * When we first stored the document
182
182
  * @type {Date}
@@ -202,8 +202,6 @@ function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner(value)
202
202
  return false;
203
203
  if (!('pages_url' in value) || value['pages_url'] === undefined)
204
204
  return false;
205
- if (!('expires_at' in value) || value['expires_at'] === undefined)
206
- return false;
207
205
  if (!('created_at' in value) || value['created_at'] === undefined)
208
206
  return false;
209
207
  if (!('updated_at' in value) || value['updated_at'] === undefined)
@@ -230,6 +228,7 @@ function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTyped(jso
230
228
  'event_id': json['event_id'],
231
229
  'event_type': json['event_type'],
232
230
  'event_date': (json['event_date'] == null ? null : new Date(json['event_date'])),
231
+ 'filing_date': json['filing_date'] == null ? undefined : (new Date(json['filing_date'])),
233
232
  'title': json['title'],
234
233
  'source_label': json['source_label'],
235
234
  'source_url': json['source_url'],
@@ -244,7 +243,6 @@ function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTyped(jso
244
243
  'link_status': json['link_status'],
245
244
  'url': json['url'],
246
245
  'pages_url': json['pages_url'],
247
- 'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
248
246
  'created_at': (new Date(json['created_at'])),
249
247
  'updated_at': (new Date(json['updated_at'])),
250
248
  'pages_json': json['pages_json'] == null ? undefined : json['pages_json'],
@@ -270,6 +268,7 @@ function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONTyped(value
270
268
  'event_id': value['event_id'],
271
269
  'event_type': value['event_type'],
272
270
  'event_date': value['event_date'] == null ? value['event_date'] : value['event_date'].toISOString().substring(0, 10),
271
+ 'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0, 10),
273
272
  'title': value['title'],
274
273
  'source_label': value['source_label'],
275
274
  'source_url': value['source_url'],
@@ -284,7 +283,6 @@ function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONTyped(value
284
283
  'link_status': value['link_status'],
285
284
  'url': value['url'],
286
285
  'pages_url': value['pages_url'],
287
- 'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
288
286
  'created_at': value['created_at'].toISOString(),
289
287
  'updated_at': value['updated_at'].toISOString(),
290
288
  'pages_json': value['pages_json'],
@@ -137,17 +137,11 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
137
137
  */
138
138
  category: EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum | null;
139
139
  /**
140
- * Signed URL of the stored file; null for a link-only row
140
+ * Permanent public URL of the stored file; null for a link-only row
141
141
  * @type {string}
142
142
  * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
143
143
  */
144
144
  url: string | null;
145
- /**
146
- * When url stops working
147
- * @type {Date}
148
- * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
149
- */
150
- expires_at: Date | null;
151
145
  }
152
146
  /**
153
147
  * @export
@@ -86,8 +86,6 @@ function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value) {
86
86
  return false;
87
87
  if (!('url' in value) || value['url'] === undefined)
88
88
  return false;
89
- if (!('expires_at' in value) || value['expires_at'] === undefined)
90
- return false;
91
89
  return true;
92
90
  }
93
91
  function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON(json) {
@@ -119,7 +117,6 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(json, igno
119
117
  'group_label': json['group_label'],
120
118
  'category': json['category'],
121
119
  'url': json['url'],
122
- 'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
123
120
  };
124
121
  }
125
122
  function EarningsCallsDocumentSearch200ResponseHitsInnerToJSON(json) {
@@ -151,6 +148,5 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value, ignor
151
148
  'group_label': value['group_label'],
152
149
  'category': value['category'],
153
150
  'url': value['url'],
154
- 'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
155
151
  };
156
152
  }
@@ -70,17 +70,17 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
70
70
  */
71
71
  accession_number: string | null;
72
72
  /**
73
- * Signed download URL; null for link-only rows (sec_filing) or a failed download: use source_url
74
- * @type {string}
73
+ * EDGAR filing date of a sec_filing link (the 10-Q / 10-K); null for every other kind or when unknown
74
+ * @type {Date}
75
75
  * @memberof EarningsCallsDocuments200ResponseDocumentsInner
76
76
  */
77
- url: string | null;
77
+ filing_date?: Date | null;
78
78
  /**
79
- * When url stops working
80
- * @type {Date}
79
+ * Permanent public download URL; null for link-only rows (sec_filing) or a failed download: use source_url
80
+ * @type {string}
81
81
  * @memberof EarningsCallsDocuments200ResponseDocumentsInner
82
82
  */
83
- expires_at: Date | null;
83
+ url: string | null;
84
84
  /**
85
85
  * MIME type
86
86
  * @type {string}
@@ -102,8 +102,6 @@ function instanceOfEarningsCallsDocuments200ResponseDocumentsInner(value) {
102
102
  return false;
103
103
  if (!('url' in value) || value['url'] === undefined)
104
104
  return false;
105
- if (!('expires_at' in value) || value['expires_at'] === undefined)
106
- return false;
107
105
  if (!('content_type' in value) || value['content_type'] === undefined)
108
106
  return false;
109
107
  if (!('bytes' in value) || value['bytes'] === undefined)
@@ -137,8 +135,8 @@ function EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped(json, igno
137
135
  'source_label': json['source_label'],
138
136
  'source_url': json['source_url'],
139
137
  'accession_number': json['accession_number'],
138
+ 'filing_date': json['filing_date'] == null ? undefined : (new Date(json['filing_date'])),
140
139
  'url': json['url'],
141
- 'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
142
140
  'content_type': json['content_type'],
143
141
  'bytes': json['bytes'],
144
142
  'pages': json['pages'],
@@ -166,8 +164,8 @@ function EarningsCallsDocuments200ResponseDocumentsInnerToJSONTyped(value, ignor
166
164
  'source_label': value['source_label'],
167
165
  'source_url': value['source_url'],
168
166
  'accession_number': value['accession_number'],
167
+ 'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0, 10),
169
168
  'url': value['url'],
170
- 'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
171
169
  'content_type': value['content_type'],
172
170
  'bytes': value['bytes'],
173
171
  'pages': value['pages'],
@@ -22,7 +22,7 @@ export interface EarningsCallsSearch200ResponseHitsInnerSlide {
22
22
  */
23
23
  page: number;
24
24
  /**
25
- * Signed page image URL; null without the PRO plan or without an image
25
+ * Permanent public page image URL; null without the PRO plan or without an image
26
26
  * @type {string}
27
27
  * @memberof EarningsCallsSearch200ResponseHitsInnerSlide
28
28
  */
@@ -16,17 +16,11 @@
16
16
  */
17
17
  export interface EarningsCallsSlides200ResponseDeck {
18
18
  /**
19
- * Signed download URL; a bearer credential, do not share or cache
19
+ * Permanent public URL of the deck PDF
20
20
  * @type {string}
21
21
  * @memberof EarningsCallsSlides200ResponseDeck
22
22
  */
23
23
  url: string;
24
- /**
25
- * When the signed URL stops working
26
- * @type {Date}
27
- * @memberof EarningsCallsSlides200ResponseDeck
28
- */
29
- expires_at: Date;
30
24
  /**
31
25
  * Page count; null = unknown
32
26
  * @type {number}
@@ -35,8 +35,6 @@ exports.EarningsCallsSlides200ResponseDeckTrustTierEnum = {
35
35
  function instanceOfEarningsCallsSlides200ResponseDeck(value) {
36
36
  if (!('url' in value) || value['url'] === undefined)
37
37
  return false;
38
- if (!('expires_at' in value) || value['expires_at'] === undefined)
39
- return false;
40
38
  if (!('pages' in value) || value['pages'] === undefined)
41
39
  return false;
42
40
  if (!('origin' in value) || value['origin'] === undefined)
@@ -56,7 +54,6 @@ function EarningsCallsSlides200ResponseDeckFromJSONTyped(json, ignoreDiscriminat
56
54
  }
57
55
  return {
58
56
  'url': json['url'],
59
- 'expires_at': (new Date(json['expires_at'])),
60
57
  'pages': json['pages'],
61
58
  'origin': json['origin'],
62
59
  'source_url': json['source_url'],
@@ -72,7 +69,6 @@ function EarningsCallsSlides200ResponseDeckToJSONTyped(value, ignoreDiscriminato
72
69
  }
73
70
  return {
74
71
  'url': value['url'],
75
- 'expires_at': value['expires_at'].toISOString(),
76
72
  'pages': value['pages'],
77
73
  'origin': value['origin'],
78
74
  'source_url': value['source_url'],
@@ -28,7 +28,7 @@ export interface EarningsCallsSlides200ResponseSlidesInner {
28
28
  */
29
29
  title: string | null;
30
30
  /**
31
- * Signed URL of the page image (same expiry as the deck)
31
+ * Permanent public URL of the page image
32
32
  * @type {string}
33
33
  * @memberof EarningsCallsSlides200ResponseSlidesInner
34
34
  */
@@ -22,7 +22,7 @@ export interface EarningsCallsSlides200ResponseTimelineInner {
22
22
  */
23
23
  at_ms: number;
24
24
  /**
25
- * Signed URL of the slide screenshot (same expiry as the deck)
25
+ * Permanent public URL of the slide screenshot
26
26
  * @type {string}
27
27
  * @memberof EarningsCallsSlides200ResponseTimelineInner
28
28
  */
@@ -317,7 +317,7 @@ example().catch(console.error);
317
317
 
318
318
  Company document by ID
319
319
 
320
- One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): signed URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
320
+ One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
321
321
 
322
322
  ### Example
323
323
 
@@ -396,7 +396,7 @@ example().catch(console.error);
396
396
 
397
397
  Company documents
398
398
 
399
- A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
399
+ A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
400
400
 
401
401
  ### Example
402
402
 
@@ -601,7 +601,7 @@ example().catch(console.error);
601
601
 
602
602
  Search investor documents
603
603
 
604
- Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
604
+ Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a permanent public URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
605
605
 
606
606
  ### Example
607
607
 
@@ -701,7 +701,7 @@ example().catch(console.error);
701
701
 
702
702
  Earnings call documents
703
703
 
704
- Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
704
+ Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
705
705
 
706
706
  ### Example
707
707
 
@@ -1971,7 +1971,7 @@ example().catch(console.error);
1971
1971
 
1972
1972
  Search earnings calls
1973
1973
 
1974
- \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
1974
+ \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a permanent public URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
1975
1975
 
1976
1976
  ### Example
1977
1977
 
@@ -2074,7 +2074,7 @@ example().catch(console.error);
2074
2074
 
2075
2075
  Earnings call slides
2076
2076
 
2077
- The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
2077
+ The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
2078
2078
 
2079
2079
  ### Example
2080
2080
 
@@ -18,6 +18,7 @@ Name | Type
18
18
  `event_id` | string
19
19
  `event_type` | string
20
20
  `event_date` | Date
21
+ `filing_date` | Date
21
22
  `title` | string
22
23
  `source_label` | string
23
24
  `source_url` | string
@@ -32,7 +33,6 @@ Name | Type
32
33
  `link_status` | string
33
34
  `url` | string
34
35
  `pages_url` | string
35
- `expires_at` | Date
36
36
  `created_at` | Date
37
37
  `updated_at` | Date
38
38
  `pages_json` | { [key: string]: any; }
@@ -56,6 +56,7 @@ const example = {
56
56
  "event_id": null,
57
57
  "event_type": null,
58
58
  "event_date": null,
59
+ "filing_date": null,
59
60
  "title": null,
60
61
  "source_label": null,
61
62
  "source_url": null,
@@ -70,7 +71,6 @@ const example = {
70
71
  "link_status": null,
71
72
  "url": null,
72
73
  "pages_url": null,
73
- "expires_at": null,
74
74
  "created_at": null,
75
75
  "updated_at": null,
76
76
  "pages_json": null,
@@ -27,7 +27,6 @@ Name | Type
27
27
  `group_label` | string
28
28
  `category` | string
29
29
  `url` | string
30
- `expires_at` | Date
31
30
 
32
31
  ## Example
33
32
 
@@ -57,7 +56,6 @@ const example = {
57
56
  "group_label": null,
58
57
  "category": null,
59
58
  "url": null,
60
- "expires_at": null,
61
59
  } satisfies EarningsCallsDocumentSearch200ResponseHitsInner
62
60
 
63
61
  console.log(example)
@@ -15,8 +15,8 @@ Name | Type
15
15
  `source_label` | string
16
16
  `source_url` | string
17
17
  `accession_number` | string
18
+ `filing_date` | Date
18
19
  `url` | string
19
- `expires_at` | Date
20
20
  `content_type` | string
21
21
  `bytes` | number
22
22
  `pages` | number
@@ -42,8 +42,8 @@ const example = {
42
42
  "source_label": null,
43
43
  "source_url": null,
44
44
  "accession_number": null,
45
+ "filing_date": null,
45
46
  "url": null,
46
- "expires_at": null,
47
47
  "content_type": null,
48
48
  "bytes": null,
49
49
  "pages": null,
@@ -8,7 +8,6 @@ The deck PDF; null for slides captured from the webcast player (page images only
8
8
  Name | Type
9
9
  ------------ | -------------
10
10
  `url` | string
11
- `expires_at` | Date
12
11
  `pages` | number
13
12
  `origin` | string
14
13
  `source_url` | string
@@ -22,7 +21,6 @@ import type { EarningsCallsSlides200ResponseDeck } from '@invinite-org/data-api-
22
21
  // TODO: Update the object below with actual values
23
22
  const example = {
24
23
  "url": null,
25
- "expires_at": null,
26
24
  "pages": null,
27
25
  "origin": null,
28
26
  "source_url": null,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "0.9.0",
3
+ "version": "0.10.1",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {