You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/integrations/quartr.mdx
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ List companies covered by Quartr, filterable by ticker, ISIN, CIK, OpenFIGI, cou
55
55
|`openfigis`| string | No | Comma-separated list of OpenFIGI codes \(figi, compositeFigi, or shareClassFigi\)|
56
56
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
57
57
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
58
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
58
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
59
59
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
60
60
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
61
61
@@ -130,9 +130,9 @@ List corporate events (earnings calls, capital markets days, etc.) from Quartr,
130
130
|`sortBy`| string | No | Field to sort by: "id" or "date" \(default: id\)|
131
131
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
132
132
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
133
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
133
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
134
134
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
135
-
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
135
+
|`direction`| string | No | Sort direction applied to the sortBy field: "asc" or "desc" \(default: asc\)|
136
136
137
137
#### Output
138
138
@@ -197,7 +197,7 @@ Retrieve the AI-generated summary of a corporate event from Quartr, with selecta
197
197
198
198
| Parameter | Type | Description |
199
199
| --------- | ---- | ----------- |
200
-
|`summary`| string | AI-generated event summary in Markdown |
200
+
|`summary`| string | AI-generated event summary in Markdown \(includes embedded document source tags unless a plain-text summary is requested\)|
201
201
|`sources`| array | Source documents referenced by the summary |
202
202
| ↳ `sourceId`| string | ID linking the source document to tags embedded in the summary |
203
203
| ↳ `documentId`| number | Quartr document ID of the source |
@@ -217,7 +217,7 @@ List the event types available in Quartr (e.g., earnings calls), useful for filt
217
217
| Parameter | Type | Required | Description |
218
218
| --------- | ---- | -------- | ----------- |
219
219
|`apiKey`| string | Yes | Quartr API key |
220
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
220
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
221
221
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
222
222
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
223
223
@@ -256,7 +256,7 @@ List documents of all kinds (reports, slide decks, and transcripts) from Quartr,
256
256
|`expandEvent`| boolean | No | Include expanded event details on each document |
257
257
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
258
258
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
259
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
259
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
260
260
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
261
261
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
262
262
@@ -290,7 +290,7 @@ List the document types available in Quartr (e.g., 10-Q quarterly reports), usef
290
290
| Parameter | Type | Required | Description |
291
291
| --------- | ---- | -------- | ----------- |
292
292
|`apiKey`| string | Yes | Quartr API key |
293
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
293
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
294
294
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
295
295
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
296
296
@@ -332,7 +332,7 @@ List filings and reports (10-K, 10-Q, earnings releases, etc.) from Quartr, filt
332
332
|`expandEvent`| boolean | No | Include expanded event details on each document |
333
333
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
334
334
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
335
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
335
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
336
336
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
337
337
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
338
338
@@ -413,7 +413,7 @@ List slide presentations from Quartr, filterable by company, event, document typ
413
413
|`expandEvent`| boolean | No | Include expanded event details on each document |
414
414
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
415
415
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
416
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
416
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
417
417
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
418
418
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
419
419
@@ -494,7 +494,7 @@ List event transcripts from Quartr, filterable by company, event, document type,
494
494
|`expandEvent`| boolean | No | Include expanded event details on each document |
495
495
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
496
496
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
497
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
497
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
498
498
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
499
499
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
500
500
@@ -573,7 +573,7 @@ List archived event audio recordings from Quartr, filterable by company, event,
573
573
|`expandEvent`| boolean | No | Include expanded event details on each audio recording |
574
574
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
575
575
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
576
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
576
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
577
577
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
578
578
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
579
579
@@ -657,13 +657,13 @@ List live and upcoming events from Quartr with live audio and transcript stream
657
657
|`ciks`| string | No | Comma-separated list of SEC CIKs \(e.g., "0000320193"\)|
658
658
|`countries`| string | No | Comma-separated list of ISO 3166-1 alpha-2 country codes \(e.g., "US,SE"\)|
659
659
|`exchanges`| string | No | Comma-separated list of exchange symbols, without whitespace \(e.g., "NasdaqGS"\)|
660
-
|`states`| string | No | Comma-separated list of live states to filter by: notLive, willBeLive, live, liveFailedInterrupted, liveFailedNoAccess |
660
+
|`states`| string | No | Comma-separated list of live states to filter by: notLive, willBeLive, live, liveFailedInterrupted, liveFailedNoAccess, liveFailedNotStarted, processingRecording, processingRecordingFailed, recordingAvailable|
661
661
|`startDate`| string | No | Only return events on or after this ISO 8601 date \(e.g., "2024-01-01"\)|
662
662
|`endDate`| string | No | Only return events on or before this ISO 8601 date \(e.g., "2024-12-31"\)|
663
663
|`transcriptVersion`| string | No | Version of the live transcript stream: "1.6" or "1.7" \(default: 1.6\)|
664
664
|`updatedAfter`| string | No | Only return data updated after this ISO 8601 date \(e.g., "2024-01-01"\)|
665
665
|`updatedBefore`| string | No | Only return data updated before this ISO 8601 date \(e.g., "2024-12-31"\)|
666
-
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10\)|
666
+
|`limit`| number | No | Maximum number of items to return in a single request \(default: 10, max: 500\)|
667
667
|`cursor`| number | No | Pagination cursor from the previous response \(nextCursor\) for the next page |
668
668
|`direction`| string | No | Sort direction by id: "asc" or "desc" \(default: asc\)|
669
669
@@ -677,7 +677,7 @@ List live and upcoming events from Quartr with live audio and transcript stream
677
677
| ↳ `companyId`| number | Quartr company ID |
678
678
| ↳ `date`| string | Scheduled event date \(ISO 8601\)|
679
679
| ↳ `wentLiveAt`| string | Timestamp when the event went live \(ISO 8601\)|
680
-
| ↳ `state`| string | Live state \(notLive, willBeLive, live, liveFailedInterrupted, liveFailedNoAccess, recordingAvailable\)|
680
+
| ↳ `state`| string | Live state \(notLive, willBeLive, live, liveFailedInterrupted, liveFailedNoAccess, liveFailedNotStarted, processingRecording, processingRecordingFailed, recordingAvailable\)|
681
681
| ↳ `audio`| string | URL of the live audio stream or recording |
682
682
| ↳ `transcript`| string | URL of the live transcript stream \(JSON Lines\)|
0 commit comments