---
title: "Get income statement flow data for Sankey diagram"
method: GET
path: "/api/v1/entities/{entity_id}/financials/flow"
tags: ["Financials"]
---

# Get income statement flow data for Sankey diagram

`GET /api/v1/entities/{entity_id}/financials/flow`

## Request

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

Get Sankey flow data for income statement visualization.

## Path parameters

- `entity_id` string, required

## Query parameters

- `year` integer, nullable: Fiscal year (defaults to latest)

## Response `200`

Successful Response

- ApiResponseFlowResponse
  - `success` boolean, required
  - `data` FlowResponse: Sankey / flow response for income statement visualization.
    - `entity_id` string, required
    - `entity_name` string, required
    - `fiscal_year` integer, required
    - `currency` string, nullable, required
    - `nodes` SankeyNode[], required
      - `id` string, required
      - `label` string, required
      - `value` number, nullable, required
      - `category` string, required
      - `confidence` number, nullable
      - `provenance` string, nullable
    - `links` SankeyLink[], required
      - `source` string, required
      - `target` string, required
      - `value` number, required
      - `is_subtraction` boolean
    - `available_years` integer[], required
    - `empty_reason` 'no_anchor' | 'no_revenue_ever' | 'extraction_gap', nullable
    - `empty_reason_year` integer, 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)