Skip to main content
POST
Short Interest

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
ShortInterestIdentifier · object
required

The companies, by RavenPack entity id.

Response

Successful Response

results
Results · object
required

Each company's short interest keyed by entity id, one key per distinct id sent, upper-cased, in the order they were sent. null for a company with no short interest data.

metadata
ShortInterestMetadata · object
required
errors
ErrorDetail · object[] | null
sources
Source · object[] | null

Structured-data sources the response was built from, one entry per source. Empty when no catalog source contributed.

usage
Usage · object | null

Tokens the request consumed, per content tier. Returned only to callers billed in tokens.