Entity Sentiment

Returns a time series of daily sentiment metrics for a single entity over a specified date range. Sentiment is a quantified signal derived from unstructured text using rule-based and machine-learning methods, indicating likely positive or negative market impact. The response includes daily_sentiment (mean sentiment), sentiment_pressure (abnormal sentiment intensity), and abnormal_media_attention (abnormal media volume).

POST /v1/entity-sentiment

Try it

Entity Sentiment

cURL

curl --request POST \
  --url https://api.bigdata.com/v1/entity-sentiment/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "identifier": {
    "type": "rp_entity_id",
    "value": "4A6F00"
  },
  "timestamp": {
    "start": "2025-01-01",
    "end": "2025-01-20"
  }
}
'

200

{
  "results": {
    "name": "<string>",
    "id": "<string>",
    "values": [
      {
        "date": "<string>",
        "daily_sentiment": 0.017404,
        "sentiment_pressure": 0.217784,
        "abnormal_media_attention": -0.833533
      }
    ]
  },
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  },
  "errors": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Query model for time series sentiment request.

identifier · Identifier · object · required

Object specifying which identifier you are using to request the sentiment data. You must supply one type and its corresponding value or a list of entities.

Show child attributes

identifier. type · enum<string> · default: rp_entity_id · required

The identifier namespace. Currently only rp_entity_id is supported.

Available options: rp_entity_id

identifier. value · required

Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (4A6F00)

Example:

"4A6F00"

timestamp · QueryDateRange · object · required

The time range for retrieving sentiment data. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'.

Show child attributes

timestamp. start · string<date> | null

The start date of the time range for retrieving daily prices. Only prices occurring on or after this date will be included. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'

Example:

"2025-01-01"

timestamp. end · string<date> | null

The end date of the time range for retrieving daily prices. Only prices occurring on or before this date will be included. The expected date format is 'YYYY-MM-DD', for example, '2025-09-03'.

Example:

"2025-01-20"

Response

200

application/json

Successful Response

Public API response for time series sentiment query.

results · TimeSeriesSentimentResults · object · required

Sentiment time series results

Show child attributes

results. name · string · required

Company name

results. id · string · required

RP entity identifier

results. values · SentimentDataPoint · object[] · required

List of sentiment data points

Show child attributes

results.values. date · string · required

Date in YYYY-MM-DD format

results.values. daily_sentiment · number | null

Mean event sentiment score

Example:

0.017404

results.values. sentiment_pressure · number | null

Abnormal sentiment indicator

Example:

0.217784

results.values. abnormal_media_attention · number | null

Abnormal media volume indicator

Example:

-0.833533

metadata · Metadata · object · required

Request metadata including request ID and timestamp.

Show child attributes

metadata. request_id · string · required

metadata. timestamp · string

errors · ErrorDetail · object[]

List of errors encountered while fetching data.

Show child attributes

errors. message · string | null