API Documentation

Everything you need to integrate Avantage into your application. Our REST API provides programmatic access to funding, vaults, simulations, operations, and analytics.

Quick Start

Send authenticated requests using your live or test API key.

# Authenticate with your API key
curl -X POST https://api.avantage.io/v1/transactions \
  -H "Authorization: Bearer av_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "transfer",
    "to": "0x742d35Cc6634C0532925a3b844Bc9e7595f0aB12",
    "amount": "100.00",
    "token": "USDC"
  }'

API Endpoints

Core endpoints available across the platform.

POST/api/auth

Authenticate and receive a session token

GET/api/modules

List all available modules and their status

POST/api/modules

Enable or configure a module for your tenant

POST/api/sandbox

Run a simulation in the sandbox environment

GET/api/transactions

List transactions with optional filters

POST/api/transactions

Execute a new transaction

GET/api/settlements

List settlement events

GET/api/audit

Retrieve action logs

GET/api/eclv

Get ECLV score for a customer

POST/api/eclv

Request ECLV calculation

GET/api/dashboard

Get dashboard statistics

Authentication

All API requests require authentication using an API key.

Include your API key in the authorization header:

Authorization: Bearer av_live_your_api_key

Note: Use av_test_ prefixed keys for sandbox operations and av_live_ prefixed keys for production.

Response Format

All API responses follow a consistent envelope structure.

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "perPage": 20,
    "total": 100,
    "totalPages": 5
  }
}