# Crown API Documentation

## Docs

- [Get Balance](https://docs.crown-brlv.com/api-reference/endpoint/balance/get-balance.md): Retrieves the balance for the authenticated account for a specific asset. Currently only supports 'brl'
- [Create Claim](https://docs.crown-brlv.com/api-reference/endpoint/claims/create-claim.md): Submit a claim for a specified amount from reward certificates. Choose to receive as BRL or BRLV.
- [List Claims](https://docs.crown-brlv.com/api-reference/endpoint/claims/list-claims.md): Retrieve all claims requests for the authenticated user
- [Simulate Claims](https://docs.crown-brlv.com/api-reference/endpoint/claims/simulate-claims.md): Retrieve claimable operations with tax information
- [List Deposits](https://docs.crown-brlv.com/api-reference/endpoint/deposits/list-deposits.md): Retrieves a list of deposits for the authenticated user for a specific asset type. Asset can be 'brl', 'usd', 'usdc' or 'usdt'
- [Create Order](https://docs.crown-brlv.com/api-reference/endpoint/orders/create-order.md): Creates an order by accepting a quote. Wallet addresses are required only for token assets (eth-base/brlv, eth-mainnet/brlv, eth-base/wbrly). For fiat assets (fiat/brl, fiat/usd), no wallet addresses are needed. Use source-wallet-address for the source wallet and target-wallet-address for the destin…
- [Get Order](https://docs.crown-brlv.com/api-reference/endpoint/orders/get-order.md): Retrieves a specific order by its ID for the authenticated account
- [List Orders](https://docs.crown-brlv.com/api-reference/endpoint/orders/list-orders.md): Retrieves a list of all orders for the authenticated user
- [Create Quote](https://docs.crown-brlv.com/api-reference/endpoint/quotes/create-quote.md): Creates a quote for converting between different assets (fiat currencies and tokens). Either source-amount OR target-amount must be provided, but not both.
- [Create Transfer](https://docs.crown-brlv.com/api-reference/endpoint/transfers/create-transfer.md): Transfer tokens from a source wallet to a target wallet. Both source and target should be EVM wallet addresses (0x...).
- [List Transfers](https://docs.crown-brlv.com/api-reference/endpoint/transfers/list-transfers.md): Retrieves a list of token transfers for the authenticated user. Can be filtered by source-address, target-address, asset, or state.
- [Create Wallet](https://docs.crown-brlv.com/api-reference/endpoint/wallets/create-wallet.md): Creates a new wallet with the specified name and default assets (BRLV and wBRLY if applicable).
- [List Wallets](https://docs.crown-brlv.com/api-reference/endpoint/wallets/list-wallets.md): Returns a list of wallets. Can be filtered by assets and/or addresses.
- [Create Withdrawal](https://docs.crown-brlv.com/api-reference/endpoint/withdrawals/create-withdrawal.md): Creates a withdrawal for a specific asset. Currently only supports 'brl' with PIX and TED methods. For PIX withdrawals, only a pix-key is required. For TED withdrawals, full bank account details are required.
- [Get Withdrawal](https://docs.crown-brlv.com/api-reference/endpoint/withdrawals/get-withdrawal.md): Retrieves a specific withdrawal by its ID for the authenticated account for a specific asset. Currently only supports 'brl'
- [List Withdrawals](https://docs.crown-brlv.com/api-reference/endpoint/withdrawals/list-withdrawals.md): Retrieves a list of all withdrawals for the authenticated user for a specific asset. Currently only supports 'brl'
- [API Reference](https://docs.crown-brlv.com/api-reference/introduction.md): Complete guide to the Crown API
- [Claim Completed](https://docs.crown-brlv.com/api-reference/webhooks/claim-completed.md): Triggered when a yield claim has been successfully processed and tokens have been deposited.
- [Deposit Processed](https://docs.crown-brlv.com/api-reference/webhooks/deposit-processed.md): Triggered when a BRL deposit (PIX or TED) has been successfully processed and credited to the account.
- [Order Completed](https://docs.crown-brlv.com/api-reference/webhooks/order-completed.md): Triggered when a currency conversion order has been successfully completed.
- [Token Transfer Completed](https://docs.crown-brlv.com/api-reference/webhooks/token-transfer-completed.md): Triggered when a token transfer between wallets has been successfully completed on the blockchain.
- [Withdraw Completed](https://docs.crown-brlv.com/api-reference/webhooks/withdraw-completed.md): Triggered when a BRL withdrawal (PIX or TED) has been successfully processed and sent.
- [API Keys Setup](https://docs.crown-brlv.com/guides/api-keys-setup.md): Learn how to create and configure API keys for authenticating with the Crown API
- [API Authentication](https://docs.crown-brlv.com/guides/authentication.md): Learn how to authenticate your API requests using JWT tokens
- [Asset Conversions](https://docs.crown-brlv.com/guides/conversions.md): Learn how to convert between different assets using the Crown API
- [Depositing BRL Funds](https://docs.crown-brlv.com/guides/deposits.md): Learn how to deposit Brazilian Real (BRL) into your Crown account
- [Webhooks Setup](https://docs.crown-brlv.com/guides/webhooks-setup.md): Configure webhooks to receive real-time notifications about events in your Crown account
- [Introduction](https://docs.crown-brlv.com/index.md): Welcome to Crown API Documentation
- [BRLV Whitepaper](https://docs.crown-brlv.com/whitepaper.md): BRLV — The Real Standard. A BRL stablecoin backed 1:1 by Brazilian sovereign debt in a bankruptcy-remote structure.

## OpenAPI Specs

- [openapi](https://docs.crown-brlv.com/api-reference/openapi.json)