Search code, repositories, users, issues, pull requests...

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of asset accounts and expense details. Each asset account has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_bill

List[InsightGroupEntry] insight_expense_bill(start, end, x_trace_id=x_trace_id, bills=bills, accounts=accounts)

Insight into expenses, grouped by bill.

This endpoint gives a summary of the expenses made by the user, grouped by (any) bill.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    bills = [["1","2","3"]] # List[int] | The bills to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, grouped by bill.
        api_response = api_instance.insight_expense_bill(start, end, x_trace_id=x_trace_id, bills=bills, accounts=accounts)
        print("The response of InsightApi->insight_expense_bill:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_bill: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
bills	List[int]	The bills to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of budget and expense details. Each budget has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_budget

List[InsightGroupEntry] insight_expense_budget(start, end, x_trace_id=x_trace_id, budgets=budgets, accounts=accounts)

Insight into expenses, grouped by budget.

This endpoint gives a summary of the expenses made by the user, grouped by (any) budget.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    budgets = [["1","2","3"]] # List[int] | The budgets to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, grouped by budget.
        api_response = api_instance.insight_expense_budget(start, end, x_trace_id=x_trace_id, budgets=budgets, accounts=accounts)
        print("The response of InsightApi->insight_expense_budget:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_budget: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
budgets	List[int]	The budgets to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of budget and expense details. Each budget has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_category

List[InsightGroupEntry] insight_expense_category(start, end, x_trace_id=x_trace_id, categories=categories, accounts=accounts)

Insight into expenses, grouped by category.

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

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    categories = [["1","2","3"]] # List[int] | The categories to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, grouped by category.
        api_response = api_instance.insight_expense_category(start, end, x_trace_id=x_trace_id, categories=categories, accounts=accounts)
        print("The response of InsightApi->insight_expense_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
categories	List[int]	The categories to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of category and expense details. Each category has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_expense

List[InsightGroupEntry] insight_expense_expense(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into expenses, grouped by expense account.

This endpoint gives a summary of the expenses made by the user, grouped by expense account.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you add the accounts ID's of expense accounts, only those accounts are included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. You can combine both asset / liability and expense account ID's. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, grouped by expense account.
        api_response = api_instance.insight_expense_expense(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_expense_expense:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_expense: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you add the accounts ID's of expense accounts, only those accounts are included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. You can combine both asset / liability and expense account ID's. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of expense accounts and expense details. Each expense acccount has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_no_bill

List[InsightTotalEntry] insight_expense_no_bill(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into expenses, without bill.

This endpoint gives a summary of the expenses made by the user, including only expenses with no bill.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, without bill.
        api_response = api_instance.insight_expense_no_bill(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_expense_no_bill:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_no_bill: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of expense details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_no_budget

List[InsightTotalEntry] insight_expense_no_budget(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into expenses, without budget.

This endpoint gives a summary of the expenses made by the user, including only expenses with no budget.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, without budget.
        api_response = api_instance.insight_expense_no_budget(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_expense_no_budget:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_no_budget: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of expense details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_no_category

List[InsightTotalEntry] insight_expense_no_category(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into expenses, without category.

This endpoint gives a summary of the expenses made by the user, including only expenses with no category.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, without category.
        api_response = api_instance.insight_expense_no_category(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_expense_no_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_no_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of expense details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_no_tag

List[InsightTotalEntry] insight_expense_no_tag(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into expenses, without tag.

This endpoint gives a summary of the expenses made by the user, including only expenses with no tag.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, without tag.
        api_response = api_instance.insight_expense_no_tag(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_expense_no_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_no_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of expense details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_tag

List[InsightGroupEntry] insight_expense_tag(start, end, x_trace_id=x_trace_id, tags=tags, accounts=accounts)

Insight into expenses, grouped by tag.

This endpoint gives a summary of the expenses made by the user, grouped by (any) tag.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    tags = [["1","2","3"]] # List[int] | The tags to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, grouped by tag.
        api_response = api_instance.insight_expense_tag(start, end, x_trace_id=x_trace_id, tags=tags, accounts=accounts)
        print("The response of InsightApi->insight_expense_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
tags	List[int]	The tags to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of tag and expense details. Each tag has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_expense_total

List[InsightTotalEntry] insight_expense_total(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into total expenses.

This endpoint gives a sum of the total expenses made by the user.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into total expenses.
        api_response = api_instance.insight_expense_total(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_expense_total:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_expense_total: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of sums in different currencies.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_asset

List[InsightGroupEntry] insight_income_asset(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into income, grouped by asset account.

This endpoint gives a summary of the income received by the user, grouped by asset account.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into income, grouped by asset account.
        api_response = api_instance.insight_income_asset(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_income_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of asset accounts and income details. Each asset account has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_category

List[InsightGroupEntry] insight_income_category(start, end, x_trace_id=x_trace_id, categories=categories, accounts=accounts)

Insight into income, grouped by category.

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

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    categories = [["1","2","3"]] # List[int] | The categories to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into income, grouped by category.
        api_response = api_instance.insight_income_category(start, end, x_trace_id=x_trace_id, categories=categories, accounts=accounts)
        print("The response of InsightApi->insight_income_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
categories	List[int]	The categories to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of category and income details. Each category has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_no_category

List[InsightTotalEntry] insight_income_no_category(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into income, without category.

This endpoint gives a summary of the income received by the user, including only income with no category.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into income, without category.
        api_response = api_instance.insight_income_no_category(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_income_no_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_no_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of income details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_no_tag

List[InsightTotalEntry] insight_income_no_tag(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into income, without tag.

This endpoint gives a summary of the income received by the user, including only income with no tag.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into income, without tag.
        api_response = api_instance.insight_income_no_tag(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_income_no_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_no_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of income details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_revenue

List[InsightGroupEntry] insight_income_revenue(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into income, grouped by revenue account.

This endpoint gives a summary of the income received by the user, grouped by revenue account.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you add the accounts ID's of revenue accounts, only those accounts are included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. You can combine both asset / liability and deposit account ID's. Other account ID's will be ignored.  (optional)

    try:
        # Insight into income, grouped by revenue account.
        api_response = api_instance.insight_income_revenue(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_income_revenue:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_revenue: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you add the accounts ID's of revenue accounts, only those accounts are included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. You can combine both asset / liability and deposit account ID's. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of revenue accounts and income details. Each revenue acccount has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_tag

List[InsightGroupEntry] insight_income_tag(start, end, x_trace_id=x_trace_id, tags=tags, accounts=accounts)

Insight into income, grouped by tag.

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

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    tags = [["1","2","3"]] # List[int] | The tags to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into income, grouped by tag.
        api_response = api_instance.insight_income_tag(start, end, x_trace_id=x_trace_id, tags=tags, accounts=accounts)
        print("The response of InsightApi->insight_income_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
tags	List[int]	The tags to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of tag and income details. Each tag has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_income_total

List[InsightTotalEntry] insight_income_total(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into total income.

This endpoint gives a sum of the total income received by the user.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into total income.
        api_response = api_instance.insight_income_total(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_income_total:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_income_total: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of sums in different currencies.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_transfer_category

List[InsightGroupEntry] insight_transfer_category(start, end, x_trace_id=x_trace_id, categories=categories, accounts=accounts)

Insight into transfers, grouped by category.

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

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    categories = [["1","2","3"]] # List[int] | The categories to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into transfers, grouped by category.
        api_response = api_instance.insight_transfer_category(start, end, x_trace_id=x_trace_id, categories=categories, accounts=accounts)
        print("The response of InsightApi->insight_transfer_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_transfer_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
categories	List[int]	The categories to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of category and transfer details. Each category has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_transfer_no_category

List[InsightTotalEntry] insight_transfer_no_category(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into transfers, without category.

This endpoint gives a summary of the transfers made by the user, including only transfers with no category.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into transfers, without category.
        api_response = api_instance.insight_transfer_no_category(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_transfer_no_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_transfer_no_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of transfer details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_transfer_no_tag

List[InsightTotalEntry] insight_transfer_no_tag(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into expenses, without tag.

This endpoint gives a summary of the transfers made by the user, including only transfers with no tag.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers from those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into expenses, without tag.
        api_response = api_instance.insight_transfer_no_tag(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_transfer_no_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_transfer_no_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers from those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of transfer details. One row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_transfer_tag

List[InsightGroupEntry] insight_transfer_tag(start, end, x_trace_id=x_trace_id, tags=tags, accounts=accounts)

Insight into transfers, grouped by tag.

This endpoint gives a summary of the transfers created by the user, grouped by (any) tag.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_group_entry import InsightGroupEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    tags = [["1","2","3"]] # List[int] | The tags to be included in the results.  (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into transfers, grouped by tag.
        api_response = api_instance.insight_transfer_tag(start, end, x_trace_id=x_trace_id, tags=tags, accounts=accounts)
        print("The response of InsightApi->insight_transfer_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_transfer_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
tags	List[int]	The tags to be included in the results.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of tag and transfer details. Each tag has one row per currency.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_transfer_total

List[InsightTotalEntry] insight_transfer_total(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into total transfers.

This endpoint gives a sum of the total amount transfers made by the user.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_total_entry import InsightTotalEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into total transfers.
        api_response = api_instance.insight_transfer_total(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_transfer_total:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_transfer_total: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of sums in different currencies.	-
400	Bad request	-
401	Unauthenticated	-
404	Page not found	-
500	Internal exception	-

insight_transfers

List[InsightTransferEntry] insight_transfers(start, end, x_trace_id=x_trace_id, accounts=accounts)

Insight into transfers, grouped by account.

This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability.

Example

OAuth Authentication (firefly_iii_auth):
Bearer Authentication (local_bearer_auth):

import firefly_iii_client
from firefly_iii_client.models.insight_transfer_entry import InsightTransferEntry
from firefly_iii_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.firefly-iii.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
    host = "https://demo.firefly-iii.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure Bearer authorization: local_bearer_auth
configuration = firefly_iii_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = firefly_iii_client.InsightApi(api_client)
    start = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    end = '2013-10-20' # date | A date formatted YYYY-MM-DD. 
    x_trace_id = 'x_trace_id_example' # str | Unique identifier associated with this request. (optional)
    accounts = [["1","2","3"]] # List[int] | The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.  (optional)

    try:
        # Insight into transfers, grouped by account.
        api_response = api_instance.insight_transfers(start, end, x_trace_id=x_trace_id, accounts=accounts)
        print("The response of InsightApi->insight_transfers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightApi->insight_transfers: %s\n" % e)

Parameters

Name	Type	Description	Notes
start	date	A date formatted YYYY-MM-DD.
end	date	A date formatted YYYY-MM-DD.
x_trace_id	str	Unique identifier associated with this request.	[optional]
accounts	List[int]	The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those asset accounts / liabilities will be included. Other account ID's will be ignored.	[optional]

Return type

List[InsightTransferEntry]

Authorization