cryptoapis

CryptoAPIs


Keywords
OpenAPI, OpenAPI-Generator, CryptoAPIs
License
MIT
Install
pip install cryptoapis==1.4.0

Documentation

cryptoapis

Crypto APIs is a complex and innovative infrastructure layer that radically simplifies the development of any Blockchain and Crypto related applications. Organized around REST, Crypto APIs can assist both novice Bitcoin/Ethereum enthusiasts and crypto experts with the development of their blockchain applications. Crypto APIs provides unified endpoints and data, raw data, automatic tokens and coins forwardings, callback functionalities, and much more.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2021-03-20
  • Package version: 1.8.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://cryptoapis.io

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install cryptoapis

Then import the package:

import cryptoapis

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import cryptoapis

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import cryptoapis
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.AssetsApi(api_client)
    asset_id = '5b1ea92e584bf50020130612' # str | Defines the unique ID of the specific asset.
    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 Asset Details By Asset ID
        api_response = api_instance.get_asset_details_by_asset_id(asset_id, context=context)
        print("The response of AssetsApi->get_asset_details_by_asset_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssetsApi->get_asset_details_by_asset_id: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AssetsApi get_asset_details_by_asset_id GET /market-data/assets/assetId/{assetId} Get Asset Details By Asset ID
AssetsApi get_asset_details_by_asset_symbol GET /market-data/assets/{assetSymbol} Get Asset Details By Asset Symbol
AutomaticCoinsForwardingApi create_automatic_coins_forwarding POST /blockchain-automations/{blockchain}/{network}/coins-forwarding/automations Create Automatic Coins Forwarding
AutomaticCoinsForwardingApi delete_automatic_coins_forwarding DELETE /blockchain-automations/{blockchain}/{network}/coins-forwarding/automations/{referenceId} Delete Automatic Coins Forwarding
AutomaticCoinsForwardingApi list_coins_forwarding_automations GET /blockchain-automations/{blockchain}/{network}/coins-forwarding/automations List Coins Forwarding Automations
AutomaticTokensForwardingApi add_tokens_to_existing_from_address POST /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations/add-token Add Tokens To Existing fromAddress
AutomaticTokensForwardingApi create_automatic_tokens_forwarding POST /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations Create Automatic Tokens Forwarding
AutomaticTokensForwardingApi delete_automatic_tokens_forwarding DELETE /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations/{referenceId} Delete Automatic Tokens Forwarding
AutomaticTokensForwardingApi get_fee_address_details GET /blockchain-automations/{blockchain}/{network}/tokens-forwarding/fee-addresses Get Fee Address Details
AutomaticTokensForwardingApi list_tokens_forwarding_automations GET /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations List Tokens Forwarding Automations
CallbackDataApi get_address_details_from_callback GET /blockchain-events/{blockchain}/{network}/addresses/{address} Get Address Details From Callback
CallbackDataApi get_block_details_by_block_hash_from_callback GET /blockchain-events/{blockchain}/{network}/blocks/hash/{blockHash} Get Block Details By Block Hash From Callback
CallbackDataApi get_block_details_by_block_height_from_callback GET /blockchain-events/{blockchain}/{network}/blocks/height/{blockHeight} Get Block Details By Block Height From Callback
CallbackDataApi get_transaction_details_by_transaction_id_from_callback GET /blockchain-events/{blockchain}/{network}/transactions/{transactionId} Get Transaction Details By Transaction ID From Callback
CreateSubscriptionsForApi new_reverted_block POST /blockchain-events/{blockchain}/{network}/subscriptions/reverted-block New Reverted Block
CreateSubscriptionsForApi block_height_reached POST /blockchain-events/{blockchain}/{network}/subscriptions/block-height-reached Block Height Reached
CreateSubscriptionsForApi mined_transaction POST /blockchain-events/{blockchain}/{network}/subscriptions/transaction-mined Mined Transaction
CreateSubscriptionsForApi new_block POST /blockchain-events/{blockchain}/{network}/subscriptions/block-mined New Block
CreateSubscriptionsForApi new_confirmed_coins_transactions POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-confirmed New confirmed coins transactions
CreateSubscriptionsForApi new_confirmed_coins_transactions_and_each_confirmation POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-confirmed-each-confirmation New confirmed coins transactions and each confirmation
CreateSubscriptionsForApi new_confirmed_internal_transactions POST /blockchain-events/{blockchain}/{network}/subscriptions/address-internal-transactions-confirmed New Confirmed Internal Transactions
CreateSubscriptionsForApi new_confirmed_internal_transactions_and_each_confirmation POST /blockchain-events/{blockchain}/{network}/subscriptions/address-internal-transactions-confirmed-each-confirmation New Confirmed Internal Transactions And Each Confirmation
CreateSubscriptionsForApi new_confirmed_tokens_transactions POST /blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-confirmed New confirmed tokens transactions
CreateSubscriptionsForApi new_confirmed_tokens_transactions_and_each_confirmation POST /blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-confirmed-each-confirmation New confirmed tokens transactions and each confirmation
CreateSubscriptionsForApi new_unconfirmed_coins_transactions POST /blockchain-events/{blockchain}/{network}/subscriptions/address-coins-transactions-unconfirmed New Unconfirmed Coins Transactions
CreateSubscriptionsForApi new_unconfirmed_tokens_transactions POST /blockchain-events/{blockchain}/{network}/subscriptions/address-tokens-transactions-unconfirmed New Unconfirmed Tokens Transactions
ExchangeRatesApi get_exchange_rate_by_asset_symbols GET /market-data/exchange-rates/by-symbols/{fromAssetSymbol}/{toAssetSymbol} Get Exchange Rate By Asset Symbols
ExchangeRatesApi get_exchange_rate_by_assets_ids GET /market-data/exchange-rates/by-asset-ids/{fromAssetId}/{toAssetId} Get Exchange Rate By Assets IDs
FeaturesApi broadcast_locally_signed_transaction POST /blockchain-tools/{blockchain}/{network}/transactions/broadcast Broadcast Locally Signed Transaction
FeaturesApi convert_bitcoin_cash_address POST /blockchain-tools/{blockchain}/{network}/address/convert Convert Bitcoin Cash Address
FeaturesApi decode_raw_transaction_hex POST /blockchain-tools/{blockchain}/{network}/decode-raw-transaction Decode Raw Transaction Hex
FeaturesApi decode_x_address GET /blockchain-tools/{blockchain}/{network}/decode-x-address/{xAddress} Decode X-Address
FeaturesApi derive_hd_wallet__x_pub_y_pub_z_pub_change_or_receiving_addresses GET /blockchain-tools/{blockchain}/{network}/hd/{extendedPublicKey}/addresses/derive-address Derive HD Wallet (xPub, yPub, zPub) Change Or Receiving Addresses
FeaturesApi encode_x_address GET /blockchain-tools/{blockchain}/{network}/encode-x-address/{classicAddress}/{addressTag} Encode X-Address
FeaturesApi estimate_gas_limit POST /blockchain-tools/{blockchain}/{network}/gas-limit Estimate Gas Limit
FeaturesApi estimate_token_gas_limit POST /blockchain-tools/{blockchain}/{network}/gas-limit/contract Estimate Token Gas Limit
FeaturesApi get_eip_1559_fee_recommendations GET /blockchain-tools/{blockchain}/{network}/fees/eip1559 Get EIP 1559 Fee Recommendations
FeaturesApi prepare_a_fungible_token_transfer_from_address POST /blockchain-tools/{blockchain}/{network}/transactions/prepare-token-from-address Prepare A Fungible Token Transfer From Address
FeaturesApi prepare_a_non_fungible_token_transfer_from_address POST /blockchain-tools/{blockchain}/{network}/transactions/prepare-nft-from-address Prepare A Non Fungible Token Transfer From Address
FeaturesApi prepare_transaction_from_address POST /blockchain-data/{blockchain}/{network}/transactions/prepare-from-address Prepare Transaction From Address
FeaturesApi validate_address POST /blockchain-tools/{blockchain}/{network}/addresses/validate Validate Address
GeneratingApi create_new_master_wallet POST /wallet-as-a-service/wallets/generate Create New Master Wallet
GeneratingApi generate_deposit_address POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses Generate Deposit Address
HDWalletsApi derive_and_sync_new_change_addresses POST /blockchain-data/{blockchain}/{network}/hd/derive-sync-change Derive And Sync New Change Addresses
HDWalletsApi derive_and_sync_new_receiving_addresses POST /blockchain-data/{blockchain}/{network}/hd/derive-and-sync Derive And Sync New Receiving Addresses
HDWalletsApi 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
HDWalletsApi 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
HDWalletsApi 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
HDWalletsApi 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
HDWalletsApi list_synced_addresses GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/synced-addresses List Synced Addresses
HDWalletsApi prepare_a_transaction_from_an_address_in_hd_wallet__x_pub_y_pub_z_pub POST /blockchain-data/{blockchain}/{network}/transactions/prepare-account-based-transaction Prepare A Transaction From An Address In HD Wallet (xPub, yPub, zPub)
HDWalletsApi 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)
HDWalletsApi sync_hd_wallet__x_pub_y_pub_z_pub POST /blockchain-data/{blockchain}/{network}/hd/sync Sync HD Wallet (xPub, yPub, zPub)
HDWalletsApi 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)
InformativeApi get_transaction_request_details GET /wallet-as-a-service/transactionRequests/{transactionRequestId} Get Transaction Request Details
InformativeApi get_wallet_asset_details GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network} Get Wallet Asset Details
InformativeApi get_wallet_transaction_details_by_transaction_id GET /wallet-as-a-service/wallets/{blockchain}/{network}/transactions/{transactionId} Get Wallet Transaction Details By Transaction ID
InformativeApi list_all_assets_by_wallet_id GET /wallet-as-a-service/wallets/{walletId}/assets List All Assets By Wallet ID
InformativeApi list_all_assets_from_all_wallets GET /wallet-as-a-service/wallets/all-assets List All Assets From All Wallets
InformativeApi list_deposit_addresses GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses List Deposit Addresses
InformativeApi list_supported_tokens GET /wallet-as-a-service/info/{blockchain}/{network}/supported-tokens List Supported Tokens
InformativeApi list_wallet_transactions GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transactions List Wallet Transactions
ManageSubscriptionsApi activate_blockchain_event_subscription POST /blockchain-events/subscriptions/{referenceId}/activate Activate Blockchain Event Subscription
ManageSubscriptionsApi delete_blockchain_event_subscription DELETE /blockchain-events/{blockchain}/{network}/subscriptions/{referenceId} Delete Blockchain Event Subscription
ManageSubscriptionsApi get_blockchain_event_subscription_details_by_reference_id GET /blockchain-events/subscriptions/{referenceId} Get Blockchain Event Subscription Details By Reference ID
ManageSubscriptionsApi list_blockchain_events_subscriptions GET /blockchain-events/{blockchain}/{network}/subscriptions List Blockchain Events Subscriptions
MetadataApi list_supported_assets GET /market-data/assets/supported List Supported Assets
TokensApi get_token_details_by_contract_address GET /blockchain-data/{blockchain}/{network}/addresses/{contractAddress}/contract Get Token Details by Contract Address
TokensApi list_confirmed_tokens_transfers_by_address GET /blockchain-data/{blockchain}/{network}/addresses/{address}/tokens-transfers List Confirmed Tokens Transfers By Address
TokensApi list_tokens_by_address GET /blockchain-data/{blockchain}/{network}/addresses/{address}/tokens List Tokens By Address
TokensApi list_tokens_transfers_by_transaction_hash GET /blockchain-data/{blockchain}/{network}/transactions/{transactionHash}/tokens-transfers List Tokens Transfers By Transaction Hash
TokensApi list_unconfirmed_tokens_transfers_by_address GET /blockchain-data/{blockchain}/{network}/addresses/{address}/tokens-transfers-unconfirmed List Unconfirmed Tokens Transfers By Address
TransactionsApi create_coins_transaction_from_address_for_whole_amount POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{address}/all-transaction-requests Create Coins Transaction From Address For Whole Amount
TransactionsApi create_coins_transaction_request_from_address POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{address}/transaction-requests Create Coins Transaction Request from Address
TransactionsApi create_coins_transaction_request_from_wallet POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transaction-requests Create Coins Transaction Request from Wallet
TransactionsApi create_fungible_token_transaction_request_from_address_without_fee_priority POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{senderAddress}/feeless-token-transaction-requests Create Fungible Token Transaction Request From Address Without Fee Priority
TransactionsApi create_fungible_tokens_transaction_request_from_address POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{senderAddress}/token-transaction-requests Create Fungible Tokens Transaction Request from Address
TransactionsApi create_single_transaction_request_from_address_without_fee_priority POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{address}/feeless-transaction-requests Create Single Transaction Request From Address Without Fee Priority
UnifiedEndpointsApi estimate_transaction_smart_fee GET /blockchain-data/{blockchain}/{network}/estimate-transaction-smart-fee Estimate Transaction Smart Fee
UnifiedEndpointsApi get_address_balance GET /blockchain-data/{blockchain}/{network}/addresses/{address}/balance Get Address Balance
UnifiedEndpointsApi get_block_details_by_block_hash GET /blockchain-data/{blockchain}/{network}/blocks/hash/{blockHash} Get Block Details By Block Hash
UnifiedEndpointsApi get_block_details_by_block_height GET /blockchain-data/{blockchain}/{network}/blocks/height/{height} Get Block Details By Block Height
UnifiedEndpointsApi get_fee_recommendations GET /blockchain-data/{blockchain}/{network}/mempool/fees Get Fee Recommendations
UnifiedEndpointsApi get_last_mined_block GET /blockchain-data/{blockchain}/{network}/blocks/last Get Last Mined Block
UnifiedEndpointsApi get_next_available_nonce GET /blockchain-data/{blockchain}/{network}/addresses/{address}/next-available-nonce Get Next Available Nonce
UnifiedEndpointsApi get_raw_transaction_data GET /blockchain-data/{blockchain}/{network}/transactions/{transactionId}/raw-data Get Raw Transaction Data
UnifiedEndpointsApi get_transaction_details_by_transaction_id GET /blockchain-data/{blockchain}/{network}/transactions/{transactionId} Get Transaction Details By Transaction ID
UnifiedEndpointsApi list_confirmed_tokens_transfers_by_address_and_time_range GET /blockchain-data/{blockchain}/{network}/addresses/{address}/tokens-transfers-by-time-range List Confirmed Tokens Transfers By Address And Time Range
UnifiedEndpointsApi list_confirmed_transactions_by_address GET /blockchain-data/{blockchain}/{network}/addresses/{address}/transactions List Confirmed Transactions By Address
UnifiedEndpointsApi list_confirmed_transactions_by_address_and_time_range GET /blockchain-data/{blockchain}/{network}/addresses/{address}/transactions-by-time-range List Confirmed Transactions By Address And Time Range
UnifiedEndpointsApi list_internal_transactions_by_address_and_time_range GET /blockchain-data/{blockchain}/{network}/addresses/{address}/internal-by-time-range List Internal Transactions By Address And Time Range
UnifiedEndpointsApi list_latest_mined_blocks GET /blockchain-data/{blockchain}/{network}/blocks/last/{count} List Latest Mined Blocks
UnifiedEndpointsApi list_transactions_by_block_hash GET /blockchain-data/{blockchain}/{network}/blocks/hash/{blockHash}/transactions List Transactions by Block Hash
UnifiedEndpointsApi list_transactions_by_block_height GET /blockchain-data/{blockchain}/{network}/blocks/height/{height}/transactions List Transactions by Block Height
UnifiedEndpointsApi list_unconfirmed_transactions_by_address GET /blockchain-data/{blockchain}/{network}/address-transactions-unconfirmed/{address} List Unconfirmed Transactions by Address
UnifiedEndpointsApi list_unspent_transaction_outputs_by_address GET /blockchain-data/{blockchain}/{network}/addresses/{address}/unspent-outputs List Unspent Transaction Outputs By Address
XRPRippleApi get_latest_mined_xrp__ripple_block GET /blockchain-data/xrp-specific/{network}/blocks/last Get Latest Mined XRP (Ripple) Block
XRPRippleApi get_xrp__ripple_address_details GET /blockchain-data/xrp-specific/{network}/addresses/{address} Get XRP (Ripple) Address Details
XRPRippleApi get_xrp__ripple_block_details_by_block_hash GET /blockchain-data/xrp-specific/{network}/blocks/hash/{blockHash} Get XRP (Ripple) Block Details By Block Hash
XRPRippleApi get_xrp__ripple_block_details_by_block_height GET /blockchain-data/xrp-specific/{network}/blocks/height/{blockHeight} Get XRP (Ripple) Block Details By Block Height
XRPRippleApi get_xrp__ripple_transaction_details_by_transaction_id GET /blockchain-data/xrp-specific/{network}/transactions/{transactionHash} Get XRP (Ripple) Transaction Details By Transaction ID
XRPRippleApi list_xrp__ripple_transactions_by_address GET /blockchain-data/xrp-specific/{network}/addresses/{address}/transactions List XRP (Ripple) Transactions by Address
XRPRippleApi list_xrp__ripple_transactions_by_address_and_time_range GET /blockchain-data/xrp-specific/{network}/addresses/{address}/transactions-by-time-range List XRP (Ripple) Transactions By Address And Time Range
XRPRippleApi list_xrp__ripple_transactions_by_block_hash GET /blockchain-data/xrp-specific/{network}/blocks/hash/{blockHash}/transactions List XRP (Ripple) Transactions By Block Hash
XRPRippleApi list_xrp__ripple_transactions_by_block_height GET /blockchain-data/xrp-specific/{network}/blocks/height/{blockHeight}/transactions List XRP (Ripple) Transactions By Block Height
ZilliqaApi get_latest_mined_zilliqa_block GET /blockchain-data/zilliqa-specific/{network}/blocks/last Get Latest Mined Zilliqa Block
ZilliqaApi get_zilliqa_address_details GET /blockchain-data/zilliqa-specific/{network}/addresses/{address} Get Zilliqa Address Details
ZilliqaApi get_zilliqa_block_details_by_block_hash GET /blockchain-data/zilliqa-specific/{network}/blocks/hash/{blockHash} Get Zilliqa Block Details By Block Hash
ZilliqaApi get_zilliqa_block_details_by_block_height GET /blockchain-data/zilliqa-specific/{network}/blocks/height/{blockHeight} Get Zilliqa Block Details By Block Height
ZilliqaApi get_zilliqa_transaction_details_by_transaction_id GET /blockchain-data/zilliqa-specific/{network}/transactions/{transactionHash} Get Zilliqa Transaction Details by Transaction ID
ZilliqaApi list_zilliqa_transactions_by_address GET /blockchain-data/zilliqa-specific/{network}/addresses/{address}/transactions List Zilliqa Transactions by Address
ZilliqaApi list_zilliqa_transactions_by_block_hash GET /blockchain-data/zilliqa-specific/{network}/blocks/hash/{blockHash}/transactions List Zilliqa Transactions By Block Hash
ZilliqaApi list_zilliqa_transactions_by_block_height GET /blockchain-data/zilliqa-specific/{network}/blocks/height/{blockHeight}/transactions List Zilliqa Transactions By Block Height
InternalApi get_internal_transaction_by_transaction_hash_and_operation_id GET /blockchain-data/{blockchain}/{network}/transactions/{transactionHash}/internal/{operationId} Get Internal Transaction by Transaction Hash and Operation Id
InternalApi list_internal_transaction_details_by_transaction_hash GET /blockchain-data/{blockchain}/{network}/transactions/{transactionHash}/internal List Internal Transaction Details by Transaction Hash
InternalApi list_internal_transactions_by_address GET /blockchain-data/{blockchain}/{network}/addresses/{address}/internal List Internal Transactions By Address

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author

developers@cryptoapis.io