Data

Export transaction data from Firefly III

GET

https://firefly.example.com/api/v1/data/export/transactions

This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only.

curl -X GET 'https://firefly.example.com/api/v1/data/export/transactions?start=2024-01-15&end=2024-01-15&accounts=1%2C2%2C3' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://firefly.example.com/api/v1/data/export/transactions?start=2024-01-15&end=2024-01-15&accounts=1%2C2%2C3', {
  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/data/export/transactions?start=2024-01-15&end=2024-01-15&accounts=1%2C2%2C3',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

"<binary>"

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

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

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

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

Parameters

startstring<date>requiredquery

A date formatted YYYY-MM-DD.

endstring<date>requiredquery

A date formatted YYYY-MM-DD.

accountsstringquery

Limit the export of transactions to these accounts only. Only asset accounts will be accepted. Other types will be silently dropped.

typeExportFileFiltercsvquery

The file type the export file (CSV is currently the only option).

Response

200OKstring<binary>

The exported transaction in a file.

Response fields application/octet-stream

string<binary>

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.