WalletApi

All URIs are relative to https://api.blockchainapi.com/v1

Method	HTTP request	Description
derivePrivateKey	POST /{blockchain}/wallet/private_key	Derive private key
deriveWalletIdentifier	POST /{blockchain}/wallet/identifier	Derive wallet identifier
generatePrivateKey	POST /{blockchain}/wallet/generate/private_key	Generate private key
generateSeedPhrase	POST /{blockchain}/wallet/generate/secret_recovery_phrase	Generate seed phrase
getAirdrop	POST /{blockchain}/wallet/airdrop	Get an airdrop
getBalance	POST /{blockchain}/wallet/balance	Get wallet's balance of X
transfer	POST /{blockchain}/wallet/transfer	Transfer crypto, a token, or an NFT to another wallet

derivePrivateKey

GeneralGeneratePrivateKeyResponse derivePrivateKey(blockchain, supplyWalletRequest)

Derive private key

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/derive-private-key\" target="_blank">See examples (Python, JavaScript)</a>. Use this endpoint to securely derive a private key for a wallet. For example, if you have a seed phrase and want to derive the corresponding private key, use this endpoint. `Cost: 0 Credit` (Free) (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "avalanche"; // String | The blockchain you want to use 
    SupplyWalletRequest supplyWalletRequest = new SupplyWalletRequest(); // SupplyWalletRequest | 
    try {
      GeneralGeneratePrivateKeyResponse result = apiInstance.derivePrivateKey(blockchain, supplyWalletRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#derivePrivateKey");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: avalanche, binance_smart_chain, ethereum, near, solana]
supplyWalletRequest	SupplyWalletRequest

Return type

GeneralGeneratePrivateKeyResponse

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

deriveWalletIdentifier

WalletIdentifiers deriveWalletIdentifier(blockchain, supplyWalletRequest)

Derive wallet identifier

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/derive-wallet-identifier\" target="_blank">See examples (Python, JavaScript)</a>. Derive the identifier for a wallet. `Cost: 0 Credit` (Free) (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "avalanche"; // String | The blockchain you want to use 
    SupplyWalletRequest supplyWalletRequest = new SupplyWalletRequest(); // SupplyWalletRequest | 
    try {
      WalletIdentifiers result = apiInstance.deriveWalletIdentifier(blockchain, supplyWalletRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#deriveWalletIdentifier");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: avalanche, binance_smart_chain, ethereum, near, solana]
supplyWalletRequest	SupplyWalletRequest

Return type

WalletIdentifiers

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

generatePrivateKey

GeneralGeneratePrivateKeyResponse generatePrivateKey(blockchain)

Generate private key

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/generate-private-key\" target="_blank">See examples (Python, JavaScript)</a>. Use this endpoint to securely and randomly generate a private key for a wallet. `Cost: 0 Credit` (Free) (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "avalanche"; // String | The blockchain you want to use 
    try {
      GeneralGeneratePrivateKeyResponse result = apiInstance.generatePrivateKey(blockchain);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#generatePrivateKey");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: avalanche, binance_smart_chain, ethereum, near, solana]

Return type

GeneralGeneratePrivateKeyResponse

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

generateSeedPhrase

GeneralSecretPhrase generateSeedPhrase(blockchain, generateSeedPhraseRequest)

Generate seed phrase

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/generate-secret-phrase\" target="_blank">See examples (Python, JavaScript)</a>. Use this endpoint to securely and randomly generate a seed phrase for a wallet. `Cost: 0 Credit` (Free) (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "avalanche"; // String | The blockchain you want to use 
    GenerateSeedPhraseRequest generateSeedPhraseRequest = new GenerateSeedPhraseRequest(); // GenerateSeedPhraseRequest | 
    try {
      GeneralSecretPhrase result = apiInstance.generateSeedPhrase(blockchain, generateSeedPhraseRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#generateSeedPhrase");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: avalanche, binance_smart_chain, ethereum, near, solana]
generateSeedPhraseRequest	GenerateSeedPhraseRequest		[optional]

Return type

GeneralSecretPhrase

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

getAirdrop

GeneralTransactionMadeResponse getAirdrop(blockchain, generalAirdropRequest)

Get an airdrop

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/get-airdrop\" target="_blank">See examples (Python, JavaScript)</a>. - Ethereum: Receive an airdrop of 0.001 ETH on Ropsten (not real ETH). - Solana: Use this endpoint to get an airdrop of SOL on the devnet (not real SOL). Amount of 0.015, which is the minimum amount of SOL you need to mint an NFT and then transfer it to another wallet. `Cost: 0 Credit` (Free) (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "ethereum"; // String | The blockchain you want to use 
    GeneralAirdropRequest generalAirdropRequest = new GeneralAirdropRequest(); // GeneralAirdropRequest | 
    try {
      GeneralTransactionMadeResponse result = apiInstance.getAirdrop(blockchain, generalAirdropRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#getAirdrop");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: ethereum, solana]
generalAirdropRequest	GeneralAirdropRequest		[optional]

Return type

GeneralTransactionMadeResponse

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

getBalance

GeneralBalanceResponse getBalance(blockchain, generalBalanceRequest)

Get wallet's balance of X

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/get-wallet-balance\" target="_blank">See examples (Python, JavaScript)</a>. See the balance of a wallet in the native blockchain currency (e.g., ETH, SOL) or any token (e.g., ERC-20, NFTs, SPL, etc.). To get the balance of a specific token, supply the `token_blockchain_identifier` of the token. You can also use this endpoint to see whether or not a person owns an NFT. Just supply the `token_blockchain_identifier` of the NFT. A balance of "1" means the person owns the NFT, and a balance of "0" means the person does not own the NFT. `Cost: 0.25 Credit` (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "ethereum"; // String | The blockchain you want to use 
    GeneralBalanceRequest generalBalanceRequest = new GeneralBalanceRequest(); // GeneralBalanceRequest | 
    try {
      GeneralBalanceResponse result = apiInstance.getBalance(blockchain, generalBalanceRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#getBalance");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: ethereum, solana]
generalBalanceRequest	GeneralBalanceRequest		[optional]

Return type

GeneralBalanceResponse

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

transfer

GeneralTransactionResponse transfer(blockchain, generalTransferRequest)

Transfer crypto, a token, or an NFT to another wallet

<a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/transfer-crypto-token-or-nft\" target="_blank">See transfer ETH/SOL/crypto example (Python, JavaScript)</a>. <a href="https://github.com/BL0CK-X/blockchain-api/tree/main/examples/wallet/transfer-crypto-token-or-nft\" target="_blank">See transfer NFT/token example (Python, JavaScript)</a>. This is a powerful function. It might be slightly confusing because there are several optional parameters, so take some time to review it. This function can send - The native currency of the selected blockchain (e.g., SOL, ETH, BNB, etc.) - A token (e.g., an SPL token, ERC-20 token, etc.) - An NFT You can sign and submit the transaction for confirmation; and you can select to simply return the compiled transaction so that you can submit it to the user for signing (e.g., via Phantom or Metamask; no private keys required in this case). If you're transferring an NFT or a token, supply its respective `token_blockchain_identifier`. SENDER: Note that the wallet information is used to authorize the sending of the tokens and identifies the source of the tokens. If `return_compiled_transaction = false`, we sign and submit the transaction (`wallet` is required in this case; do not provide a value for `sender_blockchain_identifier`). If `return_compiled_transaction = true`, we compile the transaction (`sender_blockchain_identifier` is required in this case; do not provide `wallet`). RECIPIENT: `recipient_blockchain_identifier` identifies the receiver. This is entirely separate from the information used for the SENDER above. So, in this API call, there are two wallets involved, but only one (namely, the SENDER) is needed to authorize the transaction (if you want us to sign and submitting it). FEE_PAYER (Solana only): The fee payer of the transaction defaults to `wallet` (or `sender_blockchain_identifier`). To set a different fee payer, provide a value for `fee_payer_wallet`. `Cost: 2 Credit` (<a href="#section/Pricing">See Pricing</a>)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.WalletApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.blockchainapi.com/v1");
    
    // Configure API key authorization: APIKeyID
    ApiKeyAuth APIKeyID = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyID");
    APIKeyID.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyID.setApiKeyPrefix("Token");

    // Configure API key authorization: APISecretKey
    ApiKeyAuth APISecretKey = (ApiKeyAuth) defaultClient.getAuthentication("APISecretKey");
    APISecretKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APISecretKey.setApiKeyPrefix("Token");

    WalletApi apiInstance = new WalletApi(defaultClient);
    String blockchain = "ethereum"; // String | The blockchain you want to use 
    GeneralTransferRequest generalTransferRequest = new GeneralTransferRequest(); // GeneralTransferRequest | 
    try {
      GeneralTransactionResponse result = apiInstance.transfer(blockchain, generalTransferRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WalletApi#transfer");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
blockchain	String	The blockchain you want to use	[enum: ethereum, solana]
generalTransferRequest	GeneralTransferRequest		[optional]

Return type

GeneralTransactionResponse

Authorization

APIKeyID, APISecretKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad request (check response message)	-
401	Invalid API key pair in headers	-
402	Payment required. Occurs when you run out of API requests. Upgrade <a href="https://dashboard.theblockchainapi.com/billing\" target="_blank">here</a>.	-

Files

WalletApi.md

Latest commit

History

WalletApi.md

File metadata and controls

WalletApi

derivePrivateKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deriveWalletIdentifier

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generatePrivateKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateSeedPhrase

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAirdrop

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getBalance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

transfer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details