---
title: "Manage monitors"
method: GET
path: "/monitors"
tags: ["Accounts"]
---

# Manage monitors

`GET /monitors`

Add, remove, clean, and list address monitors. Corresponds to the <a href="/chifra/accounts/#chifra-monitors">chifra monitors</a> command line.

## Query parameters

- `addrs` string[]
- `delete` boolean
- `undelete` boolean
- `remove` boolean
- `clean` boolean
- `list` boolean
- `count` boolean
- `staged` boolean
- `chain` string
- `noHeader` boolean
- `cache` boolean
- `decache` boolean
- `fmt` string

## Response `200`

returns the requested data

- object
  - `data` union[] — Produces <a href="/data-model/other/#message">Message</a>, <a href="/data-model/accounts/#monitor">Monitor</a> or <a href="/data-model/admin/#monitorclean">MonitorClean</a> data. Corresponds to the <a href="/chifra/accounts/#chifra-monitors">chifra monitors</a> command line.
    - union
      - Message — used for various responses when no real data is generated
        - `msg` string, string — the message
        - `num` number — a number if needed
      - Monitor — a local file indicating a user's interest in an address. Includes caches for reconicilations, transactions, and appearances as well as an optional association to named account
        - `address` string, address — the address of this monitor
        - `name` string, string — the name of this monitor (if any)
        - `nRecords` number — the number of appearances for this monitor
        - `fileSize` number — the size of this monitor on disc
        - `lastScanned` number — the last scanned block number
        - `isEmpty` boolean — `true` if the monitor has no appearances, `false` otherwise
        - `isStaged` boolean — `true` if the monitor file in on the stage, `false` otherwise
        - `deleted` boolean — `true` if this monitor has been deleted, `false` otherwise
      - MonitorClean — report on cleaning dups out of monitors
        - `address` string, address — the address being cleaned
        - `sizeThen` number — the number of appearances in the monitor prior to cleaning
        - `sizeNow` number — the number of appearances in the monitor after cleaning
        - `dups` number — the number of duplicates removed
        - `staged` boolean — `true` if the address is in the stage, `false` otherwise
        - `removed` boolean — `true` if the address was removed from the stage, `false` otherwise

## Other responses

- `400` — bad input parameter

## Changes

- **2024-12-17** `2428f6f19a07` — 7 info
  - added the new optional `query` request parameter `count`
  - added the new optional `query` request parameter `staged`
  - added the optional property `data/items/oneOf[#/components/schemas/monitorClean]/removed` to the response with the `200` status
  - added the optional property `data/items/oneOf[#/components/schemas/monitorClean]/staged` to the response with the `200` status
  - …3 more
- **2024-06-05** `12cdcbf76471` — 6 warning
  - deleted the `query` request parameter `batchSize`
  - deleted the `query` request parameter `commands`
  - deleted the `query` request parameter `runCount`
  - deleted the `query` request parameter `sleep`
  - …2 more
- **2024-06-01** `d659e0eb3b8e` — 1 info
  - added the new optional `query` request parameter `runCount`
- **2024-05-06** `6803b81d9e78` — 2 breaking
  - for the `query` request parameter `batchSize`, the type/format was changed from `number`/`blknum` to `number`/`uint64`
  - for the `query` request parameter `sleep`, the type/format was changed from `number`/`double` to `number`/`float64`
- **2024-05-03** `bd3425654b91` — 1 breaking
  - the `data/items/oneOf[#/components/schemas/message]/num` response's property type/format changed from `string`/`int` to `number`/`int64` for status `200`

[Full history](https://skmtc.dev/trueblocks/apis/trueblocks-api/changes/monitors/get.md)

---

[API](https://skmtc.dev/trueblocks/apis/trueblocks-api.md) · [All operations](https://skmtc.dev/trueblocks/apis/trueblocks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trueblocks/trueblocks-api/revisions/2a176f1485a9/schema)