HomeGuidesAPI Reference
Log In
API Reference

Get categories for access

Retrieve a list of categories associated to the transactions of this access. Each category entry also includes aggregated statistics of the referenced transactions like total amount, number of transactions, high and low values.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

finX ID of the provider access.

Query Params
string

Comma-separated list of account IDs. Only transactions belonging to these accounts will be selected.

string
Defaults to EUR

Filters the transactions used for aggregation based on their currency. Transactions in different currencies cannot be accumulated in a meaningful way.

string

Only select transactions that were booked in the specified period. Available formats are:

  • YYYY yearly (e.g. 2019)
  • YYYY-mm monthly (e.g. 2019-12)
  • YYYY-Qq quarterly (e.g. 2019-Q1): Q is the literal character "Q" and q refers to the annual quarter.
  • YYYY-Ww weekly (e.g. 2019-W23): W is the literal character "W" and w refers to the ISO week number.
  • YYYY-mm-dd (e.g. 2019-12-24)
string

Limit the transactions included in the aggregation to have a booking date newer than including this date. If not specified the booking date of the oldest transaction is used instead. The format can be either YYYY, YYYY-mm or YYYY-mm-dd.

string

Limit the transactions included in the aggregation to have a booking date older than including this date. If not specified the current date is used. The format can be either YYYY, YYYY-mm or YYYY-mm-dd.

string
enum
Defaults to asc

Determines the sort order of aggregation buckets. Sorting is performed based on the transactions total amount.

Allowed:
string

Only select transactions with an amount equal or greater than this value.

string

Only select transactions with an amount less than this value.

Headers
string

Setting the Accept-Language to one of the available languages will return results in this language.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json