---
title: "Dashboard chart with budget information."
method: GET
path: "/v1/chart/budget/overview"
tags: ["charts"]
---

# Dashboard chart with budget information.

`GET /v1/chart/budget/overview`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/chart/budget/overview`
- 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 returns the data required to generate a chart with basic budget information.

## Query parameters

- `start` string, date, required
- `end` string, date, required

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

Bar chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.

- ChartDataSet[]
  - `label` string, string: This is the title of the current set. It can refer to an account, a budget or another object (by name).
  - `currency_id` string, string: The currency ID of the currency associated with this object.
  - `currency_name` string, string: The currency name of the currency associated with this object.
  - `currency_code` string, string: The currency code of the currency associated with this object.
  - `currency_symbol` string, string
  - `currency_decimal_places` integer
  - `primary_currency_id` string, string: The currency ID of the administration's primary currency.
  - `primary_currency_name` string, string: The currency name of the administration's primary currency.
  - `primary_currency_code` string, string: The currency code of the administration's primary currency.
  - `primary_currency_symbol` string, string: The currency symbol of the administration's primary currency.
  - `primary_currency_decimal_places` integer: The currency decimal places of the administration's primary currency.
  - `date` string, date-time
  - `start_date` string, date-time
  - `end_date` string, date-time
  - `type` string, string: Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want.
  - `period` '1D' | '1W' | '1M' | '3M' | '1Y' | 'custom', string: Period of the chart.
  - `yAxisID` integer: Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart).
  - `entries` object: The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.
  - `pc_entries` object: The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.

## 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-0.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0/revisions/445332924ac5?raw)