Heartbeats and the listing API

Keys, test mode, heartbeats and bulk updates.

Owners create keys in API keys. A key is shown once; we store only a hash.

  • km_live_… keys write. km_test_… keys validate the same requests without saving anything, so you can build against real data safely.
  • POST /api/v1/machines/{id}/heartbeat with {"status":"online"} marks a machine confirmed by the machine itself. Add buyFeePct/sellFeePct on Pro, and cashStatus on cash-out machines.
  • PATCH /api/v1/machines/{id} changes any field, including holiday hours. {id} can be our ID or your External ID.
  • POST /api/v1/machines/bulk upserts up to 500 machines.

Limits: 2,000 heartbeats a minute per key. The full reference is on Developers and in /api/v1/openapi.json.

Still stuck? Email hello@bitcoinscouts.com.