Charts

Dashboard chart with budget and budget limit information.

GET

https://firefly.example.com/api/v1/chart/budget/overview-with-limits

This endpoint returns the data required to generate a chart with basic budget information, grouped by budget limit when necessary.

curl -X GET 'https://firefly.example.com/api/v1/chart/budget/overview-with-limits?start=2024-01-15&end=2024-01-15' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://firefly.example.com/api/v1/chart/budget/overview-with-limits?start=2024-01-15&end=2024-01-15', {
  method: 'GET',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://firefly.example.com/api/v1/chart/budget/overview-with-limits?start=2024-01-15&end=2024-01-15',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "label": "Checking account",
    "currency_id": "5",
    "currency_name": "Euro",
    "currency_code": "EUR",
    "currency_symbol": "$",
    "currency_decimal_places": 2,
    "primary_currency_id": "5",
    "primary_currency_name": "Euro",
    "primary_currency_code": "EUR",
    "primary_currency_symbol": "$",
    "primary_currency_decimal_places": 2,
    "date": "2026-10-01T00:00:00+00:00",
    "start_date": "2026-10-01T00:00:00+00:00",
    "end_date": "2026-10-31T23:59:59+00:00",
    "type": "line",
    "period": "1M",
    "yAxisID": 0,
    "entries": {},
    "pc_entries": {}
  }
]

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "string"
    ],
    "force": [
      "string"
    ],
    "blocked": [
      "string"
    ],
    "field": [
      "string"
    ],
    "role": [
      "string"
    ],
    "blocked_code": [
      "string"
    ],
    "name": [
      "string"
    ],
    "type": [
      "string"
    ],
    "iban": [
      "string"
    ],
    "start": [
      "string"
    ],
    "end": [
      "string"
    ],
    "date": [
      "string"
    ]
  }
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Parameters

startstring<date>requiredquery

A date formatted YYYY-MM-DD.

endstring<date>requiredquery

A date formatted YYYY-MM-DD.

Response

200OKArray<ChartDataSet>

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

Response fields application/json

Array<ChartDataSet>

Show child attributes

labelstring

This is the title of the current set. It can refer to an account, a budget or another object (by name).

Example

Checking account

currency_idstring

The currency ID of the currency associated with this object.

Example

currency_namestring

The currency name of the currency associated with this object.

Example

Euro

currency_codestring

The currency code of the currency associated with this object.

Example

EUR

currency_symbolstringread only

Example

currency_decimal_placesinteger<int32>read only

Example

primary_currency_idstringread only

The currency ID of the administration's primary currency.

Example

primary_currency_namestringread only

The currency name of the administration's primary currency.

Example

Euro

primary_currency_codestringread only

The currency code of the administration's primary currency.

Example

EUR

primary_currency_symbolstringread only

The currency symbol of the administration's primary currency.

Example

primary_currency_decimal_placesinteger<int32>read only

The currency decimal places of the administration's primary currency.

Example

datestring<date-time>

Example

2026-10-01T00:00:00+00:00

start_datestring<date-time>

Example

2026-10-01T00:00:00+00:00

end_datestring<date-time>

Example

2026-10-31T23:59:59+00:00

typestring

Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want.

Example

line

periodChartDatasetPeriodProperty1D1W1M3M1Ycustom

Period of the chart.

Example

1M

yAxisIDinteger<int32>

Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart).

Example

entriesobject

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_entriesobject

The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

422Unprocessable EntityValidationErrorResponse

Validation error. The body will have the exact details.

Response fields application/json

messagestring

Example

The given data was invalid.

errorsobject

Show child attributes

emailArray<string>

forceArray<string>

blockedArray<string>

fieldArray<string>

roleArray<string>

blocked_codeArray<string>

nameArray<string>

typeArray<string>

ibanArray<string>

startArray<string>

endArray<string>

dateArray<string>

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.