cryptoapis.InformativeApi

All URIs are relative to https://rest.cryptoapis.io

Method	HTTP request	Description
get_transaction_request_details	GET /wallet-as-a-service/transactionRequests/{transactionRequestId}	Get Transaction Request Details
get_wallet_asset_details	GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}	Get Wallet Asset Details
get_wallet_transaction_details_by_transaction_id	GET /wallet-as-a-service/wallets/{blockchain}/{network}/transactions/{transactionId}	Get Wallet Transaction Details By Transaction ID
list_all_assets_by_wallet_id	GET /wallet-as-a-service/wallets/{walletId}/assets	List All Assets By Wallet ID
list_all_assets_from_all_wallets	GET /wallet-as-a-service/wallets/all-assets	List All Assets From All Wallets
list_deposit_addresses	GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses	List Deposit Addresses
list_supported_tokens	GET /wallet-as-a-service/info/{blockchain}/{network}/supported-tokens	List Supported Tokens
list_wallet_transactions	GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transactions	List Wallet Transactions

get_transaction_request_details

GetTransactionRequestDetailsR get_transaction_request_details(transaction_request_id, context=context)

Get Transaction Request Details

Through this endpoint customers can obtain details on transaction request. {note}This regards transaction requests, which is not to be confused with transactions. Transaction requests may not be approved due to any reason, hence a transaction may not occur.{/note}

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.get_transaction_request_details_r import GetTransactionRequestDetailsR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(api_client)
    transaction_request_id = '6115126693397c0006f78eb4' # str | Represents the unique ID of the transaction request.
    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)

    try:
        # Get Transaction Request Details
        api_response = api_instance.get_transaction_request_details(transaction_request_id, context=context)
        print("The response of InformativeApi->get_transaction_request_details:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->get_transaction_request_details: %s\n" % e)

Parameters

Name	Type	Description	Notes
transaction_request_id	str	Represents the unique ID of the transaction request.
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]

Return type

GetTransactionRequestDetailsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

get_wallet_asset_details

GetWalletAssetDetailsR get_wallet_asset_details(blockchain, network, wallet_id, context=context)

Get Wallet Asset Details

Through this endpoint customers can obtain details on all assets (coins, fungible tokens, non-fungible tokens) for the entire Wallet.

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.get_wallet_asset_details_r import GetWalletAssetDetailsR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(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.
    wallet_id = '60c9d9921c38030006675ff6' # str | Defines the unique ID of the Wallet.
    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)

    try:
        # Get Wallet Asset Details
        api_response = api_instance.get_wallet_asset_details(blockchain, network, wallet_id, context=context)
        print("The response of InformativeApi->get_wallet_asset_details:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->get_wallet_asset_details: %s\n" % e)

Parameters

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.
wallet_id	str	Defines the unique ID of the Wallet.
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]

Return type

GetWalletAssetDetailsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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	-
404	The specified resource has not been found.	-
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]

get_wallet_transaction_details_by_transaction_id

GetWalletTransactionDetailsByTransactionIDR get_wallet_transaction_details_by_transaction_id(blockchain, network, transaction_id, context=context)

Get Wallet Transaction Details By Transaction ID

Through this endpoint users can obtain Wallet transaction information by providing a transactionId. Customers can receive information only for a transaction that has been made from their own wallet.

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.get_wallet_transaction_details_by_transaction_idr import GetWalletTransactionDetailsByTransactionIDR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(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\", \"goerli\" are test networks.
    transaction_id = '3e081861494aed897e589cdeab5d9e628d985e571ed1c19896d1aa698cce9d80' # str | Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.
    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)

    try:
        # Get Wallet Transaction Details By Transaction ID
        api_response = api_instance.get_wallet_transaction_details_by_transaction_id(blockchain, network, transaction_id, context=context)
        print("The response of InformativeApi->get_wallet_transaction_details_by_transaction_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->get_wallet_transaction_details_by_transaction_id: %s\n" % e)

Parameters

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", "goerli" are test networks.
transaction_id	str	Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.
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]

Return type

GetWalletTransactionDetailsByTransactionIDR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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	-
404	The specified resource has not been found.	-
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]

list_all_assets_by_wallet_id

ListAllAssetsByWalletIDR list_all_assets_by_wallet_id(wallet_id, context=context)

List All Assets By Wallet ID

Through this endpoint customers can obtain information about available assets in one of their wallets, regardless of the blockchain protocol or network, by providing walletId.

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.list_all_assets_by_wallet_idr import ListAllAssetsByWalletIDR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(api_client)
    wallet_id = '60c9d9921c38030006675ff6' # str | Defines the unique ID of the Wallet.
    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)

    try:
        # List All Assets By Wallet ID
        api_response = api_instance.list_all_assets_by_wallet_id(wallet_id, context=context)
        print("The response of InformativeApi->list_all_assets_by_wallet_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->list_all_assets_by_wallet_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Defines the unique ID of the Wallet.
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]

Return type

ListAllAssetsByWalletIDR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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	-
404	The specified resource has not been found.	-
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]

list_all_assets_from_all_wallets

ListAllAssetsFromAllWalletsR list_all_assets_from_all_wallets(context=context, limit=limit, offset=offset)

List All Assets From All Wallets

Through this endpoint customers can obtain information about available assets in all of their wallets, regardless of the blockchain protocol or network.

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.list_all_assets_from_all_wallets_r import ListAllAssetsFromAllWalletsR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(api_client)
    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)
    limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)

    try:
        # List All Assets From All Wallets
        api_response = api_instance.list_all_assets_from_all_wallets(context=context, limit=limit, offset=offset)
        print("The response of InformativeApi->list_all_assets_from_all_wallets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->list_all_assets_from_all_wallets: %s\n" % e)

Parameters

Name	Type	Description	Notes
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]
limit	int	Defines how many items should be returned in the response per page basis.	[optional] [default to 50]
offset	int	The starting index of the response items, i.e. where the response should start listing the returned items.	[optional] [default to 0]

Return type

ListAllAssetsFromAllWalletsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

list_deposit_addresses

ListDepositAddressesR list_deposit_addresses(blockchain, network, wallet_id, context=context, limit=limit, offset=offset)

List Deposit Addresses

Through this endpoint customers can pull a list of Deposit/Receiving Addresses they have already generated. {note}Please note that listing data from the same type will apply pagination on the results.{/note}

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.list_deposit_addresses_r import ListDepositAddressesR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(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.
    wallet_id = '60c9d9921c38030006675ff6' # str | Represents the unique ID of the specific Wallet.
    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)
    limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)

    try:
        # List Deposit Addresses
        api_response = api_instance.list_deposit_addresses(blockchain, network, wallet_id, context=context, limit=limit, offset=offset)
        print("The response of InformativeApi->list_deposit_addresses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->list_deposit_addresses: %s\n" % e)

Parameters

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.
wallet_id	str	Represents the unique ID of the specific Wallet.
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]
limit	int	Defines how many items should be returned in the response per page basis.	[optional] [default to 50]
offset	int	The starting index of the response items, i.e. where the response should start listing the returned items.	[optional] [default to 0]

Return type

ListDepositAddressesR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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	-
404	The specified resource has not been found.	-
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]

list_supported_tokens

ListSupportedTokensR list_supported_tokens(blockchain, network, context=context, limit=limit, offset=offset)

List Supported Tokens

Through this endpoint customers can obtain information on multiple tokens at once.

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.list_supported_tokens_r import ListSupportedTokensR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(api_client)
    blockchain = 'ethereum' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
    network = 'goerli' # 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\", \"goerli\" 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)
    limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)

    try:
        # List Supported Tokens
        api_response = api_instance.list_supported_tokens(blockchain, network, context=context, limit=limit, offset=offset)
        print("The response of InformativeApi->list_supported_tokens:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->list_supported_tokens: %s\n" % e)

Parameters

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", "goerli" 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]
limit	int	Defines how many items should be returned in the response per page basis.	[optional] [default to 50]
offset	int	The starting index of the response items, i.e. where the response should start listing the returned items.	[optional] [default to 0]

Return type

ListSupportedTokensR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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]

list_wallet_transactions

ListWalletTransactionsR list_wallet_transactions(blockchain, network, wallet_id, context=context, limit=limit, offset=offset)

List Wallet Transactions

Through this endpoint customers can list Transactions from and to their Wallet. The data returned will include transactionId, direction of the transaction - incoming or outgoing, amount and more.

Example

Api Key Authentication (ApiKey):

import time
import os
import cryptoapis
from cryptoapis.models.list_wallet_transactions_r import ListWalletTransactionsR
from cryptoapis.rest import ApiException
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'] = os.environ["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 = cryptoapis.InformativeApi(api_client)
    blockchain = 'ethereum' # str | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
    network = 'goerli' # 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\", \"goerli\" are test networks.
    wallet_id = '629df9dbae857c00073de9c8' # str | Represents the unique ID of the specific Wallet.
    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)
    limit = 50 # int | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset = 0 # int | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)

    try:
        # List Wallet Transactions
        api_response = api_instance.list_wallet_transactions(blockchain, network, wallet_id, context=context, limit=limit, offset=offset)
        print("The response of InformativeApi->list_wallet_transactions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InformativeApi->list_wallet_transactions: %s\n" % e)

Parameters

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", "goerli" are test networks.
wallet_id	str	Represents the unique ID of the specific Wallet.
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]
limit	int	Defines how many items should be returned in the response per page basis.	[optional] [default to 50]
offset	int	The starting index of the response items, i.e. where the response should start listing the returned items.	[optional] [default to 0]

Return type

ListWalletTransactionsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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	-
404	The specified resource has not been found.	-
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]

FilesExpand file tree

InformativeApi.md

Latest commit

History

InformativeApi.md

File metadata and controls

cryptoapis.InformativeApi

get_transaction_request_details

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_wallet_asset_details

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_wallet_transaction_details_by_transaction_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_all_assets_by_wallet_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_all_assets_from_all_wallets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_deposit_addresses

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_supported_tokens

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_wallet_transactions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details