All URIs are relative to https://rest.cryptoapis.io
| Method | HTTP request | Description |
|---|---|---|
| derive_and_sync_new_change_addresses | POST /blockchain-data/{blockchain}/{network}/hd/derive-sync-change | Derive And Sync New Change Addresses |
| derive_and_sync_new_receiving_addresses | POST /blockchain-data/{blockchain}/{network}/hd/derive-and-sync | Derive And Sync New Receiving Addresses |
| get_hd_wallet__x_pub_y_pub_z_pub_assets | GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/assets | Get HD Wallet (xPub, yPub, zPub) Assets |
| get_hd_wallet__x_pub_y_pub_z_pub_details | GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/details | Get HD Wallet (xPub, yPub, zPub) Details |
| list_hd_wallet__x_pub_y_pub_z_pub_transactions | GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/transactions | List HD Wallet (xPub, yPub, zPub) Transactions |
| list_hd_wallet__x_pub_y_pub_z_pub_utxos | GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/utxos | List HD Wallet (xPub, yPub, zPub) UTXOs |
| list_synced_addresses | GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/synced-addresses | List Synced Addresses |
| prepare_a_utxo_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub | POST /blockchain-data/{blockchain}/{network}/transactions/prepare-utxo-transaction | Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub) |
| prepare_an_account_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub | POST /blockchain-data/{blockchain}/{network}/transactions/prepare-account-based-transaction | Prepare An Account-Based Transaction From HD Wallet (xPub, yPub, zPub) |
| sync_hd_wallet__x_pub_y_pub_z_pub | POST /blockchain-data/{blockchain}/{network}/hd/sync | Sync HD Wallet (xPub, yPub, zPub) |
| sync_new_hd_wallet__x_pub_y_pub_z_pub | POST /blockchain-data/{blockchain}/{network}/hd/sync-new | Sync New HD Wallet (xPub, yPub, zPub) |
DeriveAndSyncNewChangeAddressesR derive_and_sync_new_change_addresses(network)
Derive And Sync New Change Addresses
Through this endpoint users can derive 100 change addresses, starting from the last index we have data for, which are then added to the xPub, subscribed for syncing, and start recording data. If no data is available, it will start from index 0.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.derive_and_sync_new_change_addresses400_response import DeriveAndSyncNewChangeAddresses400Response
from cryptoapis.model.derive_and_sync_new_change_addresses_rb import DeriveAndSyncNewChangeAddressesRB
from cryptoapis.model.derive_and_sync_new_change_addresses403_response import DeriveAndSyncNewChangeAddresses403Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.derive_and_sync_new_change_addresses401_response import DeriveAndSyncNewChangeAddresses401Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.derive_and_sync_new_change_addresses_r import DeriveAndSyncNewChangeAddressesR
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
derive_and_sync_new_change_addresses_rb = DeriveAndSyncNewChangeAddressesRB(
context="yourExampleString",
data=DeriveAndSyncNewChangeAddressesRBData(
item=DeriveAndSyncNewChangeAddressesRBDataItem(
extended_public_key="xpub6BuJ8T4xTEePRTWxEcyyZRHPRZw91GFRjuu4H1eNqNGDswpraD5Hthf7JBbK7iQayuLf2MbxT6MVrKGbY7HvBcQo937Qiwmxz7Fzy9S5y9q",
),
),
) # DeriveAndSyncNewChangeAddressesRB | (optional)
# example passing only required values which don't have defaults set
try:
# Derive And Sync New Change Addresses
api_response = api_instance.derive_and_sync_new_change_addresses(network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->derive_and_sync_new_change_addresses: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Derive And Sync New Change Addresses
api_response = api_instance.derive_and_sync_new_change_addresses(network, context=context, derive_and_sync_new_change_addresses_rb=derive_and_sync_new_change_addresses_rb)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->derive_and_sync_new_change_addresses: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | defaults to "bitcoin" |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| derive_and_sync_new_change_addresses_rb | DeriveAndSyncNewChangeAddressesRB | [optional] |
DeriveAndSyncNewChangeAddressesR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfull Request | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeriveAndSyncNewReceivingAddressesR derive_and_sync_new_receiving_addresses(blockchain, network)
Derive And Sync New Receiving Addresses
Through this endpoint users can derive 100 receiving addresses, starting from the last index we have data for, which are then added to the xPub, subscribed for syncing, and start recording data. If no data is available, it will start from index 0.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.derive_and_sync_new_receiving_addresses400_response import DeriveAndSyncNewReceivingAddresses400Response
from cryptoapis.model.derive_and_sync_new_receiving_addresses_r import DeriveAndSyncNewReceivingAddressesR
from cryptoapis.model.derive_and_sync_new_receiving_addresses403_response import DeriveAndSyncNewReceivingAddresses403Response
from cryptoapis.model.derive_and_sync_new_receiving_addresses_rb import DeriveAndSyncNewReceivingAddressesRB
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.derive_and_sync_new_receiving_addresses401_response import DeriveAndSyncNewReceivingAddresses401Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
derive_and_sync_new_receiving_addresses_rb = DeriveAndSyncNewReceivingAddressesRB(
context="yourExampleString",
data=DeriveAndSyncNewReceivingAddressesRBData(
item=DeriveAndSyncNewReceivingAddressesRBDataItem(
extended_public_key="xpub6DSqNgZke91RZBXk9s8tBknGPiVB7AQqVyxHCLEM49D3VGeMWg6qmSDruSn7SgQApVH1M8cSvjXfDmhRysDt9hZWFAMcZf4X1DAzd23G4ZQ",
),
),
) # DeriveAndSyncNewReceivingAddressesRB | (optional)
# example passing only required values which don't have defaults set
try:
# Derive And Sync New Receiving Addresses
api_response = api_instance.derive_and_sync_new_receiving_addresses(blockchain, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->derive_and_sync_new_receiving_addresses: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Derive And Sync New Receiving Addresses
api_response = api_instance.derive_and_sync_new_receiving_addresses(blockchain, network, context=context, derive_and_sync_new_receiving_addresses_rb=derive_and_sync_new_receiving_addresses_rb)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->derive_and_sync_new_receiving_addresses: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| derive_and_sync_new_receiving_addresses_rb | DeriveAndSyncNewReceivingAddressesRB | [optional] |
DeriveAndSyncNewReceivingAddressesR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfull Request | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetHDWalletXPubYPubZPubAssetsR get_hd_wallet__x_pub_y_pub_z_pub_assets(blockchain, extended_public_key, network)
Get HD Wallet (xPub, yPub, zPub) Assets
This endpoint will return details on assets we support for a specified from the customer extended public key (xPub). These could be cryptocurrencies, fungible or non-fungible (NFT) tokens. Each asset has a unique identifier - assetId, and a unique symbol in the form of a string, e.g. "USDT".
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_assets400_response import GetHDWalletXPubYPubZPubAssets400Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_assets403_response import GetHDWalletXPubYPubZPubAssets403Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_assets_r import GetHDWalletXPubYPubZPubAssetsR
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_assets422_response import GetHDWalletXPubYPubZPubAssets422Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_assets401_response import GetHDWalletXPubYPubZPubAssets401Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "ethereum" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
extended_public_key = "xpub68SyZPMPpZUy9QB2fk2J28b5Rwd6jeWKind3K8oziZuVcL7wWZiXZNCPKuh42ejSpTLYngQ9Gbzj9a1Ap2QQmoFs2sMSbUvkEr8D3GW7MrR" # str | Defines the account extended publicly known key which is used to derive all child public keys.
network = "ropsten" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
derivation = "account" # str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. (optional)
# example passing only required values which don't have defaults set
try:
# Get HD Wallet (xPub, yPub, zPub) Assets
api_response = api_instance.get_hd_wallet__x_pub_y_pub_z_pub_assets(blockchain, extended_public_key, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->get_hd_wallet__x_pub_y_pub_z_pub_assets: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get HD Wallet (xPub, yPub, zPub) Assets
api_response = api_instance.get_hd_wallet__x_pub_y_pub_z_pub_assets(blockchain, extended_public_key, network, context=context, derivation=derivation)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->get_hd_wallet__x_pub_y_pub_z_pub_assets: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| extended_public_key | str | Defines the account extended publicly known key which is used to derive all child public keys. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| derivation | str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. | [optional] |
GetHDWalletXPubYPubZPubAssetsR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | 422 | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetHDWalletXPubYPubZPubDetailsR get_hd_wallet__x_pub_y_pub_z_pub_details(blockchain, extended_public_key, network)
Get HD Wallet (xPub, yPub, zPub) Details
HD wallet details is useful endpoint to get the most important data about HD wallet without the need to do a lot of calculations, once the HD Wallet is synced using Sync endpoint we keep it up to date and we calculate these details in advance.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_details422_response import GetHDWalletXPubYPubZPubDetails422Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_details400_response import GetHDWalletXPubYPubZPubDetails400Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_details403_response import GetHDWalletXPubYPubZPubDetails403Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_details_r import GetHDWalletXPubYPubZPubDetailsR
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.get_hd_wallet_x_pub_y_pub_z_pub_details401_response import GetHDWalletXPubYPubZPubDetails401Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
extended_public_key = "upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ" # str | Defines the account extended publicly known key which is used to derive all child public keys.
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
derivation = "account" # str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. (optional)
# example passing only required values which don't have defaults set
try:
# Get HD Wallet (xPub, yPub, zPub) Details
api_response = api_instance.get_hd_wallet__x_pub_y_pub_z_pub_details(blockchain, extended_public_key, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->get_hd_wallet__x_pub_y_pub_z_pub_details: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get HD Wallet (xPub, yPub, zPub) Details
api_response = api_instance.get_hd_wallet__x_pub_y_pub_z_pub_details(blockchain, extended_public_key, network, context=context, derivation=derivation)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->get_hd_wallet__x_pub_y_pub_z_pub_details: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| extended_public_key | str | Defines the account extended publicly known key which is used to derive all child public keys. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| derivation | str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. | [optional] |
GetHDWalletXPubYPubZPubDetailsR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | 422 | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListHDWalletXPubYPubZPubTransactionsR list_hd_wallet__x_pub_y_pub_z_pub_transactions(blockchain, extended_public_key, network)
List HD Wallet (xPub, yPub, zPub) Transactions
This endpoint will list HD Wallet transactions.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_transactions401_response import ListHDWalletXPubYPubZPubTransactions401Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_transactions_r import ListHDWalletXPubYPubZPubTransactionsR
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_transactions400_response import ListHDWalletXPubYPubZPubTransactions400Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_transactions403_response import ListHDWalletXPubYPubZPubTransactions403Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_transactions422_response import ListHDWalletXPubYPubZPubTransactions422Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain.
extended_public_key = "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" # str | Defines the master public key (xPub) of the account.
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
derivation = "account" # str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. (optional)
limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) if omitted the server will use the default value of 50
offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) if omitted the server will use the default value of 0
# example passing only required values which don't have defaults set
try:
# List HD Wallet (xPub, yPub, zPub) Transactions
api_response = api_instance.list_hd_wallet__x_pub_y_pub_z_pub_transactions(blockchain, extended_public_key, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->list_hd_wallet__x_pub_y_pub_z_pub_transactions: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# List HD Wallet (xPub, yPub, zPub) Transactions
api_response = api_instance.list_hd_wallet__x_pub_y_pub_z_pub_transactions(blockchain, extended_public_key, network, context=context, derivation=derivation, limit=limit, offset=offset)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->list_hd_wallet__x_pub_y_pub_z_pub_transactions: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain. | |
| extended_public_key | str | Defines the master public key (xPub) of the account. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| derivation | str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. | [optional] |
| limit | int | Defines how many items should be returned in the response per page basis. | [optional] if omitted the server will use the default value of 50 |
| offset | int | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional] if omitted the server will use the default value of 0 |
ListHDWalletXPubYPubZPubTransactionsR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | 422 | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListHDWalletXPubYPubZPubUTXOsR list_hd_wallet__x_pub_y_pub_z_pub_utxos(blockchain, extended_public_key, network)
List HD Wallet (xPub, yPub, zPub) UTXOs
Through this endpoint you can list HD wallet's UTXOs (Unspent Transaction Outputs) by providing extended public key of an already synced HD wallet.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_utxos_r import ListHDWalletXPubYPubZPubUTXOsR
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_utxos400_response import ListHDWalletXPubYPubZPubUTXOs400Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_utxos401_response import ListHDWalletXPubYPubZPubUTXOs401Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_utxos422_response import ListHDWalletXPubYPubZPubUTXOs422Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.list_hd_wallet_x_pub_y_pub_z_pub_utxos403_response import ListHDWalletXPubYPubZPubUTXOs403Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
extended_public_key = "tpubDDCs6jf3Tg8VTts6EBCNpibVanPQpSkmYRLAXVvuhcuC6ZcbYtEizqERj8D4TBukuvjNSjtjEbKYdtFuRG5WuisrirZG9m5L8wUvf4bHhgQ" # str | Defines the account extended publicly known key which is used to derive all child public keys.
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
derivation = "account" # str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. (optional)
limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) if omitted the server will use the default value of 50
offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) if omitted the server will use the default value of 0
# example passing only required values which don't have defaults set
try:
# List HD Wallet (xPub, yPub, zPub) UTXOs
api_response = api_instance.list_hd_wallet__x_pub_y_pub_z_pub_utxos(blockchain, extended_public_key, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->list_hd_wallet__x_pub_y_pub_z_pub_utxos: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# List HD Wallet (xPub, yPub, zPub) UTXOs
api_response = api_instance.list_hd_wallet__x_pub_y_pub_z_pub_utxos(blockchain, extended_public_key, network, context=context, derivation=derivation, limit=limit, offset=offset)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->list_hd_wallet__x_pub_y_pub_z_pub_utxos: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| extended_public_key | str | Defines the account extended publicly known key which is used to derive all child public keys. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| derivation | str | The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly. | [optional] |
| limit | int | Defines how many items should be returned in the response per page basis. | [optional] if omitted the server will use the default value of 50 |
| offset | int | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional] if omitted the server will use the default value of 0 |
ListHDWalletXPubYPubZPubUTXOsR
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | 422 | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListSyncedAddressesR list_synced_addresses(blockchain, extended_public_key, network)
List Synced Addresses
Through this endpoint users can list all addresses that Crypto APIs has synced for a specific xPub. This includes previous and current/new xPubs, what addresses we’ve synced for them, etc.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.list_synced_addresses403_response import ListSyncedAddresses403Response
from cryptoapis.model.list_synced_addresses400_response import ListSyncedAddresses400Response
from cryptoapis.model.list_synced_addresses401_response import ListSyncedAddresses401Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.list_synced_addresses_r import ListSyncedAddressesR
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "ethereum" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
extended_public_key = "tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w" # str | Defines the account extended publicly known key which is used to derive all child public keys.
network = "ropsten" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
address_format = "standard" # str | Defines the address format value. (optional)
is_change_address = False # bool | Defines if the address is change addres or not. (optional) if omitted the server will use the default value of True
limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) if omitted the server will use the default value of 50
offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) if omitted the server will use the default value of 0
# example passing only required values which don't have defaults set
try:
# List Synced Addresses
api_response = api_instance.list_synced_addresses(blockchain, extended_public_key, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->list_synced_addresses: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# List Synced Addresses
api_response = api_instance.list_synced_addresses(blockchain, extended_public_key, network, context=context, address_format=address_format, is_change_address=is_change_address, limit=limit, offset=offset)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->list_synced_addresses: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| extended_public_key | str | Defines the account extended publicly known key which is used to derive all child public keys. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| address_format | str | Defines the address format value. | [optional] |
| is_change_address | bool | Defines if the address is change addres or not. | [optional] if omitted the server will use the default value of True |
| limit | int | Defines how many items should be returned in the response per page basis. | [optional] if omitted the server will use the default value of 50 |
| offset | int | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional] if omitted the server will use the default value of 0 |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request has been successful. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubR prepare_a_utxo_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub(network)
Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)
Through the “Prepare a UTXO-based transaction from xPub” endpoint users can prepare a transaction for signing from all synced with Crypto APIs addresses for the specific xPub. This is based on the selectionStrategy and the addresses’ balances. In the case a user has an address not synced with Crypto APIs, it will not be included. This endpoint applies to all supported UTXO-based blockchain protocols, e.g. Bitcoin, Litecoin, etc.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub401_response import PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPub401Response
from cryptoapis.model.prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub400_response import PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPub400Response
from cryptoapis.model.prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub403_response import PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPub403Response
from cryptoapis.model.prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_r import PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubR
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb import PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRB
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
network = "testnet" # str |
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb = PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRB(
context="yourExampleString",
data=PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRBData(
item=PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRBDataItem(
additional_data="yourAdditionalDataHere",
fee=PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRBDataItemFee(
address="tb1q8wus03xdv3t6aknmsnpd0jmeu7dgh93j34pj5a",
exact_amount="0.00023",
priority="standard",
),
locktime=1659001055,
prepare_strategy="minimize-dust",
recipients=[
PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRBDataItemRecipientsInner(
address="tb1q8wus03xdv3t6aknmsnpd0jmeu7dgh93j34pj5a",
amount="0.00003",
),
],
replaceable=False,
xpub="tpubDCNoSqt3HF32yq8VU6mgapTuW1FzENZa3C5dKUF6WCQzubWz2nA1yxUhMQWkhhkD58Uc8YiuD8cmB3y5tihqAv4zT2GNyqKTNLchHJmsvt9",
),
),
) # PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRB | (optional)
# example passing only required values which don't have defaults set
try:
# Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)
api_response = api_instance.prepare_a_utxo_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub(network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->prepare_a_utxo_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)
api_response = api_instance.prepare_a_utxo_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub(network, context=context, prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb=prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->prepare_a_utxo_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| network | str | ||
| blockchain | str | defaults to "bitcoin" | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| prepare_autxo_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb | PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubRB | [optional] |
PrepareAUTXOBasedTransactionFromHDWalletXPubYPubZPubR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The resource has been successfully submitted. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubR prepare_an_account_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub(network)
Prepare An Account-Based Transaction From HD Wallet (xPub, yPub, zPub)
Through the “Prepare an account-based transaction from xPub” endpoint users can prepare a transaction for signing from a synced with Crypto APIs address from the specific xPub. This endpoint applies to all supported account-based blockchain protocols, e.g. Ethereum, BSC, etc
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.convert_bitcoin_cash_address422_response import ConvertBitcoinCashAddress422Response
from cryptoapis.model.prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub401_response import PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPub401Response
from cryptoapis.model.prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub403_response import PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPub403Response
from cryptoapis.model.prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_r import PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubR
from cryptoapis.model.prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub400_response import PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPub400Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address409_response import ConvertBitcoinCashAddress409Response
from cryptoapis.model.prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb import PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRB
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
network = "ropsten" # str |
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb = PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRB(
context="yourExampleString",
data=PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRBData(
item=PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRBDataItem(
additional_data="yourAdditionalDataHere",
amount="0.000003",
fee=PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRBDataItemFee(
exact_amount="0.00045",
priority="standard",
),
nonce="0",
recipient="0x041c594a0cc194e826bef5411b29c7f27001b7e3",
sender="0x03654A9E78771442CAdf8DB37ae60D6a12bAEa9f",
transaction_type="access-list-transaction",
xpub="xpub6CsGdqTDEVRnLmpWN218HBwJqfhqSx46iA8ByzEA5Bz9jfwU3TSg9U7ambKgJyykvCraHQ6sAFAddMGFdPzhXrRanKbHnnkbDTyRPyn5gRJ",
),
),
) # PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRB | (optional)
# example passing only required values which don't have defaults set
try:
# Prepare An Account-Based Transaction From HD Wallet (xPub, yPub, zPub)
api_response = api_instance.prepare_an_account_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub(network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->prepare_an_account_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Prepare An Account-Based Transaction From HD Wallet (xPub, yPub, zPub)
api_response = api_instance.prepare_an_account_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub(network, context=context, prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb=prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->prepare_an_account_based_transaction_from_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| network | str | ||
| blockchain | str | defaults to "ethereum" | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| prepare_an_account_based_transaction_from_hd_wallet_x_pub_y_pub_z_pub_rb | PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubRB | [optional] |
PrepareAnAccountBasedTransactionFromHDWalletXPubYPubZPubR
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The resource has been successfully submitted. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | The data provided seems to be invalid. | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | Your request body for POST requests must have a structure of { data: { item: [...properties] } } | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SyncHDWalletXPubYPubZPubR sync_hd_wallet__x_pub_y_pub_z_pub(blockchain, network)
Sync HD Wallet (xPub, yPub, zPub)
HD wallets usually have a lot of addresses and transactions, getting the data on demand is a heavy operation. That's why we have created this feature, to be able to get HD wallet details or transactions this HD wallet must be synced first. In addition to the initial sync we keep updating the synced HD wallets all the time.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub_r import SyncHDWalletXPubYPubZPubR
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub401_response import SyncHDWalletXPubYPubZPub401Response
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub_rb import SyncHDWalletXPubYPubZPubRB
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub422_response import SyncHDWalletXPubYPubZPub422Response
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub409_response import SyncHDWalletXPubYPubZPub409Response
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub403_response import SyncHDWalletXPubYPubZPub403Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.sync_hd_wallet_x_pub_y_pub_z_pub400_response import SyncHDWalletXPubYPubZPub400Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
sync_hd_wallet_x_pub_y_pub_z_pub_rb = SyncHDWalletXPubYPubZPubRB(
context="yourExampleString",
data=SyncHDWalletXPubYPubZPubRBData(
item=SyncHDWalletXPubYPubZPubRBDataItem(
extended_public_key="upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ",
),
),
) # SyncHDWalletXPubYPubZPubRB | (optional)
# example passing only required values which don't have defaults set
try:
# Sync HD Wallet (xPub, yPub, zPub)
api_response = api_instance.sync_hd_wallet__x_pub_y_pub_z_pub(blockchain, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->sync_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Sync HD Wallet (xPub, yPub, zPub)
api_response = api_instance.sync_hd_wallet__x_pub_y_pub_z_pub(blockchain, network, context=context, sync_hd_wallet_x_pub_y_pub_z_pub_rb=sync_hd_wallet_x_pub_y_pub_z_pub_rb)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->sync_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| sync_hd_wallet_x_pub_y_pub_z_pub_rb | SyncHDWalletXPubYPubZPubRB | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | 422 | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SyncNewHDWalletXPubYPubZPubR sync_new_hd_wallet__x_pub_y_pub_z_pub(blockchain, network)
Sync New HD Wallet (xPub, yPub, zPub)
Through this endpoint users can add a brand new xPub to the Crypto APIs system to be ready for deriving. Unlike our other similar endpoint “Sync HD Wallet (xPub, yPub, zPub)”, this endpoint does not create new addresses nor syncs old data.
- Api Key Authentication (ApiKey):
import time
import cryptoapis
from cryptoapis.api import hd_wallets_api
from cryptoapis.model.convert_bitcoin_cash_address429_response import ConvertBitcoinCashAddress429Response
from cryptoapis.model.convert_bitcoin_cash_address500_response import ConvertBitcoinCashAddress500Response
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub400_response import SyncNewHDWalletXPubYPubZPub400Response
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub_rb import SyncNewHDWalletXPubYPubZPubRB
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub422_response import SyncNewHDWalletXPubYPubZPub422Response
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub403_response import SyncNewHDWalletXPubYPubZPub403Response
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub409_response import SyncNewHDWalletXPubYPubZPub409Response
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub_r import SyncNewHDWalletXPubYPubZPubR
from cryptoapis.model.sync_new_hd_wallet_x_pub_y_pub_z_pub401_response import SyncNewHDWalletXPubYPubZPub401Response
from cryptoapis.model.convert_bitcoin_cash_address402_response import ConvertBitcoinCashAddress402Response
from cryptoapis.model.convert_bitcoin_cash_address415_response import ConvertBitcoinCashAddress415Response
from pprint import pprint
# Defining the host is optional and defaults to https://rest.cryptoapis.io
# See configuration.py for a list of all supported configuration parameters.
configuration = cryptoapis.Configuration(
host = "https://rest.cryptoapis.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with cryptoapis.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hd_wallets_api.HDWalletsApi(api_client)
blockchain = "bitcoin" # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network = "testnet" # str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\" are test networks.
context = "yourExampleString" # str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. (optional)
sync_new_hd_wallet_x_pub_y_pub_z_pub_rb = SyncNewHDWalletXPubYPubZPubRB(
context="yourExampleString",
data=SyncHDWalletXPubYPubZPubRBData(
item=SyncHDWalletXPubYPubZPubRBDataItem(
extended_public_key="upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ",
),
),
) # SyncNewHDWalletXPubYPubZPubRB | (optional)
# example passing only required values which don't have defaults set
try:
# Sync New HD Wallet (xPub, yPub, zPub)
api_response = api_instance.sync_new_hd_wallet__x_pub_y_pub_z_pub(blockchain, network)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->sync_new_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Sync New HD Wallet (xPub, yPub, zPub)
api_response = api_instance.sync_new_hd_wallet__x_pub_y_pub_z_pub(blockchain, network, context=context, sync_new_hd_wallet_x_pub_y_pub_z_pub_rb=sync_new_hd_wallet_x_pub_y_pub_z_pub_rb)
pprint(api_response)
except cryptoapis.ApiException as e:
print("Exception when calling HDWalletsApi->sync_new_hd_wallet__x_pub_y_pub_z_pub: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| blockchain | str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | |
| network | str | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks. | |
| context | str | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | [optional] |
| sync_new_hd_wallet_x_pub_y_pub_z_pub_rb | SyncNewHDWalletXPubYPubZPubRB | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The resource has been successfully created. | - |
| 400 | 400 | - |
| 401 | 401 | - |
| 402 | You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. | - |
| 403 | 403 | - |
| 409 | 409 | - |
| 415 | The selected Media Type is unavailable. The Content-Type header should be 'application/json'. | - |
| 422 | 422 | - |
| 429 | The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. | - |
| 500 | An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]