curl --request GET \
--url https://api.bigdata.com/v1/documents/{document_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/documents/{document_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{
"url": "https://documents.bigdata.com/documents/776769957735667D2F01F695EF4F1231?signature=abc123...",
"web_content": false
}Fetch document
Returns a time-limited pre-signed URL for downloading the document in annotated (structured) JSON format. Issuing a GET request to that URL returns the document’s content, metadata, and annotations. The URL expires after 24 hours; request a new one when it does.
This endpoint works for any document in Bigdata, whether it originates from the RavenPack catalog or from your own processed files.
When web_content is true, the returned document also includes a direct URL to the publisher’s original article on the web.
curl --request GET \
--url https://api.bigdata.com/v1/documents/{document_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_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://api.bigdata.com/v1/documents/{document_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/documents/{document_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{
"url": "https://documents.bigdata.com/documents/776769957735667D2F01F695EF4F1231?signature=abc123...",
"web_content": false
}Authorizations
Path Parameters
The unique 32-character MD5 hex identifier for the document (e.g., 776769957735667D2F01F695EF4F1231).
^[A-F0-9]{32}$"776769957735667D2F01F695EF4F1231"
Response
An object with a url and a web_content field is returned. When web_content is true, the returned document contains a direct link to the original web page in addition to the full analytics.
When you access the URL, you receive the complete document in JSON format with the structure: document (metadata), content (title and body blocks) and analytics (document-level metrics, events array, entities array). In the case of transcript-style documents, the document metadata includes normalized event context (participants, reporting fields, timestamps_utc). This is available for Factset documents, other providers like Quartr or Third Bridge will be available soon.
"https://documents.bigdata.com/documents/776769957735667D2F01F695EF4F1231?signature=abc123..."
true when is a public URL.
false
Returned by URL - Document metadata including source information, timestamps, and details.
Show child attributes
Show child attributes
Returned by URL - Document content including title, body blocks, entities, and sentences.
Show child attributes
Show child attributes
Returned by URL - Document-level analytics, events array, and entities array.
Show child attributes
Show child attributes
Returned by URL - Optional pipeline build stamps when present.
Show child attributes
Show child attributes
Was this page helpful?