Short Interest
curl --request POST \
--url https://api.bigdata.com/v1/short-interest/query \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"identifier": {
"type": "rp_entity_id",
"value": [
"86170D",
"D8442A"
]
}
}
'import requests
url = "https://api.bigdata.com/v1/short-interest/query"
payload = { "identifier": {
"type": "rp_entity_id",
"value": ["86170D", "D8442A"]
} }
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({identifier: {type: 'rp_entity_id', value: ['86170D', 'D8442A']}})
};
fetch('https://api.bigdata.com/v1/short-interest/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/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([
'identifier' => [
'type' => 'rp_entity_id',
'value' => [
'86170D',
'D8442A'
]
]
]),
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/query"
payload := strings.NewReader("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": [\n \"86170D\",\n \"D8442A\"\n ]\n }\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/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": [\n \"86170D\",\n \"D8442A\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/short-interest/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 \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": [\n \"86170D\",\n \"D8442A\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"results": {},
"metadata": {
"listings": {
"86170D": {
"mic": "XNYS",
"ticker": "SPOT"
}
},
"request_id": "<string>",
"timestamp": "<string>"
},
"errors": [
{
"message": "<string>"
}
],
"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
}Market Data
Short Interest
Returns how much of a company’s stock is sold short on the latest day with data, how quickly short sellers could exit, what borrowing the shares costs, how the position changed over 5 days to a year, and where each figure stands against its past year.
Request up to 50 companies at a time by RavenPack entity ID. results is keyed by
entity ID in request order, null for a company with no short interest data;
metadata.listings names the listing each company’s figures are for, null when
the company has no listing with short interest coverage. A plan that does not
include short interest data gets a 403.
POST
/
v1
/
short-interest
/
query
Short Interest
curl --request POST \
--url https://api.bigdata.com/v1/short-interest/query \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"identifier": {
"type": "rp_entity_id",
"value": [
"86170D",
"D8442A"
]
}
}
'import requests
url = "https://api.bigdata.com/v1/short-interest/query"
payload = { "identifier": {
"type": "rp_entity_id",
"value": ["86170D", "D8442A"]
} }
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({identifier: {type: 'rp_entity_id', value: ['86170D', 'D8442A']}})
};
fetch('https://api.bigdata.com/v1/short-interest/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/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([
'identifier' => [
'type' => 'rp_entity_id',
'value' => [
'86170D',
'D8442A'
]
]
]),
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/query"
payload := strings.NewReader("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": [\n \"86170D\",\n \"D8442A\"\n ]\n }\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/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": [\n \"86170D\",\n \"D8442A\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/short-interest/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 \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": [\n \"86170D\",\n \"D8442A\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"results": {},
"metadata": {
"listings": {
"86170D": {
"mic": "XNYS",
"ticker": "SPOT"
}
},
"request_id": "<string>",
"timestamp": "<string>"
},
"errors": [
{
"message": "<string>"
}
],
"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
application/json
Response
Successful Response
Was this page helpful?