### Trigger Asset Sweep

This endpoint is used to initiate a sweep of assets for a specific transaction within a wallet

Trigger Asset Sweep

apiKey

Blockradar

Welcome to the Blockradar Developer Documentation. Here, you’ll learn how to build amazing experiences for your customers using the Blockradar API.

Introduction

Wallets

Learn how to create dedicated addresses for your customers to deposit stablecoins

Addresses

Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Blockradar API.

Webhooks

Overview of blockchain networks and stablecoins supported by Blockradar on both mainnet and testnet

Integrations

Learn how to seamlessly integrate our APIs into your application.

Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the [dashboard](https://dashboard.blockradar.co).

Authentication

Blockradar's API is RESTful and as such, uses conventional HTTP response codes to indicate the success or failure of requests.

Errors

This endpoint retrieves the details of a specific wallet

Get Wallet

This endpoint allows you to update the details of a specific wallet

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| name | false | string | The updated name of the wallet. |
| description | false | string | The updated description of the wallet. |

Update wallet

This endpoint retrieves the balance of a specific wallet for a given asset.

Get Balance

This endpoint retrieves the balances of a specific wallet.

Get Balances

This endpoint is used to initiate a rescan of blocks for a specific wallet.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| blockNumber | false | number | The blockchain block number the transaction was made |
| transactionHash | false | string | The blockchain transaction hash |

Deposit Finder

This endpoint is used to manually trigger assets sweep for all unswept assets for a specific wallet

Trigger Sweep Assets

This endpoint retrieves the webhooks associated with a specific wallet

Webhooks Logs

This endpoint retrieves the addresses associated with a specific wallet.

Get Addresses

This endpoint allows you to create a new address for a specific wallet.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| name | false | string | The name of the address. |
| metadata | false | object | Additional metadata for the address, this will be part of any transaction tied to this |
| showPrivateKey | false | boolean | If you want the address private key to be part of the response |
| disableAutoSweep | false | boolean | Disable automatic sweeping of assets sent to the address into your master wallet |
| enableGaslessWithdraw | false | boolean | Enable gasless transactions from this address |

Generate Address

This endpoint retrieves information about a specific address within a wallet.

Get Address

This endpoint allows the client to update the status of a specific address within a wallet.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| isActive | true | boolean | The status state you want to set the address |

Update Address

This endpoint allows you to whitelist an external address to be monitored based on the wallet policies

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| name | false | string | The name associated with the wallet address. |
| address | true | string | The wallet address to be added to the whitelist. |
| metadata | false | object | Additional metadata associated with the wallet address this will be part of the transaction payload metadata |

Whitelist address

The endpoint allows the deletion of a specific address from the whitelist of a wallet.

Unwhitelist address

This endpoint retrieves the balance of a specific address within a wallet

This endpoint retrieves the balances associated with a specific address in a wallet.

This endpoint retrieves the transactions associated with a specific address in a wallet.

Get transactions

This endpoint is used to calculate the network fee for a withdrawal from a specific address.

### Request Body

- assetId (string): The ID of the asset to be withdrawn.
    
- address (string): The recipient address for the withdrawal.
    
- amount (string): The amount to be sent in the withdrawal.
    
- reference (string, optional): An optional reference for the withdrawal.
    
- metadata (string, optional): Additional metadata for the withdrawal.

Withdraw Network Fee

This endpoint allows you to initiate a withdrawal from a specific address

### Request Body

- assetId (string): The ID of the asset to be withdrawn.
    
- address (string): The recipient address for the withdrawal.
    
- amount (string): The amount to be sent in the withdrawal.
    
- reference (string, optional): An optional reference for the withdrawal.
    
- metadata (string, optional): Additional metadata for the withdrawal.

Withdraw

This API provides endpoints for interacting with smart contracts on the blockchain. It allows estimating network fees.

### Request Body

The request body should be in raw format and include the following parameters:

- `address`: The address for the contract
    
- `method`: The method to be called
    
- `parameters`: An array of parameters
    
- `abi`: An array containing the ABI of the contract or method

Custom Smart Contract Network Fee

This API provides endpoints for interacting with smart contracts on the blockchain. It allows for reading contract data,

#### Request Body

The request body should be in raw format and include the following parameters:

- `address`: The address for the contract
    
- `method`: The method to be called
    
- `parameters`: An array of parameters
    
- `abi`: An array containing the ABI of the contract or method

Custom Smart Contract  Read

This API provides endpoints for interacting with smart contracts on the blockchain. It allows for executing contract functions.

### Request Body

The request body should be in raw format and include the following parameters:

- `address`: The address for the contract
    
- `method`: The method to be called
    
- `parameters`: An array of parameters
    
- `abi`: An array containing the ABI of the contract or method

Custom Smart Contract  Write

This API endpoint is used to get the withdrawal network fee from a specific wallet.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| assetId | true | string | The ID of the asset to be withdrawn. |
| address | true | string | The recipient's address for the withdrawal. |
| amount | true | string | The amount to be withdrawn. |
| gasPrice | false | string | The gas price for the transaction. |
| nounce | false | string | The nounce for the transaction. |
| gasLimit | false | string | The gas limit for the transaction. |

This endpoint allows you to initiate a withdrawal from a specific wallet.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| assetId | true | string | The ID of the asset to be withdrawn. |
| address | true | string | The recipient's address for the withdrawal. |
| amount | true | string | The amount to be withdrawn. |
| gasPrice | false | string | The gas price for the transaction. |
| nounce | false | string | The nounce for the transaction. |
| gasLimit | false | string | The gas limit for the transaction. |
| reference | false | string | This would be the transaction reference |
| metadata | false | object | This would be atteched to the transaction payload |

This endpoint allows you to retrieve a quote for swapping assets.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| fromAssetId | true | string | The master wallet asset id to swap from. |
| toAssetId | true | string | The master wallet asset id to swap to. |
| amount | true | string | The amount to swap. |
| recipientAddress | false | string | The external address you want to swap to |

Get Quote

This endpoint allows the execution of a swap.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| fromAssetId | true | string | The master wallet asset id to swap from. |
| toAssetId | true | string | The master wallet asset id to swap to. |
| amount | true | string | The amount to swap. |
| recipientAddress | false | string | The external address you want to swap to |
| reference | false | string | This would be the transaction reference |
| metadata | false | string | This would be atteched to the transaction payload |

Swap Execute

Network Fee

Read

Write

This endpoint retrieves the assets associated with a specific wallet.

Get Wallet Assets

This endpoint allows you to add assets to a specific wallet

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| assetId | true | string | The asset id you want this wallet to support. |

Add Asset to Wallet

This endpoint is used to delete a specific asset from a wallet.

Remove Asset from Wallet

This endpoint allows the client to update the status of a specific asset within a wallet.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| isActive | true | boolean | Update asset status tied to a wallet. |

Update Wallet Asset

This endpoint retrieves the transactions associated with a specific wallet.

Get Transactions

The endpoint retrieves the details of a specific transaction associated with a wallet.

Get transaction

This endpoint is used to resend webhooks for transactions associated with a specific wallet.

Resend Webhook

This endpoint retrieves the webhooks associated with a specific transaction within a wallet

Webhook Logs

This API endpoint is used to perform an anti-money laundering (AML) lookup for a given address and blockchain

Lookup

This endpoint allows you to add a beneficiary to a specific wallet.

Create

The endpoint retrieves the list of beneficiaries associated with a specific wallet.

Get all

This endpoint retrieves details of a specific beneficiary associated with a wallet.

Get one

This endpoint allows you to update the details of a specific beneficiary associated with a wallet.

Update

This API endpoint is used to delete a beneficiary from a specific wallet.

Delete

Calculates and returns the estimated network fee for a potential asset recovery transaction.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| senderAddress | true | string | The address you're recovering assets from |
| recipientAddress | true | string | The address the recovering assets will be sent to |
| amount | true | string | The amount to be salvaged. |
| tokenAddress | false | string | Specify this for token salvage |
| blockchainId | true | string | The blockchain id you're recovering funds from |

Salvage Network Fee

Initiates the transfer of assets (native coins or tokens) from a specified sender address to a recipient address within the same wallet ecosystem.

### Body Parameters

| Key | **Required** | Type | Description |
| --- | --- | --- | --- |
| senderAddress | true | string | The address you're recovering assets from |
| recipientAddress | true | string | The address the recovering assets will be sent to |
| amount | true | string | The amount to be salvaged. |
| tokenAddress | false | string | Specify this for token salvage |
| blockchainId | true | string | The blockchain id you're recovering funds from |

Salvage

This endpoint allows you to create a payment link with the specified details.

This endpoint retrieves a list of payment links.

Get All

The `GET` request retrieves information about a specific payment link identified by `:id` from the Blockradar API.

Get One

This endpoint allows you to update the details of a specific payment link.

This endpoint allows to retrieve a list of assets supported by Blockradar

Get Assets

This endpoint retrieves a list of supported blockchains by Blockradar

Get Blockchains

This endpoint retrieves the current rates of specified assets in the given currency.

API Documentation

Wallet Management

Address Operations

Withdrawals

Swap

Custom Smart Contracts

Asset Management

Transactions

AML(Anti Money Laundering)

Auto Settlements

Asset Recovery

Payment Links

Miscellaneous

Trigger Asset Sweep

Trigger Asset Sweep

Authorizations

Headers

Path Parameters

Body

Response