# Echo developer documentation

## Docs

- [read-commitment-data
](https://docs.echo.xyz/api-reference/read-commitment-data.md): Read data derived from the commitments to a sale contract. This includes the 100 latest commitments for a given sale, the total commitment amount, and the number of unique commitments. For auction sales, the current clearing price is also returned.
- [Overview](https://docs.echo.xyz/index.md): Sonar: Self-hosted, on-chain token sale infrastructure
- [Authentication & OAuth](https://docs.echo.xyz/sonar/core-features/authentication.md): OAuth 2.0 authentication for secure API access.
- [Entities](https://docs.echo.xyz/sonar/core-features/entities.md): Understanding compliance entities and verification requirements.
- [Purchase Permits](https://docs.echo.xyz/sonar/core-features/purchase-permits.md): Cryptographically signed authorizations that connect compliance verification to onchain purchases.
- [Test Sales](https://docs.echo.xyz/sonar/core-features/test-sales.md): You can use a test sale to test your app's integration with Sonar.
- [FAQ & Troubleshooting](https://docs.echo.xyz/sonar/faq.md): Common questions and solutions for Sonar integration.
- [Getting Started](https://docs.echo.xyz/sonar/getting-started.md): Set up your project to integrate with Sonar for compliant token sales.
- [Custom Contracts](https://docs.echo.xyz/sonar/integration-guides/custom-contracts.md): Build your own sale contract with Sonar purchase permit validation.
- [Frontend-only](https://docs.echo.xyz/sonar/integration-guides/frontend-only.md): Integrate Sonar into a React single page application with client-side token management.
- [Integration Overview](https://docs.echo.xyz/sonar/integration-guides/frontend-overview.md): Choose the right frontend integration approach for your project.
- [Solana (SVM)](https://docs.echo.xyz/sonar/integration-guides/frontend-svm.md): Integrate Sonar into a Solana application using the Solana wallet adapter.
- [Frontend with Backend](https://docs.echo.xyz/sonar/integration-guides/frontend-with-backend.md): Integrate a Next.js application with Sonar, using server-side token management for improved security.
- [Reading Commitment Data](https://docs.echo.xyz/sonar/integration-guides/reading-commitment-data.md): Display live commitment data and statistics on your sale page.
- [Key Concepts](https://docs.echo.xyz/sonar/key-concepts.md): Essential concepts for understanding how Sonar works and implementing successful integrations.
- [Smart Contract Operations](https://docs.echo.xyz/sonar/operations/smart-contract-operations.md): How to manage sale stages, set allocations, process refunds, and withdraw proceeds on the SettlementSale contract
- [Compliance Capabilities](https://docs.echo.xyz/sonar/planning/compliance-overview.md): Overview of Sonar's compliance features for token sales
- [Configuration Options](https://docs.echo.xyz/sonar/planning/configuration-options.md): All the options available when setting up your token sale
- [Lockup & Vesting](https://docs.echo.xyz/sonar/planning/lockup-vesting.md): How lockup preferences are recorded with commitments and how to enforce lockup for US investors.
- [Planning Your Sale](https://docs.echo.xyz/sonar/planning/overview.md): Key decisions for configuring your Sonar token sale
- [Pricing Strategies](https://docs.echo.xyz/sonar/planning/pricing-strategies.md): How the token price is determined for your sale
- [Sale Lifecycle](https://docs.echo.xyz/sonar/planning/sale-lifecycle.md): The end-to-end process of running a token sale with Sonar
- [Settlement Strategies](https://docs.echo.xyz/sonar/planning/settlement-strategies.md): How tokens are allocated when demand exceeds supply
- [Wallet Risk Screening](https://docs.echo.xyz/sonar/planning/wallet-risk-screening.md): Configure risk groups with direct and indirect exposure thresholds to control wallet eligibility.
- [SettlementSale](https://docs.echo.xyz/sonar/reference/contracts/settlement-sale.md): Reference for the standard Sonar sale contract supporting fixed-price and auction sales.
- [SettlementSale (SVM)](https://docs.echo.xyz/sonar/reference/contracts/settlement-sale-svm.md): Reference for the Sonar settlement sale program on Solana.
- [@echoxyz/sonar-core](https://docs.echo.xyz/sonar/reference/sonar-core.md): Low level library for interacting with the Sonar API.
- [@echoxyz/sonar-react](https://docs.echo.xyz/sonar/reference/sonar-react.md): Higher level react hooks for interacting with the Sonar API.
- [Technical Overview](https://docs.echo.xyz/sonar/technical-overview.md): How users participate in a Sonar-powered token sale

## OpenAPI Specs

- [sonar](https://docs.echo.xyz/openapi/sonar.json)
- [sales](https://docs.echo.xyz/openapi/sales.json)
- [openapi](https://docs.echo.xyz/api-reference/openapi.json)