---
title: "Per-ticker news-flow sentiment + attention"
method: GET
path: "/api/v1/equities/{symbol}/news-sentiment"
tags: ["Equities Indices"]
---

# Per-ticker news-flow sentiment + attention

`GET /api/v1/equities/{symbol}/news-sentiment`

## Request

- Base URL: `https://sugra.ai`
- URL: `https://sugra.ai/api/v1/equities/{symbol}/news-sentiment`
- Auth: API key in header `x-api-key`

Primary news-flow sentiment + attention for a ticker, entirely from Sugra-owned sources: GDELT tone + volume timelines and the first-party RSS news feeds (list: /api/v1/news/sources), entity-linked via the SEC registrant name + former names (so coverage filed under an old name is still matched). Tone and volume are read from the GDELT files Sugra already stores. The served window is 24 hours. Requested values 3days, 2weeks and 1month stay accepted and come back as timespan 24h with window_capped. This is editorial NEWS-FLOW sentiment, the defensible alternative to scraped social mention-counting. It does not capture retail crowd psychology or pre-news buzz. Cached 10 min. Not investment advice.

## Path parameters

- `symbol` string, required: Company ticker symbol.

## Query parameters

- `timespan` string: Accepted lookback: 3days, 2weeks, 1month. The measurement is the stored 24 hour file window.

## Response `200`

Sentiment (GDELT average document tone) and attention (coverage volume + first-party article count) time series for the company, plus recent first-party headlines.

- EnvelopeNewsSentimentData
  - `data` NewsSentimentData, required: Per-ticker news-flow sentiment + attention from owned sources.
    - `symbol` string, required
    - `company_name` string, required
    - `former_names` string[]
    - `cik` string, nullable: SEC CIK of the resolved filer. Null when the registry could not be reached.
    - `match_basis` string: What the headlines were matched on. 'entity' = the registered legal name and its former names. 'symbol' = the bare ticker, used when the registry was unreachable; precision is lower, and much lower for tickers that are ordinary words (ALL, IT, ON, KEY, CAR, GO).
    - `entity_unavailable_reason` string, nullable: Null when the SEC registry answered. A reason string when it did not, in which case company_name falls back to the symbol and former_names is empty because it could not be looked up - not because the company never had another name.
    - `query` string, required: The entity query (current + former names) used.
    - `timespan` string, required
    - `sentiment` SentimentBlock, required
      - `latest_tone` number, nullable
      - `average_tone` number, nullable
      - `timeline` TimelinePoint[]
        - `date` string, required
        - `value` number, required
      - `scale` string, required
      - `unavailable_reason` string, nullable: Null when tone was measured. A reason string when the tone source could not be reached, so a null tone with a reason is never read as neutral sentiment.
    - `attention` AttentionBlock, required
      - `timeline` TimelinePoint[]: Coverage-volume time series.
        - `date` string, required
        - `value` number, required
      - `first_party_article_count` integer
      - `unavailable_reason` string, nullable: Null when coverage volume was measured. A reason string when the source could not be reached, so an empty series with a reason is never read as an absence of coverage.
    - `no_articles_matched` boolean, nullable: True only when the search ran on the RESOLVED entity, every source answered, and none of them had anything in the window. Null otherwise - including when match_basis is 'symbol', because that search ran on the bare ticker and finding nothing with it is not the same claim. An empty response without this flag was either not measured (see the unavailable_reason fields) or measured with a weaker query, and those mean different things: one is a fact about the company, the others are reasons to doubt.
    - `recent_headlines` NewsHeadline[]
      - `title` string, nullable
      - `source` string, nullable
      - `published` string, nullable
      - `url` string, nullable
    - `source` string
    - `note` string, required
  - `meta` SugraMeta, required: Metadata on a /api/v1/* response envelope built through `helpers.response.sugra_response`, which is how routes are expected to answer. A route that assembles its own `meta` dict carries only the keys it writes itself, so an optional field below can be absent because this response has nothing to report OR because that route does not build its envelope here - the two are not distinguishable from the outside.
    - `endpoint` string, required: Requested endpoint path.
    - `data_time` string, required: ISO 8601 timestamp the data on this response is stamped with. It is the source's own timestamp whenever the source supplied one this API could read; when it did not, this field falls back to the value of `response_time` and `data_age_days` is omitted, so the PRESENCE of that field is the signal to read - with the one exception named in its own description, a route that substitutes its own current time for a source timestamp it never received. Usually UTC (`Z`), but a source stating its own numeric offset keeps it (2026-04-16T14:30:00+09:00) rather than being converted a second time. For a source that publishes by period this is the period's START (see `period`) and for one that publishes by calendar day it is that day's midnight - in neither case a moment at which anything was observed or released.
    - `response_time` string, required: ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required: API name and version.
    - `data_age_days` number, nullable: Age of the data in days at the moment this response was produced, i.e. `response_time` minus `data_time`. Present ONLY when the timestamp this response is stamped with is a clock time that could be read as a real instant. It is ABSENT - never 0 - in every other case. Absent when no readable source timestamp was supplied, because `data_time` then repeats `response_time` and a zero age would assert that the data is current precisely where its true age is unknown. Absent when the source names a calendar day, a month, a quarter or a year (see `period`): the instant is then a boundary this API anchored at midnight, and time since a day or a quarter BEGAN is a different quantity from the age of the data - a daily series is out by up to a day, a quarterly one by up to a quarter. A midnight counts as such a boundary whichever zone it is stated in, and whether the source stated it or this API anchored it. The one case this field cannot see is a route that substitutes its own current time for a source timestamp it never received: the substituted value is a real, readable instant and is indistinguishable from one the source stated, so the age reads as roughly 0. The shared cache-and-fetch helper behind most routes stopped doing that, but the presence of this field is a statement about the timestamp the response carries, not a guarantee about the route that supplied it. Rounded to 0.001 day (86.4 seconds), so 0.0 is a real measured age anywhere within roughly +/-43 seconds and not a stand-in for unknown; a source stamping an instant in the future reports a negative value (-0.001 or less) rather than being clamped. Sources publish on very different cadences, so a non-zero age is normal, not an error. Preserve absence in client code: a generated client that materialises a missing optional number as its numeric default turns 'age unknown' back into 'age zero', which is the exact confusion this field exists to remove.
    - `source` string, nullable: Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable: Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable: True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable: Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable: True when this response was served from the internal cache.
    - `stale` boolean, nullable: True when the response is known stale under its source freshness policy, or when a cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.
    - `stale_since` string, nullable: ISO 8601 UTC timestamp of the last good copy this response was served from. Present only when stale is true.
    - `period` string, nullable: Unit of observation, when the source publishes by period rather than by instant. `data_time` carries the period's START instant so it stays machine-readable; this field preserves what that instant used to mean, which the conversion would otherwise erase. Present only for such sources, and only when the source hands the API the label itself - a client that converts the period to its start instant before building the envelope loses the label, though not the age exclusion, which is decided by the instant. Note that `data_age_days` is omitted whenever this is present, because an age measured from a period start is not a freshness figure.
    - `notes` string, nullable: Data-quality caveat about THIS response - how old the underlying report is, a chokepoint AIS lower-bound, or that a source-reported `data_time` could not be read and the response time is shown instead. Distinct from `attribution`, which is a licensing obligation. Multiple caveats are joined with ' | '. Present only when there is one.

## Other responses

- `400`: Invalid ticker symbol or timespan.
- `401`: Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `404`: Symbol not resolvable to an SEC filer.
- `422`: Validation Error
- `429`: Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `500`: This API answered a shape its own schema refuses. Typed body `error: response_shape_invalid`. Stays a 500. Not an upstream failure.
- `502`: News-sentiment sources temporarily unavailable.
- `503`: Upstream source is temporarily unavailable. Retry after a short delay.

## Changes

> 46 revisions in range; 1 not diffed.

- **2026-10-22** `bb59bcb0e35f`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-09-13** `d2472ec2cf81`: 1 info
  - added the non-success response with the status `500`
- **2026-09-09** `4f8853a61440`: 1 info
  - added the optional property `meta/stale_since` to the response with the `200` status
- **2026-09-01** `328d061c12ca`: 3 info
  - added the optional property `meta/data_age_days` to the response with the `200` status
  - added the optional property `meta/notes` to the response with the `200` status
  - added the optional property `meta/period` to the response with the `200` status
- **2026-08-20** `652554d2aae1`: 1 info
  - added the optional property `data/no_articles_matched` to the response with the `200` status

[Operation history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/equities/:symbol/news-sentiment/get.md)

---

[API](https://skmtc.dev/sugra/apis/sugra-api.md) · [All operations](https://skmtc.dev/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sugra/apis/sugra-api/revisions/bb59bcb0e35f?raw)