Company Topics

Returns the top topics for a company with all 7 metrics: mentions, relevance, momentum, trend, positive, negative, affinity.

• mentions: Total keyword occurrences across documents in the window.
• relevance: Average cosine similarity between document embeddings and the topic embedding vector (0–1).
• momentum: Rate of change — (current_mentions − avg_last_4_qtrs) / stddev_last_4_qtrs. Positive = accelerating; negative = declining.
• trend: “rising” (momentum > 0.5), “falling” (< −0.5), “stable”.
• positive / negative: Average GPT-4o-mini sentiment scores (0–1) for sentences surrounding topic keyword matches.
• affinity: company_relevance / peer_avg_relevance. > 1 means the company is more associated with this topic than its peers; < 1 means less.

GET /v1/companies/{cik}/topics

Aggregated topic scores for a company

cURL

curl --request GET \
  --url https://api.ivory.finance/v1/companies/{cik}/topics \
  --header 'X-API-Key: <api-key>'

200

{
  "cik": "<string>",
  "period": {},
  "topics": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "category": "<string>",
      "mentions": 123,
      "relevance": 123,
      "recent_relevance": 123,
      "trend": "<string>",
      "positive": 123,
      "negative": 123,
      "momentum": 123,
      "affinity": 123,
      "latest_snippet": "<string>",
      "latest_source": {
        "form_type": "<string>",
        "doc_date": "2023-12-25",
        "source_ref": "<string>",
        "source_type": "<string>"
      }
    }
  ],
  "company_name": "<string>",
  "ticker": "<string>"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

cik · string · required

Query Parameters

date_from · string<date> | null

Window start (default: 2 years ago)

date_to · string<date> | null

Window end (default: today)

source_type · string · default: all

all | filing | transcript | exhibit

category · string | null

Filter by topic category

limit · integer · default: 20

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

cik · string · required

period · Period · object · required

topics · TopicScore · object[] · required

Show child attributes

company_name · string | null

ticker · string | null