search

API Reference

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

hashtag
August Digital API Documentation

For detailed API specifications, refer to our OpenAPI documentationarrow-up-right.

hashtag
Overview

This API provides access to subaccount management, swap functionality, and integrations with popular DeFi protocols.

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

hashtag
Core Features

hashtag
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

hashtag
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

hashtag
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

hashtag
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

hashtag
Authentication

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

hashtag
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.

hashtag
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

PreviousContract AddressesNextTypeScript SDK

Last updated