Skip to content

Scanner Operations#

Node scans are useful for lightweight event tracking when you do not need a full custom indexer.

When Scans Fit#

  • track boxes created after scan registration
  • monitor one contract template or address pattern
  • avoid separate database/indexer for small services
  • use wallet/scanner API as operational glue

When Scans Do Not Fit#

  • historical backfill before scan registration
  • complex joins across addresses, tokens, and registers
  • analytics workloads
  • high-volume public queries

Use Indexed Node API, Explorer Stack, or Custom Indexer for those cases.

Core Routes#

  • POST /scan/register
  • POST /scan/deregister
  • GET /scan/listAll
  • GET /scan/unspentBoxes/{scanId}
  • GET /scan/spentBoxes/{scanId}
  • POST /scan/stopTracking
  • POST /scan/p2sRule
  • POST /scan/addBox
  • GET /wallet/transactionsByScanId/{scanId}

Operator Notes#

  • Register scans before expected events occur.
  • Store scan IDs in service config.
  • Back up node wallet/scanner state if service depends on it.
  • Monitor scan results after node upgrades or rescans.
  • Do not expose scan-management routes publicly.