---
title: "Insight into income, grouped by category."
method: GET
path: "/v1/insight/income/category"
tags: ["insight"]
---

# Insight into income, grouped by category.

`GET /v1/insight/income/category`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/insight/income/category`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

This endpoint gives a summary of the income received by the user, grouped by (any) category.

## Query parameters

- `start` string, date, required
- `end` string, date, required
- `categories[]` integer[]
- `accounts[]` integer[]

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of category and income details. Each category has one row per currency.

- InsightGroupEntry[]
  - `id` string, string: This ID is a reference to the original object.
  - `name` string, string: This is the name of the object.
  - `difference` string, string: The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts.
  - `difference_float` number, double: The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.
  - `currency_id` string, string: The currency ID of the expenses listed for this account.
  - `currency_code` string, string: The currency code of the expenses listed for this account.

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `422`: Validation error. The body will have the exact details.
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-16.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-16/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-16/revisions/9935effbe852?raw)