Health Status

GET /health

Simple health check endpoint for monitoring and load balancers.

Request

GET /health

Response

response.json

{
  "status": "operational",
  "engine": "wallet-protect",
  "version": "1.0.0",
  "timestamp": "2024-01-15T12:00:00.000Z",
  "checks": {
    "database": "healthy",
    "engine": "running"
  }
}

Response Fields

Field	Type	Description
status	string	Overall status: operational, degraded, offline
engine	string	Engine name
version	string	Application version
timestamp	string	Current server time (ISO 8601)
checks.database	string	Database status: healthy, unhealthy
checks.engine	string	Engine status: running, stopped

Status Values

Status	Meaning
operational	All systems working normally
degraded	Some issues but still functional
offline	System unavailable

Example

curl

curl http://localhost:3000/health

Use Cases

• Load balancer health checks - Route traffic only to healthy instances

• Monitoring alerts - Alert when status changes

• Deployment verification - Confirm service is running after deploy

---

GET /status

Detailed engine status with metrics and recent activity.

Request

GET /status

Response

response.json

{
  "engine": {
    "running": true,
    "launchEnabled": true,
    "target": "your_handle",
    "pollInterval": 60000
  },
  "scanner": {
    "isRunning": true,
    "isScanning": false,
    "isAuthenticated": true
  },
  "stats": {
    "followers": {
      "total": 1542,
      "launched": 1538,
      "pending": 3,
      "failed": 1,
      "processing": 0
    },
    "launches": {
      "totalLaunches": 1538,
      "totalFailed": 15,
      "lastPollAt": "2024-01-15T12:00:00.000Z"
    }
  },
  "lastLaunch": {
    "follower": "@cryptofan",
    "token": {
      "name": "WP_CRYPTOFAN",
      "symbol": "WCRYPTOFAN",
      "address": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU"
    },
    "pumpUrl": "https://pump.fun/7xKXtg...",
    "timestamp": "2024-01-15T11:59:30.000Z"
  },
  "uptime": 86400
}

Response Fields

Engine Object

Field	Type	Description
running	boolean	Is engine active?
launchEnabled	boolean	Are launches enabled?
target	string	X handle being monitored
pollInterval	number	Poll interval in ms

Scanner Object

Field	Type	Description
isRunning	boolean	Is poll loop active?
isScanning	boolean	Currently in scan cycle?
isAuthenticated	boolean	X auth successful?

Stats Object

Field	Type	Description
followers.total	number	Total followers tracked
followers.launched	number	Successfully launched
followers.pending	number	Waiting to launch
followers.failed	number	Failed launches
followers.processing	number	Currently processing
launches.totalLaunches	number	All-time launches
launches.totalFailed	number	All-time failures
launches.lastPollAt	string	Last poll timestamp

Last Launch Object

Field	Type	Description
follower	string	Username with @
token.name	string	Token name
token.symbol	string	Token symbol
token.address	string	Solana address
pumpUrl	string	pump.fun URL
timestamp	string	Launch time

Other Fields

Field	Type	Description
uptime	number	Seconds since start

Example

curl + jq

curl http://localhost:3000/status | jq

Use Cases

• Dashboard display - Show current engine state

• Debugging - Check if scanner is running

• Monitoring - Track launch success rates

• Alerting - Alert on high failure rates

---

Monitoring Integration

Prometheus

If you want Prometheus-compatible metrics, you can add an endpoint:

example.ts

// Example: Add to routes
app.get('/metrics', async () => {
  const stats = await getDatabaseStats();
  return [
    `wallet_protect_followers_total ${stats.total}`,
    `wallet_protect_launches_total ${stats.launched}`,
    `wallet_protect_failures_total ${stats.failed}`,
    `wallet_protect_pending_total ${stats.pending}`,
  ].join('\n');
});

Datadog / New Relic

Use the /health endpoint with their HTTP check integrations.

Custom Alerting

alert-on-failure.sh

#!/bin/bash

# alert-on-failure.sh

status=$(curl -s http://localhost:3000/status | jq -r '.stats.followers.failed')

if [ "$status" -gt 10 ]; then
  echo "ALERT: High failure count: $status"
  # Send alert via webhook, email, etc.
fi