curl --request GET \
--url https://rest-api.captide.co/api/v2/documents/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://rest-api.captide.co/api/v2/documents/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://rest-api.captide.co/api/v2/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rest-api.captide.co/api/v2/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest-api.captide.co/api/v2/documents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rest-api.captide.co/api/v2/documents/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest-api.captide.co/api/v2/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "a586df65-76d8-4b04-864c-ceed76592f4d",
"documentCategory": "interim-financial-report",
"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.",
"date": "2025-04-17",
"fiscalQuarter": 1,
"fiscalYear": 2025,
"fiscalPeriod": "quarter",
"language": "en",
"companyId": "77848abe-a215-41b7-8950-86e89ea1fadc",
"companyName": "Santos",
"companyTickers": [
"STO.AX"
],
"originalFileUrl": "https://files.captide.co/original-docs/...",
"markdownFileUrl": "https://files.captide.co/markdown-docs/...",
"metadata": {}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Get Document by ID
Fetch a document by its ID from the database, including company and ticker info.
This v2 endpoint includes several improvements over v1:
- Supports newer document categories (e.g., earnings-presentation, investor-event-presentation, shareholder-meeting-circular, etc.)
- Renamed fields: tickers → companyTickers, formType → secFormType
- Added fields: companyId, fiscalPeriod, language
curl --request GET \
--url https://rest-api.captide.co/api/v2/documents/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://rest-api.captide.co/api/v2/documents/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://rest-api.captide.co/api/v2/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rest-api.captide.co/api/v2/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest-api.captide.co/api/v2/documents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rest-api.captide.co/api/v2/documents/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest-api.captide.co/api/v2/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "a586df65-76d8-4b04-864c-ceed76592f4d",
"documentCategory": "interim-financial-report",
"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.",
"date": "2025-04-17",
"fiscalQuarter": 1,
"fiscalYear": 2025,
"fiscalPeriod": "quarter",
"language": "en",
"companyId": "77848abe-a215-41b7-8950-86e89ea1fadc",
"companyName": "Santos",
"companyTickers": [
"STO.AX"
],
"originalFileUrl": "https://files.captide.co/original-docs/...",
"markdownFileUrl": "https://files.captide.co/markdown-docs/...",
"metadata": {}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Path Parameters
Document file ID
"a586df65-76d8-4b04-864c-ceed76592f4d"
Response
Document found successfully
V2 response model for document retrieval by ID. Uses database category codes directly.
Unique document ID
Unique ID of the company filing the document
Secure and temporary URL providing access to the original document file
Secure and temporary URL providing access to the pre-processed, machine-readable document file
Document SEC form type (only applicable if the document is an SEC filing)
Captide-generated document title
Captide-generated document description
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)
Fiscal quarter the document relates to (from 1 to 4)
Fiscal year the document relates to (e.g., 2024)
Fiscal period the document relates to. Valid values: year, multi-year, month, half-year, quarter, or null
Language of the document in ISO 639-1 code
Name of the company filing the document
Tickers of the company filing the document
Additional document metadata (e.g., accessionNumber, 8kItems)
Was this page helpful?