Skip to main content
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": "888255fb-9487-4ce0-a625-992325c18e62",
    "documentCategory": "earnings-release",
    "title": "Santos Ltd. First Half Results 2025 with Barossa and Pikka Project Updates",
    "description": "Santos Ltd. presents strong first-half results with sales revenue of $2.6 billion, net profit after tax of $439 million, and underlying profit of $508 million, with Barossa and Pikka projects on track.",
    "date": "2025-08-25",
    "fiscalQuarter": 2,
    "fiscalYear": 2025,
    "fiscalPeriod": "half-year",
    "companyId": "77848abe-a215-41b7-8950-86e89ea1fadc",
    "companyName": "Santos Ltd.",
    "companyTickers": [
      "STO.AX"
    ],
    "metadata": {}
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
documentCategories
string | null

Comma-separated list of document categories. For detailed descriptions and complete list, please refer to this page.

Valid values: annual-financial-report, interim-financial-report, financial-attachments, annual-activity-report, interim-activity-report, compliance-report, historical-performance-summary, letter-to-shareholders, earnings-release, current-report, earnings-presentation, earnings-call-transcript, investor-event-presentation, investor-event-transcript, shareholder-meeting-circular, shareholder-meeting-resolutions, governance-report, compensation-report, governance-policies, esg-report, esg-assessment, insider-share-transactions, shareholder-dealing-disclosure, share-issuance-notice, share-buyback-notice, share-capital-disclosure, initial-offering-prospectus, follow-on-offering-prospectus, merger-offering-prospectus, employee-share-plan-prospectus, tender-offer-disclosure

Example:

"annual-financial-report,interim-financial-report,earnings-release"

​
secFormTypes
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.

Valid values: 10-K, 10-K/A, 10-Q, 10-Q/A, 8-K, 8-K/A, 6-K, 6-K/A, 20-F, 20-F/A, 40-F, 40-F/A, S-1, S-1/A, F-1, F-1/A, S-3, S-3/A, F-3, F-3/A, S-4, S-4/A, F-4, F-4/A, S-8, F-8, F-8 POS, DEF 14A, DEFA14A, DEFM14A, DEF 14C, DEFA14C, DEFM14C

Example:

"10-K,10-Q"

​
companyTickers
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')

Example:

"STO.AX,ASML.AS"

​
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

Example:

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

​
fiscalQuarter
integer | null

Fiscal quarter to filter documents (1-4)

Required range: 1 <= x <= 4
Example:

1

​
fiscalYear
integer | null

Fiscal year to filter documents (e.g., 2024)

Example:

2024

​
startDate
string | null

Start date for filtering documents (ISO 8601 format)

Example:

"2025-01-01"

​
endDate
string | null

End date for filtering documents (ISO 8601 format)

Example:

"2025-12-31"

​
limit
integer | null
default:100

Maximum number of records to return

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

100

Response

Document list retrieved successfully

​
id
string
required

Unique document ID

​
documentCategory
string
required

Document category code as stored in the database. For detailed category descriptions, please refer to this page.

​
companyId
string
required

Unique ID of the company filing the document

​
secFormType
string | null

Document SEC form type (only applicable if the document is an SEC filing)

​
title
string | null

Captide-generated document title

​
description
string | null

Captide-generated document description

​
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)

​
fiscalPeriod
string | null

Fiscal period the document relates to. Valid values: year, multi-year, month, half-year, quarter, or null

​
language
string | null

Language of the document in ISO 639-1 code

​
companyName
string | null

Name of the company filing the document

​
companyTickers
string[]

Tickers of the company filing the document

​
metadata
Metadata · object

Additional document metadata (e.g., accessionNumber, 8kItems)