Overview

Wallet Protect exposes a RESTful HTTP API for monitoring and management.

Base URL

http://localhost:3000

For production, use your deployed URL.

---

Endpoints Summary

Method	Endpoint	Description
GET	/health	Service health check
GET	/status	Detailed engine status
GET	/followers	List all followers
GET	/followers/:id	Get single follower
POST	/retry/:id	Retry failed launch
GET	/logs	View audit logs
GET	/stats	Launch statistics

---

Authentication

The API currently has no authentication. For production, consider adding API keys or running behind a private network.

---

Response Format

All responses are JSON with consistent structure:

Success Response

{
  "data": { ... },
  "timestamp": "2024-01-15T12:00:00.000Z"
}

Error Response

{
  "error": true,
  "message": "Description of what went wrong"
}

---

HTTP Status Codes

Code	Meaning
200	Success
400	Bad request (invalid parameters)
404	Resource not found
500	Internal server error

---

Common Query Parameters

Pagination

?limit=50&offset=0

Parameter	Type	Default	Max	Description
limit	number	50	100	Results per page
offset	number	0	-	Skip N results

Filtering

?status=launched

Filter by follower status: pending, processing, launched, failed, skipped

---

Example Requests

cURL

# Health check
curl http://localhost:3000/health

# Get status
curl http://localhost:3000/status

# List followers
curl "http://localhost:3000/followers?status=launched&limit=10"

# Get specific follower
curl http://localhost:3000/followers/abc-123-def

# Retry failed launch
curl -X POST http://localhost:3000/retry/abc-123-def

JavaScript

Python

---

Rate Limiting

No rate limiting is currently implemented. For production, consider adding rate limits.

---

CORS

CORS is not configured by default. If you need browser access:

// In src/server.ts
import cors from '@fastify/cors';

await app.register(cors, {
  origin: ['https://your-dashboard.com'],
});