API Endpoints

Documentation for all available endpoints on this Merkle Service API server.

POST /watch
Register a transaction ID with a callback URL. The service will notify the callback URL when the transaction is seen on the network or mined.
Request:
{
  "txid": "a1b2c3...64 hex chars",
  "callbackUrl": "https://example.com/callback"
}

Response (200):
{
  "status": "ok",
  "message": "registration successful"
}

Error (400):
{
  "error": "txid is required | invalid txid format | callbackUrl is required | invalid callbackUrl"
}
GET /health
Health check endpoint. Returns the status of the API server and its dependencies.
Response (200):
{
  "status": "healthy",
  "details": {
    "aerospike": "connected"
  }
}

Response (503):
{
  "status": "unhealthy",
  "details": {
    "aerospike": "disconnected"
  }
}
GET /api/lookup/{txid}
Look up registered callback URLs for a transaction ID.
Response (200):
{
  "txid": "a1b2c3...64 hex chars",
  "callbackUrls": ["https://example.com/callback"]
}

Error (400):
{
  "error": "invalid txid format: must be a 64-character hex string"
}

Register Transaction

Register a transaction ID with the merkle-service. Callbacks will be sent to the specified URL when the transaction status changes.

Lookup Transaction

Look up a transaction ID to see its registered callback URLs.

STUMP / BUMP Visualizer