Skip to main content
GET
/
v1
/
companies
/
{cik}
/
filings
/
sentiment
List sentiment-scored filings for a company
curl --request GET \
  --url https://api.ivory.finance/v1/companies/{cik}/filings/sentiment \
  --header 'X-API-Key: <api-key>'
[
  {
    "accession_number": "<string>",
    "avg_v_negative": 123,
    "avg_negative": 123,
    "avg_neutral": 123,
    "avg_positive": 123,
    "avg_v_positive": 123,
    "avg_sentiment_score": 123,
    "dominant_label": "<string>",
    "chunks_analyzed": 123,
    "model": "<string>",
    "analyzed_at": "2023-11-07T05:31:56Z",
    "cik": "<string>",
    "ticker": "<string>",
    "company_name": "<string>",
    "form_type": "<string>",
    "filing_date": "2023-12-25",
    "period_of_report": "2023-12-25"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.ivory.finance/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
cik
string
required

Query Parameters

​
form_type
string | null

Filter by form type, e.g. 10-K, 10-Q, 8-K

​
dominant_label
string | null

Filter by dominant sentiment: v.negative | negative | neutral | positive | v.positive

​
from_date
string | null

Start date YYYY-MM-DD (inclusive)

​
to_date
string | null

End date YYYY-MM-DD (inclusive)

​
limit
integer
default:50
Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

​
accession_number
string
required
​
avg_v_negative
number
required
​
avg_negative
number
required
​
avg_neutral
number
required
​
avg_positive
number
required
​
avg_v_positive
number
required
​
avg_sentiment_score
number
required
​
dominant_label
string
required
​
chunks_analyzed
integer
required
​
model
string
required
​
analyzed_at
string<date-time>
required
​
cik
string | null
​
ticker
string | null
​
company_name
string | null
​
form_type
string | null
​
filing_date
string<date> | null
​
period_of_report
string<date> | null