--- title: "Amendment (10-K/A) summary for an entity — counts + per-concept diff" method: GET path: "/api/v1/entities/{entity_id}/amendments-summary" tags: ["Entities"] --- # Amendment (10-K/A) summary for an entity — counts + per-concept diff `GET /api/v1/entities/{entity_id}/amendments-summary` ## Request - Base URL: `https://api.hub-equity.com` - URL: `https://api.hub-equity.com/api/v1/entities/{entity_id}/amendments-summary` - Auth: HTTP bearer Lists an entity's amendments (base 10-K → amendment pairs) with per-amendment concept counts (added / modified / unchanged) and, when the diff is materialized, the per-concept changes. Falls back to listing 10-K/A filings (with a note) when the structured diff is not yet materialized. DISTINCT from `/entities/{id}/amendments` (a different model/shape) — use this one for the summary view ; for flattened per-concept restatement deltas use `/entities/{id}/restatements/diff`. ## Path parameters - `entity_id` string, required ## Query parameters - `fiscal_year` integer, nullable: Restrict to one fiscal year's amendment. Omit for all. ## Response `200` Amendment summary for the entity. - ApiResponseAmendmentsResult - `success` boolean, required - `data` AmendmentsResult - `entity_id` string, required - `entity_name` string, required - `amendments` HubEquityMcpToolsGetAmendmentsAmendment[], required - `fiscal_year` integer, required - `amendment_date` string, nullable - `base_filing` Source: Filing source for a fact (always attached so the LLM can cite). `anchor` says what kind of number this is: `tagged` (read off one tag of the issuer) or `derived` (computed by Hub-Equity from several tags, so no single place in the document holds it, by construction). `fact_url` opens the issuer's own document AT the tagged number (the iXBRL element id, resolved in the filing that SERVES the value, which is not always the filing of that fiscal year); it is served by `get_fact` and on the parent of `get_fact_decomposition`, and left empty by `get_metric_history`, whose points carry `anchor` only: one `get_fact` call gives the deep link of the point to cite. - `filing_id` string, required - `form_type` string, nullable - `filing_date` string, nullable - `period_end` string, nullable - `viewer_url` string, required: Hub-Equity deep link to the filing - `external_url` string, nullable: Original filing URL (e.g. SEC EDGAR viewer) when available - `anchor` 'tagged' | 'derived', nullable: tagged = the value is one tag of the issuer's document; derived = computed by Hub-Equity from several tags, no single anchor exists by construction - `fact_url` string, nullable: The issuer's document opened AT the tagged number (iXBRL viewer anchored on the fact id), served by get_fact and the decomposition parent when the id resolved in the serving filing; empty on history points: call get_fact for the year to cite - `amendment_filing` Source: Filing source for a fact (always attached so the LLM can cite). `anchor` says what kind of number this is: `tagged` (read off one tag of the issuer) or `derived` (computed by Hub-Equity from several tags, so no single place in the document holds it, by construction). `fact_url` opens the issuer's own document AT the tagged number (the iXBRL element id, resolved in the filing that SERVES the value, which is not always the filing of that fiscal year); it is served by `get_fact` and on the parent of `get_fact_decomposition`, and left empty by `get_metric_history`, whose points carry `anchor` only: one `get_fact` call gives the deep link of the point to cite. - `filing_id` string, required - `form_type` string, nullable - `filing_date` string, nullable - `period_end` string, nullable - `viewer_url` string, required: Hub-Equity deep link to the filing - `external_url` string, nullable: Original filing URL (e.g. SEC EDGAR viewer) when available - `anchor` 'tagged' | 'derived', nullable: tagged = the value is one tag of the issuer's document; derived = computed by Hub-Equity from several tags, no single anchor exists by construction - `fact_url` string, nullable: The issuer's document opened AT the tagged number (iXBRL viewer anchored on the fact id), served by get_fact and the decomposition parent when the id resolved in the serving filing; empty on history points: call get_fact for the year to cite - `concepts_added` integer - `concepts_modified` integer - `concepts_unchanged` integer - `changes` HubEquityMcpToolsGetAmendmentsAmendmentChange[]: Per-concept diff. Empty when only filing pair detected, no diff materialized. - `hub_concept_code` string, nullable - `fiscal_period` string, nullable - `period_end` string, nullable - `old_value` number, nullable - `new_value` number, nullable - `diff_pct` number, nullable: In percent (21.5 = 21.5 %) - `kind` string, nullable: added / modified / unchanged - `notes` string[] - `error` ApiError: API error details. - `code` string, required - `message` string, required - `details` object, nullable - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints. - `timestamp` string, date-time - `request_id` string, nullable - `page` integer, nullable - `per_page` integer, nullable - `total` integer, nullable - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer). - `self` string, nullable - `first` string, nullable - `prev` string, nullable - `next` string, nullable - `last` string, nullable ## Other responses - `404`: Entity not found. - `422`: Validation Error --- [API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)