---
title: "Get UTXO scan status"
method: GET
path: "/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos/scan"
tags: ["Derivations"]
---

# Get UTXO scan status

`GET /v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos/scan`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos/scan`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/btcpayserver/apis/nbxplorer-api/docs/v1/cryptos/:cryptoCode/derivations/:derivationScheme/utxos/scan/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the status of a UTXO scan. Results are kept for 24 hours after completion.

## Path parameters

- `cryptoCode` string, required
- `derivationScheme` string, required

## Response `200`

Scan status

- object
  - `error` string, nullable
  - `queuedAt` integer: Unix timestamp when the scan was queued
  - `status` 'Queued' | 'Pending' | 'Complete' | 'Error': Current state of the scan
  - `progress` object
    - `startedAt` integer: Unix timestamp when scan started
    - `completedAt` integer, nullable: Unix timestamp when scan completed
    - `found` integer: Number of UTXOs found
    - `batchNumber` integer
    - `remainingBatches` integer
    - `currentBatchProgress` integer
    - `remainingSeconds` integer
    - `overallProgress` integer
    - `from` integer
    - `count` integer
    - `totalSearched` integer
    - `totalSizeOfUTXOSet` integer, nullable: Only set when scan is complete
    - `highestKeyIndexFound` object
      - `change` integer, nullable
      - `deposit` integer, nullable
      - `direct` integer, nullable

## Other responses

- `404`: Scan information not found (older than 24H). Code: `scanutxoset-info-not-found`

## Changes

- **2026-09-29** `52231f42c765`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/btcpayserver/apis/nbxplorer-api/changes/v1/cryptos/:cryptoCode/derivations/:derivationScheme/utxos/scan/get.md)

---

[API](https://skmtc.dev/btcpayserver/apis/nbxplorer-api.md) - [All operations](https://skmtc.dev/btcpayserver/apis/nbxplorer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/btcpayserver/apis/nbxplorer-api/revisions/52231f42c765?raw)