---
title: "List Balance Sweeps"
method: GET
path: "/accounts/{account_id}/sweeps"
tags: ["Money + Positions"]
---

# List Balance Sweeps

`GET /accounts/{account_id}/sweeps`

## Path parameters

- `account_id` string, required

## Query parameters

- `cursor` string
- `limit` integer

## Headers

- `LMG-Data-Privacy-Access-Principal` string, required
- `LMG-Data-Privacy-Access-Justification` string, required

## Response `200`

Successful Response

- PageSweepResponse
  - `data` SweepResponse[], required — The elements of the response.
    - `id` string, required — A unique value identifying this sweep.
    - `status` 'canceled' | 'created' | 'processed' | 'rejected' | 'started', required — A category describing the status of a balance sweep: <ul> <li><code>canceled</code> <li><code>created</code> <li><code>processed</code> <li><code>rejected</code> <li><code>started</code> </ul>
    - `amount` string, required — The amount of money to be withdrawn during the balance sweep.
    - `currency` string, required — An ISO 4217 three-letter currency code. Its value represents the currency for the amount listed here. The only currently available currency is `"EUR"`.
    - `history` StatusChangeSweepStatus[], required
      - `status` 'canceled' | 'created' | 'processed' | 'rejected' | 'started', required — A category describing the status of a balance sweep: <ul> <li><code>canceled</code> <li><code>created</code> <li><code>processed</code> <li><code>rejected</code> <li><code>started</code> </ul>
      - `timestamp` string, date-time, required — The timestamp of the event. It represents the point in time at which the sweep was updated.
  - `pagination` Pagination, required — Information about accessing elements beyond the ones that were returned.
    - `next_cursor` string — When fetching long lists of elements, you can use our pagination feature to fetch batches of data. If a response contains the property `pagination.next_cursor`, you can pass its value via the query item `cursor` to generate the request for the next batch of data.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity
- `5XX` — Server Error

---

[API](https://skmtc.net/lemon/apis/lemon-markets-brokerage-api.md) · [All operations](https://skmtc.net/lemon/apis/lemon-markets-brokerage-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lemon/lemon-markets-brokerage-api/revisions/3c8cfd3a96c9/schema)