> ## Documentation Index > Fetch the complete documentation index at: https://docs.blockradar.co/llms.txt > Use this file to discover all available pages before exploring further. # Wallet Rewards > Returns a wallet's earn positions (master-level), aggregated per strategy, with live balance, APY, deposited principal, and earnings (today / week / lifetime). Provide `assetId` to return a single asset's position instead of the full list. ### Query Parameters | Key | Required | Type | Description | | --- | --- | --- | --- | | addressId | false | string (UUID) | Scope to a sub-address. Omit to target the master wallet. | | assetId | false | string (UUID) | Return only this asset's position. | ## OpenAPI ````yaml get /v1/wallets/{walletId}/rewards openapi: 3.0.3 info: title: Blockradar Documentation description: >- The OpenAPI specification of the Blockradar API that enables fintechs and developers to seamlessly integrate stablecoin deposits and payments into their products. version: 1.0.0 contact: {} servers: - url: https://api.blockradar.co security: - apiKey: [] tags: - name: Rewards description: >- Non-custodial yield (Earn) on stablecoins via regulated (Fija) and DeFi (Aave) strategies. Deposit, withdraw, preview fees, and read positions and earnings at the business, wallet, and sub-address level. Amounts are returned net of the platform fee, which applies only to interest earned. - name: Wallet description: >- Wallet Management System Comprehensive wallet management API for multi-blockchain operations. This system handles wallet creation, configuration, balance monitoring, and integration with various blockchain networks. Core Functionality: - Multi-blockchain wallet creation and management - Balance monitoring and asset tracking - Auto-settlement rule configuration - Gateway wallet integration - Address generation and management - Transaction monitoring and processing - name: Addresses description: >- Address Management System Comprehensive blockchain address management API for operations. This system handles address creation, validation, monitoring, and management across multiple blockchain networks. Core Functionality: - Multi-blockchain address generation - Address validation and verification - Balance monitoring and tracking - Transaction history management - Address labeling and organization - Integration with wallet systems - Real-time address monitoring - name: Asset - name: Transactions - name: Withdraw description: >- The Withdraw feature allows you to programmatically withdraw stablecoins from your master wallet with ease - name: Withdraw Fiat - name: Signing description: >- Typed data signing service for secure transaction authorization. Supports all EIP-712 standards including EIP-3009 (TransferWithAuthorization) and EIP-2612 (Permit). - name: Swap description: >- The Swap feature enables users to exchange one stabelcoin asset for another across different blockchains. This feature provides a seamless way to convert between different stablecoins while maintaining security and compliance standards. - name: Liquidity Pool - name: Virtual Accounts description: >- Virtual Accounts API provides endpoints for managing virtual bank accounts linked to master wallets or child addresses. This API enables businesses to: - Create virtual accounts for customers to receive payments - Retrieve virtual account details - Activate/deactivate virtual accounts **Virtual Account Types:** Virtual accounts support different types with varying behaviors: 1. **AUTO_FUNDING** (Default): - Automatically mints stablecoin when fiat payments are received - Transfers the stablecoin to the linked wallet/address immediately - Best for real-time payment processing **How It Works - Auto-Funding Flow (AUTO_FUNDING type only):** When a customer sends fiat currency to a virtual account with type AUTO_FUNDING: 1. **Payment Receipt**: The payment is received in the virtual account 2. **Automatic Minting**: The system automatically mints the stablecoin equivalent 3. **Blockchain Transfer**: The minted stablecoin is transferred to the virtual account's linked wallet or address **Note**: The auto-funding flow only applies to virtual accounts with type `AUTO_FUNDING`. Other types have different processing behaviors. ## Prerequisites Before creating virtual accounts, ensure: - **Compliance requirements must be completed** (see [Compliance Requirements](http://localhost:3000/essentials/virtual-accounts#compliance-requirements) section below) - **Virtual accounts feature must be enabled** for your business (reach out to [support@blockradar.co](https://mailto:support@blockradar.co) or use live chat on the dashboard to enable the feature after compliance approval) - **Only available on MAINNET environment** (not available on testnet) - **Master Wallet must support stablecoin asset** - Your account plan must include stablecoin access (upgrade from Dashboard → Settings → Subscription if needed) **Supported Currency:** - Fiat: NGN (Nigerian Naira) - Stablecoin: cNGN - minted automatically on blockchain (for AUTO_FUNDING type) - name: Auto Settlements description: >- Creates a new auto settlement rule for a wallet. Auto settlement automatically transfers/swap assets based on configured rules when certain conditions are met. Rules can be configured for: - Source blockchain and assets - Destination blockchain and asset - Amount ranges (min/max) - Slippage tolerance - Gateway vs non-gateway wallets Gateway rules are required for testnet wallets and must have matching source/destination assets. - name: Smart Contract description: >- This API provides endpoints for interacting with smart contracts on the blockchain. It allows for reading contract data, executing contract functions, and estimating network fees. - name: Gateway description: >- The Gateway feature enables you to programmatically deposit USDC into a unified, chain-abstracted balance and instantly mint USDC on any supported blockchain, streamlining crosschain transfers and eliminating manual bridging steps and rebalancing complexities. - name: Payment Links description: >- The Payment Pages API provides a quick and secure way to collect payment for servcies. - name: Beneficiaries description: >- This API allows you to create beneficiaries with automatic settlements to your external wallets on a periodic basis. Example frequencies: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY - name: AML description: >- The AML (Anti Money Laundering) API provides a quick way for you to check if an address is blacklisted or sanctioned - name: Asset Recovery description: >- Enables the recovery (salvage) of both native blockchain assets and tokens from a specified sender address to a recipient address. This feature supports emergency fund recovery and asset consolidation operations. - name: Miscellaneous description: >- The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs. - name: Asset1 - name: Blockchain - name: Webhooks description: >- Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Blockradar API. To see full list and instructions [https://docs.blockradar.co/essentials/webhooks](https://docs.blockradar.co/essentials/webhooks) ## - name: Deposit - name: Withdraw1 - name: Swap1 - name: Gateway1 paths: /v1/wallets/{walletId}/rewards: get: tags: - Rewards summary: Wallet Rewards description: >- Returns a wallet's earn positions (master-level), aggregated per strategy, with live balance, APY, deposited principal, and earnings (today / week / lifetime). Provide `assetId` to return a single asset's position instead of the full list. ### Query Parameters | Key | Required | Type | Description | | --- | --- | --- | --- | | addressId | false | string (UUID) | Scope to a sub-address. Omit to target the master wallet. | | assetId | false | string (UUID) | Return only this asset's position. | operationId: getWalletRewards parameters: - name: addressId in: query schema: type: string example: '' - name: assetId in: query schema: type: string example: '' responses: '200': description: OK content: application/json: schema: type: object example: message: Wallet rewards retrieved successfully statusCode: 200 data: - type: defi apy: '2.41' balance: '4.365017' balanceInUSD: '4.365017' totalDeposited: '4.360000' totalDepositedInUSD: '4.360000' earnings: '0.005017' earningsInUSD: '0.005017' todayEarnings: '0.000187' weeklyEarnings: '0.001312' lifetimeEarnings: '0.026492' lifetimeEarningsInUSD: '0.026492' asset: id: 2f6298ec-81ca-44f4-a8f2-cc045a46d28c isActive: true asset: id: b1deda8d-7609-4895-b584-e8ef1f13e354 name: USD Coin symbol: USDC decimals: 6 currency: USD network: mainnet blockchain: name: base slug: base symbol: eth components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header ````