API Reference

Solana Insider Monitor provides a comprehensive REST API that allows you to programmatically access wallet data, manage configuration, and integrate with other systems.

API Overview

The API is available when running Solana Insider Monitor with the -web flag. All API endpoints are served from the base URL of your instance, for example: http://localhost:8080/api/.

Authentication

Most API endpoints require authentication using JSON Web Tokens (JWT). To obtain a token, you must first authenticate using your credentials.

Obtaining a JWT Token

curl -X POST http://localhost:8080/api/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"your-password"}'

This will return a JWT token that you should include in the Authorization header for subsequent requests:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2023-05-15T12:00:00Z"
}

Using the JWT Token

Include the token in the Authorization header for all protected API requests:

curl -X GET http://localhost:8080/api/admin/config \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

API Endpoints

The API is divided into public and protected endpoints:

Public Endpoints

These endpoints are accessible without authentication:

Protected Endpoints

These endpoints require authentication:

Response Format

All API responses are returned in JSON format with a consistent structure:

{
  "success": true,
  "data": { ... },
  "error": null
}

Or in case of an error:

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}

Rate Limiting

To prevent abuse, the API implements rate limiting:

• 60 requests per minute for authenticated endpoints
• 20 requests per minute for unauthenticated endpoints

Rate limit headers are included in all responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1620000000

Detailed API Documentation

For detailed information about specific endpoints, see:

• Authentication - Detailed guide on authentication
• Endpoints - Complete endpoint reference
• Integration Examples - Code examples for common use cases

Common Use Cases

Monitoring Multiple Wallets

You can use the API to fetch data for all monitored wallets:

curl -X GET http://localhost:8080/api/wallets

Adding a New Wallet to Monitor

curl -X POST http://localhost:8080/api/admin/wallets \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"wallet_address": "NEW_WALLET_ADDRESS"}'

Updating Alert Configuration

curl -X PUT http://localhost:8080/api/admin/config \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "alerts": {
      "minimum_balance": 500,
      "significant_change": 0.10
    }
  }'

Webhook Integration

You can configure external systems to receive webhook notifications for alerts:

1. Set up an endpoint in your application to receive POST requests
2. Configure the webhook URL in Solana Insider Monitor
3. Receive real-time alerts when significant changes are detected

{
  "webhook_url": "https://your-service.com/webhook",
  "webhook_secret": "your-webhook-secret"
}

API Client Libraries

We provide official client libraries for several programming languages:

• JavaScript/TypeScript
• Python
• Go

API Versioning

The API follows semantic versioning. The current version is v1.

To ensure backward compatibility, we include the version in the URL:

/api/v1/wallets

The default /api/ path points to the latest stable version.

Error Codes

Next Steps

• Authentication - Learn more about authentication
• Endpoints - Explore all available endpoints
• Integration Examples - See code samples for common use cases