curl --request POST \
--url https://api.bigdata.com/v1/short-interest/history/query \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"from_date": "2026-01-02",
"identifier": {
"type": "rp_entity_id",
"value": "86170D"
},
"metrics": [
"short_interest",
"days_to_cover"
],
"to_date": "2026-06-30"
}
'import requests
url = "https://api.bigdata.com/v1/short-interest/history/query"
payload = {
"from_date": "2026-01-02",
"identifier": {
"type": "rp_entity_id",
"value": "86170D"
},
"metrics": ["short_interest", "days_to_cover"],
"to_date": "2026-06-30"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from_date: '2026-01-02',
identifier: {type: 'rp_entity_id', value: '86170D'},
metrics: ['short_interest', 'days_to_cover'],
to_date: '2026-06-30'
})
};
fetch('https://api.bigdata.com/v1/short-interest/history/query', 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/short-interest/history/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from_date' => '2026-01-02',
'identifier' => [
'type' => 'rp_entity_id',
'value' => '86170D'
],
'metrics' => [
'short_interest',
'days_to_cover'
],
'to_date' => '2026-06-30'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/short-interest/history/query"
payload := strings.NewReader("{\n \"from_date\": \"2026-01-02\",\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"86170D\"\n },\n \"metrics\": [\n \"short_interest\",\n \"days_to_cover\"\n ],\n \"to_date\": \"2026-06-30\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/short-interest/history/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from_date\": \"2026-01-02\",\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"86170D\"\n },\n \"metrics\": [\n \"short_interest\",\n \"days_to_cover\"\n ],\n \"to_date\": \"2026-06-30\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/short-interest/history/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_date\": \"2026-01-02\",\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"86170D\"\n },\n \"metrics\": [\n \"short_interest\",\n \"days_to_cover\"\n ],\n \"to_date\": \"2026-06-30\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"date": "2026-11-13",
"shares_short": 3276922,
"shares_short_value_usd": 2007540537,
"percent_of_free_float": 2.086555,
"days_to_cover": 2.0307,
"cost_to_borrow": 0.44,
"cost_to_borrow_new_loans": 0.51,
"shares_available_to_borrow": 1918,
"shares_available_to_borrow_count": 68799744,
"short_score": 32.2402
}
],
"metadata": {
"rp_entity_id": "4A6F00",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"metrics": [
"short_interest"
],
"days_to_cover_period": "1W",
"request_id": "<string>",
"timestamp": "<string>",
"listing": {
"mic": "XNYS",
"ticker": "SPOT"
}
},
"errors": [
{
"message": "<string>"
}
],
"pagination": {
"cursor": "00000DexaRK4NT6t",
"has_cursor": true
},
"sources": [
{
"id": "CA9FA3",
"name": "Corporate Fundamentals"
}
],
"usage": {}
}{
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Too many requests. Please try again later.",
"statusCode": 429
}{
"message": "Internal Server Error",
"statusCode": 500
}Short Interest History
Returns one company’s daily short interest over a window: shares sold short, days to cover, the cost to borrow, the shares still available to borrow and the short score, one row per trading day, oldest first.
One company per request, keyed by RavenPack entity ID. Pick the figures with
metrics; the fields of any other metric are left out of every row, and a field
is null on a day its metric has no value. Results are
paged: send back pagination.cursor with the same request to get the next page,
and keep going until pagination.has_cursor is false. A company with no listing
with short interest coverage comes back with an empty results and no
metadata.listing. A plan that does not include short interest data gets a 403.
curl --request POST \
--url https://api.bigdata.com/v1/short-interest/history/query \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"from_date": "2026-01-02",
"identifier": {
"type": "rp_entity_id",
"value": "86170D"
},
"metrics": [
"short_interest",
"days_to_cover"
],
"to_date": "2026-06-30"
}
'import requests
url = "https://api.bigdata.com/v1/short-interest/history/query"
payload = {
"from_date": "2026-01-02",
"identifier": {
"type": "rp_entity_id",
"value": "86170D"
},
"metrics": ["short_interest", "days_to_cover"],
"to_date": "2026-06-30"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from_date: '2026-01-02',
identifier: {type: 'rp_entity_id', value: '86170D'},
metrics: ['short_interest', 'days_to_cover'],
to_date: '2026-06-30'
})
};
fetch('https://api.bigdata.com/v1/short-interest/history/query', 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/short-interest/history/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from_date' => '2026-01-02',
'identifier' => [
'type' => 'rp_entity_id',
'value' => '86170D'
],
'metrics' => [
'short_interest',
'days_to_cover'
],
'to_date' => '2026-06-30'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/short-interest/history/query"
payload := strings.NewReader("{\n \"from_date\": \"2026-01-02\",\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"86170D\"\n },\n \"metrics\": [\n \"short_interest\",\n \"days_to_cover\"\n ],\n \"to_date\": \"2026-06-30\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/short-interest/history/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from_date\": \"2026-01-02\",\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"86170D\"\n },\n \"metrics\": [\n \"short_interest\",\n \"days_to_cover\"\n ],\n \"to_date\": \"2026-06-30\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/short-interest/history/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_date\": \"2026-01-02\",\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"86170D\"\n },\n \"metrics\": [\n \"short_interest\",\n \"days_to_cover\"\n ],\n \"to_date\": \"2026-06-30\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"date": "2026-11-13",
"shares_short": 3276922,
"shares_short_value_usd": 2007540537,
"percent_of_free_float": 2.086555,
"days_to_cover": 2.0307,
"cost_to_borrow": 0.44,
"cost_to_borrow_new_loans": 0.51,
"shares_available_to_borrow": 1918,
"shares_available_to_borrow_count": 68799744,
"short_score": 32.2402
}
],
"metadata": {
"rp_entity_id": "4A6F00",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"metrics": [
"short_interest"
],
"days_to_cover_period": "1W",
"request_id": "<string>",
"timestamp": "<string>",
"listing": {
"mic": "XNYS",
"ticker": "SPOT"
}
},
"errors": [
{
"message": "<string>"
}
],
"pagination": {
"cursor": "00000DexaRK4NT6t",
"has_cursor": true
},
"sources": [
{
"id": "CA9FA3",
"name": "Corporate Fundamentals"
}
],
"usage": {}
}{
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Too many requests. Please try again later.",
"statusCode": 429
}{
"message": "Internal Server Error",
"statusCode": 500
}Body
Which metrics the rows carry; every metric when left out. short_interest fills shares_short, shares_short_value_usd and percent_of_free_float; cost_to_borrow fills cost_to_borrow and cost_to_borrow_new_loans; shares_available_to_borrow fills shares_available_to_borrow and shares_available_to_borrow_count; the others fill the field of the same name.
1A group of figures the series can carry.
short_interest, days_to_cover, cost_to_borrow, shares_available_to_borrow, short_score ["short_interest", "days_to_cover"]
Response
Successful Response
Was this page helpful?