---
title: "Inspector payload for one restatement"
method: GET
path: "/api/v1/entities/{entity_id}/amendments/inspector"
tags: ["Entities"]
---

# Inspector payload for one restatement

`GET /api/v1/entities/{entity_id}/amendments/inspector`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/entities/{entity_id}/amendments/inspector`
- Auth: HTTP bearer

Single-call payload for one amended value. Returns the enriched change, filing context with SEC EDGAR URLs, companion changes (other concepts amended in the same 10-K/A), and the concept time-series sparkline data.

## Path parameters

- `entity_id` string, required

## Query parameters

- `concept` string, required: Hub concept code (e.g. REVENUE)
- `fy` integer, required: Fiscal year of the amendment

## Response `200`

Successful Response

- ApiResponseInspectorPayload
  - `success` boolean, required
  - `data` InspectorPayload: Single payload for the amendment inspector. Returned by GET /entities/{id}/amendments/inspector?concept=X&fy=Y. Bundles the change, the amendment, its companion changes and the concept history in one call.
    - `entity_id` string, required
    - `entity_name` string, required
    - `change` SrcModelsSchemasAmendmentChange, required: One concept-level diff between a 10-K and its 10-K/A. Carries hub_concept_name, hub_concept_category, diff_abs and materiality so the change can be rendered without further lookups.
      - `hub_concept_code` string, required
      - `fiscal_period` string, nullable, required
      - `period_end` string, nullable, required
      - `old_value` number, nullable, required
      - `new_value` number, nullable, required
      - `diff_pct` number, nullable, required
      - `kind` 'added' | 'modified', required
      - `hub_concept_name` string, nullable
      - `hub_concept_category` string, nullable
      - `diff_abs` number, nullable
      - `materiality` 'none' | 'low' | 'medium' | 'high'
    - `amendment` InspectorAmendment, required: Filing-level context shown in the Inspector Drawer header.
      - `id` string, required
      - `base_filing_id` string, required
      - `amendment_filing_id` string, required
      - `amendment_date` string, required
      - `fiscal_year` integer, required
      - `amendment_filing_url` string, nullable
      - `base_filing_url` string, nullable
      - `cik` string, nullable
      - `form_type` string, nullable
      - `base_form_type` string, nullable
    - `companion_changes` SrcModelsSchemasAmendmentChange[], required
      - `hub_concept_code` string, required
      - `fiscal_period` string, nullable, required
      - `period_end` string, nullable, required
      - `old_value` number, nullable, required
      - `new_value` number, nullable, required
      - `diff_pct` number, nullable, required
      - `kind` 'added' | 'modified', required
      - `hub_concept_name` string, nullable
      - `hub_concept_category` string, nullable
      - `diff_abs` number, nullable
      - `materiality` 'none' | 'low' | 'medium' | 'high'
    - `concept_history` ConceptHistoryPoint[], required
      - `fiscal_year` integer, required
      - `period_end` string, nullable
      - `fiscal_period` string, nullable
      - `value` number, nullable
      - `is_amendment` boolean
      - `previous_value` number, nullable
    - `later_restatement` LaterRestatement: The next correction of a cell, when a later document corrected it again (a cell can be corrected by a 10-K/A and then by the comparative column of a later 10-K). ``delta_percent`` is measured against the value set by the amendment.
      - `value` number, nullable
      - `delta_percent` number, nullable
      - `form_type` string, nullable
      - `filing_date` string, nullable
      - `fiscal_year` integer, nullable
    - `data_quality_warning` string, nullable
  - `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

- `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)