GET
/
api
/
v1
/
documents
/
list
List documents
curl --request GET \
  --url https://rest-api.captide.co/api/v1/documents/list \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "98381fbb-8d8c-4b47-b31c-819f8aca0690",
    "documentCategory": "interim-report",
    "tickers": [
      "STO.AX"
    ],
    "companyName": "Santos",
    "date": "2025-04-17",
    "fiscalQuarter": 1,
    "fiscalYear": 2025,
    "title": "First Quarter Report for period ending 31 March 2025",
    "description": "This document is the First Quarter Report of Santos Limited for the period ending 31 March 2025. It provides a detailed overview of the company's operational and financial performance, including production volumes, sales, revenue, capital expenditure, project updates, and guidance for 2025."
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
tickers
string | null

Comma-separated list of tickers of the companies filing the documents (supports both base tickers like 'ITX' and suffixed tickers like 'ITX.MC')

Examples:

"STO.AX,ASML.AS"

​
documentCategories
string | null

Comma-separated list of document categories. Supported categories are: annual-report, interim-report, supplemental-financial-information, earnings-release, current-report, shareholder-meetings-notice, earnings-call-transcript, earnings-call-slides, special-events-slides, sustainability-report, initial-registration-statement. For detailed descriptions, please refer to this page

Examples:

"annual-report,interim-report"

​
formTypes
string | null

Comma-separated list of SEC form types to retrieve. This parameter is only applicable to companies that file with the SEC. To check if a company files with the SEC, use the filesWithSec field from the /api/v1/companies/list endpoint

Examples:

"10-K,10-Q"

​
startDate
string | null

Start date for filtering documents (ISO 8601 format)

Examples:

"2025-01-01"

​
endDate
string | null

End date for filtering documents (ISO 8601 format)

Examples:

"2025-12-31"

​
companyIds
string | null

Comma-separated list of unique IDs of the companies filing the documents. Use /api/v1/companies/list to find the company ID

Examples:

"77848abe-a215-41b7-8950-86e89ea1fadc,91f6c6da-478f-4161-b451-aa5177cc7fb9"

​
limit
integer | null
default:100

Maximum number of records to return. Required range: 1 <= x <= 1000

Required range: 1 <= x <= 1000
Examples:

100

Response

Document list retrieved successfully

​
id
string
required

Unique document ID

​
documentCategory
enum<string>
required

Document categories. For detailed category descriptions, please refer to this page.

Available options:
annual-report,
interim-report,
supplemental-financial-information,
earnings-release,
current-report,
shareholder-meetings-notice,
earnings-call-slides,
special-events-slides,
earnings-call-transcript,
sustainability-report,
initial-registration-statement,
follow-on-registration-statement,
merger-registration-statement,
compensation-registration-statement,
tender-offer-statement,
going-private-statement,
insider-shares-transactions,
other
​
tickers
string[]
required

Tickers of the company filing the document

​
formType
string | null

Document SEC form type (only applicable if the company files with the SEC)

​
companyName
string | null

Name of the company filing the document

​
date
string | null

Date the document relates to (e.g., the press release date for a current report, or the fiscal period end date for annual and interim reports)

​
fiscalQuarter
integer | null

Fiscal quarter the document relates to (from 1 to 4)

​
fiscalYear
integer | null

Fiscal year the document relates to (e.g., 2024)

​
title
string | null

Captide-generated document title

​
description
string | null

Captide-generated document description