crypto_apis

CryptoApis - the Ruby gem for the CryptoAPIs

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

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 1.5.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://cryptoapis.io

Installation

gem install crypto_apis

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'crypto_apis'

# Setup authorization
CryptoApis.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = CryptoApis::AssetsApi.new
asset_id = '5b1ea92e584bf50020130612' # String | Defines the unique ID of the specific asset.
opts = {
  context: 'yourExampleString' # String | 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.
}

begin
  #Get Asset Details By Asset ID
  result = api_instance.get_asset_details_by_asset_id(asset_id, opts)
  p result
rescue CryptoApis::ApiError => e
  puts "Exception when calling AssetsApi->get_asset_details_by_asset_id: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
CryptoApis::AssetsApi get_asset_details_by_asset_id GET /market-data/assets/assetId/assetId Get Asset Details By Asset ID
CryptoApis::AssetsApi get_asset_details_by_asset_symbol GET /market-data/assets/assetSymbol Get Asset Details By Asset Symbol
CryptoApis::AssetsApi list_assets_details GET /market-data/assets/details List Assets Details
CryptoApis::AutomaticCoinsForwardingApi create_automatic_coins_forwarding POST /blockchain-automations/blockchain/network/coins-forwarding/automations Create Automatic Coins Forwarding
CryptoApis::AutomaticCoinsForwardingApi delete_automatic_coins_forwarding DELETE /blockchain-automations/blockchain/network/coins-forwarding/automations/referenceId Delete Automatic Coins Forwarding
CryptoApis::AutomaticCoinsForwardingApi list_coins_forwarding_automations GET /blockchain-automations/blockchain/network/coins-forwarding/automations List Coins Forwarding Automations
CryptoApis::AutomaticTokensForwardingApi add_tokens_to_existing_from_address POST /blockchain-automations/blockchain/network/tokens-forwarding/automations/add-token Add Tokens To Existing fromAddress
CryptoApis::AutomaticTokensForwardingApi create_automatic_tokens_forwarding POST /blockchain-automations/blockchain/network/tokens-forwarding/automations Create Automatic Tokens Forwarding
CryptoApis::AutomaticTokensForwardingApi delete_automatic_tokens_forwarding DELETE /blockchain-automations/blockchain/network/tokens-forwarding/automations/referenceId Delete Automatic Tokens Forwarding
CryptoApis::AutomaticTokensForwardingApi get_fee_address_details GET /blockchain-automations/blockchain/network/tokens-forwarding/fee-addresses Get Fee Address Details
CryptoApis::AutomaticTokensForwardingApi list_tokens_forwarding_automations GET /blockchain-automations/blockchain/network/tokens-forwarding/automations List Tokens Forwarding Automations
CryptoApis::CallbackDataApi get_address_details_from_callback GET /blockchain-events/blockchain/network/addresses/address Get Address Details From Callback
CryptoApis::CallbackDataApi get_block_details_by_block_hash_from_callback GET /blockcain-events/blockchain/network/blocks/hash/blockHash Get Block Details By Block Hash From Callback
CryptoApis::CallbackDataApi get_block_details_by_block_height_from_callback GET /blockcain-events/blockchain/network/blocks/height/blockHeight Get Block Details By Block Height From Callback
CryptoApis::CallbackDataApi get_transaction_details_by_transaction_id_from_callback GET /blockchain-events/blockchain/network/transactions/transactionId Get Transaction Details By Transaction ID From Callback
CryptoApis::CreateSubscriptionsForApi mined_transaction POST /blockchain-events/blockchain/network/subscriptions/transaction-mined Mined transaction
CryptoApis::CreateSubscriptionsForApi new_block POST /blockchain-events/blockchain/network/subscriptions/block-mined New Block
CryptoApis::CreateSubscriptionsForApi new_confirmed_coins_transactions POST /blockchain-events/blockchain/network/subscriptions/address-coins-transactions-confirmed New confirmed coins transactions
CryptoApis::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
CryptoApis::CreateSubscriptionsForApi new_confirmed_internal_transactions POST /blockchain-events/blockchain/network/subscriptions/address-internal-transactions-confirmed New confirmed internal transactions
CryptoApis::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
CryptoApis::CreateSubscriptionsForApi new_confirmed_tokens_transactions POST /blockchain-events/blockchain/network/subscriptions/address-tokens-transactions-confirmed New confirmed tokens transactions
CryptoApis::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
CryptoApis::CreateSubscriptionsForApi new_unconfirmed_coins_transactions POST /blockchain-events/blockchain/network/subscriptions/address-coins-transactions-unconfirmed New unconfirmed coins transactions
CryptoApis::CreateSubscriptionsForApi new_unconfirmed_tokens_transactions POST /blockchain-events/blockchain/network/subscriptions/address-tokens-transactions-unconfirmed New unconfirmed tokens transactions
CryptoApis::ExchangeRatesApi get_exchange_rate_by_asset_symbols GET /market-data/exchange-rates/by-symbols/fromAssetSymbol/toAssetSymbol Get Exchange Rate By Asset Symbols
CryptoApis::ExchangeRatesApi get_exchange_rate_by_assets_ids GET /market-data/exchange-rates/by-asset-ids/fromAssetId/toAssetId Get Exchange Rate By Assets IDs
CryptoApis::FeaturesApi broadcast_locally_signed_transaction POST /blockchain-tools/blockchain/network/transactions/broadcast Broadcast Locally Signed Transaction
CryptoApis::FeaturesApi decode_raw_transaction_hex POST /blockchain-tools/blockchain/network/decode-raw-transaction Decode Raw Transaction Hex
CryptoApis::FeaturesApi decode_x_address GET /blockchain-tools/blockchain/network/decode-x-address/xAddress Decode X-Address
CryptoApis::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
CryptoApis::FeaturesApi encode_x_address GET /blockchain-tools/blockchain/network/encode-x-address/classicAddress/addressTag Encode X-Address
CryptoApis::FeaturesApi estimate_gas_limit POST /blockchain-tools/blockchain/network/gas-limit Estimate Gas Limit
CryptoApis::FeaturesApi estimate_token_gas_limit POST /blockchain-tools/blockchain/network/gas-limit/contract Estimate Token Gas Limit
CryptoApis::FeaturesApi get_eip_1559_fee_recommendations GET /blockchain-tools/blockchain/network/fees/eip1559 Get EIP 1559 Fee Recommendations
CryptoApis::FeaturesApi validate_address POST /blockchain-tools/blockchain/network/addresses/validate Validate Address
CryptoApis::GeneratingApi generate_deposit_address POST /wallet-as-a-service/wallets/walletId/blockchain/network/addresses Generate Deposit Address
CryptoApis::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
CryptoApis::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
CryptoApis::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
CryptoApis::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
CryptoApis::HDWalletsApi sync_hd_wallet__x_pub_y_pub_z_pub POST /blockchain-data/blockchain/network/hd/sync Sync HD Wallet (xPub, yPub, zPub)
CryptoApis::InformativeApi get_transaction_request_details GET /wallet-as-a-service/transactionRequests/transactionRequestId Get Transaction Request Details
CryptoApis::InformativeApi get_wallet_asset_details GET /wallet-as-a-service/wallets/walletId/blockchain/network Get Wallet Asset Details
CryptoApis::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
CryptoApis::InformativeApi list_all_assets_by_wallet_id GET /wallet-as-a-service/wallets/walletId/assets List All Assets By Wallet ID
CryptoApis::InformativeApi list_all_assets_from_all_wallets GET /wallet-as-a-service/wallets/all-assets List All Assets From All Wallets
CryptoApis::InformativeApi list_deposit_addresses GET /wallet-as-a-service/wallets/walletId/blockchain/network/addresses List Deposit Addresses
CryptoApis::InformativeApi list_supported_tokens GET /wallet-as-a-service/info/blockchain/network/supported-tokens List Supported Tokens
CryptoApis::InformativeApi list_wallet_transactions GET /wallet-as-a-service/wallets/walletId/blockchain/network/transactions List Wallet Transactions
CryptoApis::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
CryptoApis::InternalApi list_internal_transaction_details_by_transaction_hash GET /blockchain-data/blockchain/network/transactions/transactionHash/internal List Internal Transaction Details by Transaction Hash
CryptoApis::InternalApi list_internal_transactions_by_address GET /blockchain-data/blockchain/network/addresses/address/internal List Internal Transactions By Address
CryptoApis::ManageSubscriptionsApi activate_blockchain_event_subscription POST /blockchain-events/subscriptions/referenceId/activate Activate Blockchain Event Subscription
CryptoApis::ManageSubscriptionsApi delete_blockchain_event_subscription DELETE /blockchain-events/blockchain/network/subscriptions/referenceId Delete Blockchain Event Subscription
CryptoApis::ManageSubscriptionsApi get_blockchain_event_subscription_details_by_reference_id GET /blockchain-events/subscriptions/referenceId Get Blockchain Event Subscription Details By Reference ID
CryptoApis::ManageSubscriptionsApi list_blockchain_events_subscriptions GET /blockchain-events/blockchain/network/subscriptions List Blockchain Events Subscriptions
CryptoApis::MetadataApi list_supported_assets GET /market-data/assets/supported List Supported Assets
CryptoApis::OmniLayerApi get_omni_transaction_details_by_transaction_id__txid GET /blockchain-data/blockchain/network/omni/transactions/transactionId Get Omni Transaction Details By Transaction ID (Txid)
CryptoApis::OmniLayerApi get_unconfirmed_omni_transaction_by_transaction_id__txid GET /blockchain-data/blockchain/network/omni/transactions-unconfirmed/transactionId Get Unconfirmed Omni Transaction By Transaction ID (Txid)
CryptoApis::OmniLayerApi list_omni_tokens_by_address GET /blockchain-data/blockchain/network/omni/addresses/address List Omni Tokens By Address
CryptoApis::OmniLayerApi list_omni_transactions_by_address GET /blockchain-data/blockchain/network/omni/addresses/address/transactions List Omni Transactions By Address
CryptoApis::OmniLayerApi list_omni_transactions_by_block_hash GET /blockchain-data/blockchain/network/omni/blocks/hash/blockHash/transactions List Omni Transactions By Block Hash
CryptoApis::OmniLayerApi list_omni_transactions_by_block_height GET /blockchain-data/blockchain/network/omni/blocks/height/blockHeight/transactions List Omni Transactions By Block Height
CryptoApis::OmniLayerApi list_unconfirmed_omni_transactions_by_address GET /blockchain-data/blockchain/network/omni/address-transactions-unconfirmed/address List Unconfirmed Omni Transactions By Address
CryptoApis::OmniLayerApi list_unconfirmed_omni_transactions_by_property_id GET /blockchain-data/blockchain/network/omni/properties/propertyId/transactions List Unconfirmed Omni Transactions By Property ID
CryptoApis::TokensApi get_token_details_by_contract_address GET /blockchain-data/blockchain/network/addresses/contractAddress/contract Get Token Details by Contract Address
CryptoApis::TokensApi list_confirmed_tokens_transfers_by_address GET /blockchain-data/blockchain/network/addresses/address/tokens-transfers List Confirmed Tokens Transfers By Address
CryptoApis::TokensApi list_tokens_by_address GET /blockchain-data/blockchain/network/addresses/address/tokens List Tokens By Address
CryptoApis::TokensApi list_tokens_transfers_by_transaction_hash GET /blockchain-data/blockchain/network/transactions/transactionHash/tokens-transfers List Tokens Transfers By Transaction Hash
CryptoApis::TokensApi list_unconfirmed_tokens_transfers_by_address GET /blockchain-data/blockchain/network/addresses/address/tokens-transfers-unconfirmed List Unconfirmed Tokens Transfers By Address
CryptoApis::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
CryptoApis::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
CryptoApis::TransactionsApi create_coins_transaction_request_from_wallet POST /wallet-as-a-service/wallets/walletId/blockchain/network/transaction-requests Create Coins Transaction Request from Wallet
CryptoApis::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
CryptoApis::UnifiedEndpointsApi estimate_transaction_smart_fee GET /blockchain-data/blockchain/network/estimate-transaction-smart-fee Estimate Transaction Smart Fee
CryptoApis::UnifiedEndpointsApi get_address_details GET /blockchain-data/blockchain/network/addresses/address Get Address Details
CryptoApis::UnifiedEndpointsApi get_block_details_by_block_hash GET /blockchain-data/blockchain/network/blocks/hash/blockHash Get Block Details By Block Hash
CryptoApis::UnifiedEndpointsApi get_block_details_by_block_height GET /blockchain-data/blockchain/network/blocks/height/height Get Block Details By Block Height
CryptoApis::UnifiedEndpointsApi get_fee_recommendations GET /blockchain-data/blockchain/network/mempool/fees Get Fee Recommendations
CryptoApis::UnifiedEndpointsApi get_last_mined_block GET /blockchain-data/blockchain/network/blocks/last Get Last Mined Block
CryptoApis::UnifiedEndpointsApi get_next_available_nonce GET /blockchain-data/blockchain/network/addresses/address/next-available-nonce Get Next Available Nonce
CryptoApis::UnifiedEndpointsApi get_raw_transaction_data GET /blockchain-data/blockchain/network/transactions/transactionId/raw-data Get Raw Transaction Data
CryptoApis::UnifiedEndpointsApi get_transaction_details_by_transaction_id GET /blockchain-data/blockchain/network/transactions/transactionId Get Transaction Details By Transaction ID
CryptoApis::UnifiedEndpointsApi list_all_unconfirmed_transactions GET /blockchain-data/blockchain/network/address-transactions-unconfirmed List All Unconfirmed Transactions
CryptoApis::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
CryptoApis::UnifiedEndpointsApi list_confirmed_transactions_by_address GET /blockchain-data/blockchain/network/addresses/address/transactions List Confirmed Transactions By Address
CryptoApis::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
CryptoApis::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
CryptoApis::UnifiedEndpointsApi list_latest_mined_blocks GET /blockchain-data/blockchain/network/blocks/last/count List Latest Mined Blocks
CryptoApis::UnifiedEndpointsApi list_transactions_by_block_hash GET /blockchain-data/blockchain/network/blocks/hash/blockHash/transactions List Transactions by Block Hash
CryptoApis::UnifiedEndpointsApi list_transactions_by_block_height GET /blockchain-data/blockchain/network/blocks/height/height/transactions List Transactions by Block Height
CryptoApis::UnifiedEndpointsApi list_unconfirmed_transactions_by_address GET /blockchain-data/blockchain/network/address-transactions-unconfirmed/address List Unconfirmed Transactions by Address
CryptoApis::UnifiedEndpointsApi list_unspent_transaction_outputs_by_address GET /blockchain-data/blockchain/network/addresses/address/unspent-outputs List Unspent Transaction Outputs By Address
CryptoApis::XRPRippleApi get_latest_mined_xrp__ripple_block GET /blockchain-data/xrp-specific/network/blocks/last Get Latest Mined XRP (Ripple) Block
CryptoApis::XRPRippleApi get_xrp__ripple_address_details GET /blockchain-data/xrp-specific/network/addresses/address Get XRP (Ripple) Address Details
CryptoApis::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
CryptoApis::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
CryptoApis::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
CryptoApis::XRPRippleApi list_xrp__ripple_transactions_by_address GET /blockchain-data/xrp-specific/network/addresses/address/transactions List XRP (Ripple) Transactions by Address
CryptoApis::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
CryptoApis::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
CryptoApis::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
CryptoApis::ZilliqaApi get_latest_mined_zilliqa_block GET /blockchain-data/zilliqa-specific/network/blocks/last Get Latest Mined Zilliqa Block
CryptoApis::ZilliqaApi get_zilliqa_address_details GET /blockchain-data/zilliqa-specific/network/addresses/address Get Zilliqa Address Details
CryptoApis::ZilliqaApi get_zilliqa_block_details_by_block_hash GET /blockchain-data/zilliqa-specific/network/blocks/hash/blockHash Get Zilliqa Block Details By Block Hash
CryptoApis::ZilliqaApi get_zilliqa_block_details_by_block_height GET /blockchain-data/zilliqa-specific/network/blocks/height/blockHeight Get Zilliqa Block Details By Block Height
CryptoApis::ZilliqaApi get_zilliqa_transaction_details_by_transaction_id GET /blockchain-data/zilliqa-specific/network/transactions/transactionHash Get Zilliqa Transaction Details by Transaction ID
CryptoApis::ZilliqaApi list_zilliqa_transactions_by_address GET /blockchain-data/zilliqa-specific/network/addresses/address/transactions List Zilliqa Transactions by Address
CryptoApis::ZilliqaApi list_zilliqa_transactions_by_block_hash GET /blockchain-data/zilliqa-specific/network/blocks/hash/blockHash/transactions List Zilliqa Transactions By Block Hash
CryptoApis::ZilliqaApi list_zilliqa_transactions_by_block_height GET /blockchain-data/zilliqa-specific/network/blocks/height/blockHeight/transactions List Zilliqa Transactions By Block Height

Documentation for Models

Documentation for Authorization

ApiKey

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