🔋API Reference

The August Digital API is a comprehensive RESTful API designed for DeFi portfolio management and trading operations.

August Digital API Documentation

Overview

This API provides access to subaccount management, swap functionality, and integrations with popular DeFi protocols like Trader Joe, Benqi, and Morpho.

Base URL: /api/v1 Version: 0.1.0 Authentication: API Key (Header: x-api-key)

Core Features

🏦 Subaccount Management

  • Portfolio Overview: Get comprehensive subaccount summaries including token balances, DeFi positions, and total account values

  • Health Monitoring: Real-time health factor calculations for risk management

  • Multi-chain Support: Manage assets across multiple blockchain networks

💱 Swap & Trading

  • Multi-market Quotes: Get competitive swap quotes from various DEX aggregators

  • Cross-chain Swaps: Execute token swaps across different blockchain networks

  • Fee Transparency: Clear fee structure with normal and stable batch transaction fees

🔗 DeFi Protocol Integrations

Trader Joe (Avalanche DEX)

  • Liquidity Management: Deposit and withdraw from liquidity pools

  • Position Rebalancing: Automated rebalancing of liquidity positions

  • Reward Claiming: Claim accumulated trading fees and incentives

Benqi (Avalanche Lending)

  • Supply Assets: Lend tokens to earn interest

  • Borrow Assets: Borrow against collateral

  • Debt Management: Repay loans and withdraw supplied assets

Morpho (Advanced Lending)

  • Vault APY Analytics: Get real-time APY data for Morpho vaults

🏆 Advanced Analytics

  • Historical Data: Time-series data for APY, asset ratios, and performance metrics

  • Risk Assessment: Health factor monitoring and loan-to-value calculations

  • Portfolio Insights: Detailed breakdowns of positions across protocols and chains

Authentication

All protected endpoints require an API key passed in the header:

x-api-key: YOUR_API_KEY

Supported Chains

The API supports multiple blockchain networks including:

  • Ethereum (Chain ID: 1)

  • Arbitrum (Chain ID: 42161)

  • Avalanche (Chain ID: 43114)

  • Base (Chain ID: 8453)

  • Binance Smart Chain (Chain ID: 56)

  • Polygon (Chain ID: 137)

  • And many more...

Key Endpoints

Health Check

  • GET /ping - Simple health check endpoint

Subaccounts

  • GET /subaccounts - List all subaccounts

  • GET /subaccounts/summary - Get detailed subaccount portfolio

  • GET /subaccounts/health_factor - Get real-time health factor

Swaps

  • GET /swap/markets - List available swap markets

  • POST /swap/quote - Get swap quotes

  • POST /subaccounts/{address}/swaps - Execute swaps

Response Format

All API responses follow consistent JSON formatting with proper error handling and validation. The API uses standard HTTP status codes and provides detailed error messages for troubleshooting.

Rate Limits & Best Practices

  • Use the health check endpoint (/ping) to verify API connectivity

  • Implement proper error handling for 422 validation errors

  • Cache frequently accessed data like market information

  • Use the await_confirmation parameter judiciously for transaction endpoints

Getting Started

  1. Obtain your API key from August Digital

  2. Start with the /ping endpoint to verify connectivity

  3. List your subaccounts with /subaccounts

  4. Explore available markets with /swap/markets

  5. Begin trading with /swap/quote and swap execution endpoints

For detailed request/response schemas and parameter specifications, refer to the interactive API documentation.

PreviousContract AddressesNextVaults

Last updated