> ## Documentation Index > Fetch the complete documentation index at: https://docs.yiksipay.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Address > This endpoint retrieves information about a specific address within a wallet. ### Query Parameters | Name | Type | Required | Description | |-----------------|----------|----------|--------------------------------------------------| | showPrivateKey | boolean | Optional | If `true`, the response will include the private key. If `false` or omitted, the private key is not computed. | ## OpenAPI ````yaml get /v1/wallets/{walletId}/addresses/{addressId} openapi: 3.0.3 info: title: Yiksi Pay Documentation description: >- The OpenAPI specification of the Yiksi Pay 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.yiksipay.com security: - apiKey: [] tags: - 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 - 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: 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: 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 - 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: 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 Yiksi Pay API. To see full list and instructions [https://docs.yiksipay.com/essentials/webhooks](https://docs.yiksipay.com/essentials/webhooks) ## - name: Deposit - name: Withdraw1 - name: Swap1 paths: /v1/wallets/{walletId}/addresses/{addressId}: parameters: - name: walletId in: path required: true schema: type: string example: YOUR_WALLET_ID - name: addressId in: path required: true schema: type: string example: ADDRESS_ID get: tags: - Addresses summary: Get Address description: > This endpoint retrieves information about a specific address within a wallet. ### Query Parameters | Name | Type | Required | Description | |-----------------|----------|----------|--------------------------------------------------| | showPrivateKey | boolean | Optional | If `true`, the response will include the private key. If `false` or omitted, the private key is not computed. | operationId: getAddress parameters: - name: showPrivateKey in: query schema: type: string example: OPTIONAL_BOOLEAN responses: '200': description: 200 / Show Private Key content: application/json: schema: type: object properties: data: type: object properties: address: type: string example: '0x7204855eA98E951a218A9CC69786D7Dc749d170A' blockchain: type: object properties: createdAt: type: string example: '2024-05-14T11:53:33.095Z' derivationPath: type: string example: m/44'/60'/0'/0 id: type: string example: 85ffc132-3972-4c9e-99a5-5cf0ccb688bf isActive: type: boolean example: true isEvmCompatible: type: boolean example: true logoUrl: type: string example: >- https://res.cloudinary.com/dkgdc1vnl/image/upload/v1771444998/crypto-assets/ethereum.png name: type: string example: ethereum slug: type: string example: ethereum symbol: type: string example: eth tokenStandard: type: string example: ERC20 updatedAt: type: string example: '2024-06-14T22:32:11.983Z' configurations: type: object properties: aml: type: object properties: message: type: string example: Address is not sanctioned provider: type: string example: ofac status: type: string example: success disableAutoSweep: type: boolean example: false enableGaslessWithdraw: type: boolean example: false showPrivateKey: type: boolean example: false createdAt: type: string example: '2024-10-23T10:53:38.622Z' derivationPath: type: string example: m/44'/60'/0'/0/86 id: type: string example: 259422b2-6c8f-40e0-822f-7d2d23c78323 isActive: type: boolean example: true metadata: nullable: true example: null name: nullable: true example: null network: type: string example: testnet privateKey: type: string example: 0x1234567890abcdef12345678..... type: type: string example: INTERNAL updatedAt: type: string example: '2024-10-23T10:53:38.622Z' message: type: string example: Address fetched successfully statusCode: type: number example: 200 examples: '200': value: data: address: '0x7204855eA98E951a218A9CC69786D7Dc749d170A' blockchain: createdAt: '2024-05-14T11:53:33.095Z' derivationPath: m/44'/60'/0'/0 id: 85ffc132-3972-4c9e-99a5-5cf0ccb688bf isActive: true isEvmCompatible: true logoUrl: >- https://res.cloudinary.com/dkgdc1vnl/image/upload/v1771444998/crypto-assets/ethereum.png name: ethereum slug: ethereum symbol: eth tokenStandard: ERC20 updatedAt: '2024-06-14T22:32:11.983Z' configurations: aml: message: Address is not sanctioned provider: ofac status: success disableAutoSweep: false enableGaslessWithdraw: false showPrivateKey: false createdAt: '2024-10-23T10:53:38.622Z' derivationPath: m/44'/60'/0'/0/86 id: 259422b2-6c8f-40e0-822f-7d2d23c78323 isActive: true metadata: null name: null network: testnet type: INTERNAL updatedAt: '2024-10-23T10:53:38.622Z' message: Address fetched successfully statusCode: 200 Show Private Key: value: data: address: '0x7204855eA98E951a218A9CC69786D7Dc749d170A' blockchain: createdAt: '2024-05-14T11:53:33.095Z' derivationPath: m/44'/60'/0'/0 id: 85ffc132-3972-4c9e-99a5-5cf0ccb688bf isActive: true isEvmCompatible: true logoUrl: >- https://res.cloudinary.com/dkgdc1vnl/image/upload/v1771444998/crypto-assets/ethereum.png name: ethereum slug: ethereum symbol: eth tokenStandard: ERC20 updatedAt: '2024-06-14T22:32:11.983Z' configurations: aml: message: Address is not sanctioned provider: ofac status: success disableAutoSweep: false enableGaslessWithdraw: false showPrivateKey: false createdAt: '2024-10-23T10:53:38.622Z' derivationPath: m/44'/60'/0'/0/86 id: 259422b2-6c8f-40e0-822f-7d2d23c78323 isActive: true metadata: null name: null network: testnet privateKey: 0x1234567890abcdef12345678..... type: INTERNAL updatedAt: '2024-10-23T10:53:38.622Z' message: Address fetched successfully statusCode: 200 components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header ````