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

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

`GET /v1/autocomplete/piggy-banks-with-balance`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/autocomplete/piggy-banks-with-balance`
- 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 balance information.

- AutocompletePiggyBalance[]
  - `id` string, string, required
  - `name` string, string, required: Name of the piggy bank found by an auto-complete search.
  - `name_with_balance` string, string: Name of the piggy bank found by an auto-complete search, including the currently saved amount and the target amount.
  - `currency_id` string, string: Currency ID for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.
  - `currency_code` string, string: Currency code for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.
  - `currency_symbol` string, string: Currency symbol for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency.
  - `currency_decimal_places` integer: Currency decimal places for the currency used by this piggy bank. This will always be the piggy bank's currency, never the 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
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17/revisions/ea021802490b?raw)