Summary

Returns basic sums of the users data.

GET

https://firefly.example.com/api/v1/summary/basic

Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is used in Firefly III to populate the dashboard.

curl -X GET 'https://firefly.example.com/api/v1/summary/basic?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/summary/basic?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/summary/basic?start=2024-01-15&end=2024-01-15',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

{}

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

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

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

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

Parameters

X-Trace-Idstring<uuid>header

Unique identifier associated with this request.

startstring<date>requiredquery

A date formatted YYYY-MM-DD.

endstring<date>requiredquery

A date formatted YYYY-MM-DD.

currency_codestringquery

A currency code like EUR or USD, to filter the result.

Response

200OKBasicSummary

An array of sums. It depends on the user what you can expect to get back, so please try this out on the demo site.

Response fields application/vnd.api+json

[key: string]BasicSummaryEntry

Show child attributes

keystring

This is a reference to the type of info shared, not influenced by translations or user preferences. The EUR value is a reference to the currency code. Possibilities are: balance-in-ABC, spent-in-ABC, earned-in-ABC, bills-paid-in-ABC, bills-unpaid-in-ABC, left-to-spend-in-ABC and net-worth-in-ABC.

Example

balance-in-EUR

titlestring

A translated title for the information shared.

Example

Balance ($)

monetary_valuenumber<double>

The amount as a float.

Example

123.45

currency_idstring

The currency ID of the associated currency.

Example

currency_codestring

Example

EUR

currency_symbolstring

Example

currency_decimal_placesinteger<int32>

Number of decimals for the associated currency.

Example

no_available_budgetsboolean

True if there are no available budgets available.

Example

false

value_parsedstring

The amount formatted according to the users locale

Example

$ 12.45

sub_titlestring

A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant.

Example

$20 + $-40

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

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.