---
title: "Returns all piggy banks of the user returned in a basic auto-complete array."
method: GET
path: "/v1/autocomplete/piggy-banks"
tags: ["autocomplete"]
---

# Returns all piggy banks of the user returned in a basic auto-complete array.

`GET /v1/autocomplete/piggy-banks`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/autocomplete/piggy-banks`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

## Query parameters

- `query` string, string
- `limit` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of piggy banks with very basic information.

- AutocompletePiggy[]
  - `id` string, string, required
  - `name` string, string, required: Name of the piggy bank found by an auto-complete search.
  - `currency_id` string, string: Currency ID for this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency.
  - `currency_code` string, string: Currency code for this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency.
  - `currency_symbol` string, string
  - `currency_name` string, string: Currency name for the currency used by this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency.
  - `currency_decimal_places` integer: Number of decimal places for the currency used by this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency.
  - `object_group_id` string, string, nullable: The group ID of the group this object is part of. NULL if no group.
  - `object_group_title` string, string, nullable: The name of the group. NULL if no group.

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `422`: Validation error. The body will have the exact details.
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-3-0-beta-2.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-3-0-beta-2/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-3-0-beta-2/revisions/a5f6f8195556?raw)