CryptoAPIs\InformativeApi

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

Method	HTTP request	Description
getTransactionRequestDetails()	GET /wallet-as-a-service/transactionRequests/{transactionRequestId}	Get Transaction Request Details
getWalletAssetDetails()	GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}	Get Wallet Asset Details
getWalletTransactionDetailsByTransactionID()	GET /wallet-as-a-service/wallets/{blockchain}/{network}/transactions/{transactionId}	Get Wallet Transaction Details By Transaction ID
listAllAssetsByWalletID()	GET /wallet-as-a-service/wallets/{walletId}/assets	List All Assets By Wallet ID
listAllAssetsFromAllWallets()	GET /wallet-as-a-service/wallets/all-assets	List All Assets From All Wallets
listDepositAddresses()	GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses	List Deposit Addresses
listSupportedTokens()	GET /wallet-as-a-service/info/{blockchain}/{network}/supported-tokens	List Supported Tokens
listWalletTransactions()	GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transactions	List Wallet Transactions

`getTransactionRequestDetails()`

getTransactionRequestDetails($transaction_request_id, $context): \CryptoAPIs\Model\GetTransactionRequestDetailsR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$transaction_request_id = 6115126693397c0006f78eb4; // string | Represents the unique ID of the transaction request.
$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.

try {
    $result = $apiInstance->getTransactionRequestDetails($transaction_request_id, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->getTransactionRequestDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\CryptoAPIs\Model\GetTransactionRequestDetailsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getWalletAssetDetails()`

getWalletAssetDetails($blockchain, $network, $wallet_id, $context): \CryptoAPIs\Model\GetWalletAssetDetailsR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$blockchain = bitcoin; // string | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
$network = testnet; // string | 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; // string | Defines the unique ID of the Wallet.
$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.

try {
    $result = $apiInstance->getWalletAssetDetails($blockchain, $network, $wallet_id, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->getWalletAssetDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
blockchain	string	Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network	string	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	string	Defines the unique ID of the Wallet.
context	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.	[optional]

Return type

\CryptoAPIs\Model\GetWalletAssetDetailsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getWalletTransactionDetailsByTransactionID()`

getWalletTransactionDetailsByTransactionID($blockchain, $network, $transaction_id, $context): \CryptoAPIs\Model\GetWalletTransactionDetailsByTransactionIDR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$blockchain = bitcoin; // string | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
$network = testnet; // string | 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.
$transaction_id = 3e081861494aed897e589cdeab5d9e628d985e571ed1c19896d1aa698cce9d80; // string | 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; // 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.

try {
    $result = $apiInstance->getWalletTransactionDetailsByTransactionID($blockchain, $network, $transaction_id, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->getWalletTransactionDetailsByTransactionID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
blockchain	string	Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network	string	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.
transaction_id	string	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	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.	[optional]

Return type

\CryptoAPIs\Model\GetWalletTransactionDetailsByTransactionIDR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listAllAssetsByWalletID()`

listAllAssetsByWalletID($wallet_id, $context): \CryptoAPIs\Model\ListAllAssetsByWalletIDR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wallet_id = 60c9d9921c38030006675ff6; // string | Defines the unique ID of the Wallet.
$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.

try {
    $result = $apiInstance->listAllAssetsByWalletID($wallet_id, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->listAllAssetsByWalletID: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\CryptoAPIs\Model\ListAllAssetsByWalletIDR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listAllAssetsFromAllWallets()`

listAllAssetsFromAllWallets($context, $limit, $offset): \CryptoAPIs\Model\ListAllAssetsFromAllWalletsR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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.
$limit = 50; // int | Defines how many items should be returned in the response per page basis.
$offset = 0; // int | The starting index of the response items, i.e. where the response should start listing the returned items.

try {
    $result = $apiInstance->listAllAssetsFromAllWallets($context, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->listAllAssetsFromAllWallets: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
context	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.	[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

\CryptoAPIs\Model\ListAllAssetsFromAllWalletsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listDepositAddresses()`

listDepositAddresses($blockchain, $network, $wallet_id, $context): \CryptoAPIs\Model\ListDepositAddressesR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$blockchain = bitcoin; // string | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
$network = testnet; // string | 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; // string | Represents the unique ID of the specific Wallet.
$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.

try {
    $result = $apiInstance->listDepositAddresses($blockchain, $network, $wallet_id, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->listDepositAddresses: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
blockchain	string	Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network	string	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	string	Represents the unique ID of the specific Wallet.
context	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.	[optional]

Return type

\CryptoAPIs\Model\ListDepositAddressesR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listSupportedTokens()`

listSupportedTokens($blockchain, $network, $context, $limit, $offset): \CryptoAPIs\Model\ListSupportedTokensR

List Supported Tokens

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$blockchain = ethereum; // string | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
$network = ropsten; // string | 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; // 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.
$limit = 50; // int | Defines how many items should be returned in the response per page basis.
$offset = 0; // int | The starting index of the response items, i.e. where the response should start listing the returned items.

try {
    $result = $apiInstance->listSupportedTokens($blockchain, $network, $context, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->listSupportedTokens: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
blockchain	string	Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network	string	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	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.	[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

\CryptoAPIs\Model\ListSupportedTokensR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listWalletTransactions()`

listWalletTransactions($blockchain, $network, $wallet_id, $context, $limit, $offset): \CryptoAPIs\Model\ListWalletTransactionsR

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CryptoAPIs\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new CryptoAPIs\Api\InformativeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$blockchain = ethereum; // string | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
$network = ropsten; // string | 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; // string | Represents the unique ID of the specific Wallet.
$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.
$limit = 50; // int | Defines how many items should be returned in the response per page basis.
$offset = 0; // int | The starting index of the response items, i.e. where the response should start listing the returned items.

try {
    $result = $apiInstance->listWalletTransactions($blockchain, $network, $wallet_id, $context, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformativeApi->listWalletTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
blockchain	string	Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
network	string	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	string	Represents the unique ID of the specific Wallet.
context	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.	[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

\CryptoAPIs\Model\ListWalletTransactionsR

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

InformativeApi.md

Latest commit

History

InformativeApi.md

File metadata and controls

CryptoAPIs\InformativeApi

getTransactionRequestDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

getWalletAssetDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

getWalletTransactionDetailsByTransactionID()

Example

Parameters

Return type

Authorization

HTTP request headers

listAllAssetsByWalletID()

Example

Parameters

Return type

Authorization

HTTP request headers

listAllAssetsFromAllWallets()

Example

Parameters

Return type

Authorization

HTTP request headers

listDepositAddresses()

Example

Parameters

Return type

Authorization

HTTP request headers

listSupportedTokens()

Example

Parameters

Return type

Authorization

HTTP request headers

listWalletTransactions()

Example

Parameters

Return type

Authorization

HTTP request headers

`getTransactionRequestDetails()`

`getWalletAssetDetails()`

`getWalletTransactionDetailsByTransactionID()`

`listAllAssetsByWalletID()`

`listAllAssetsFromAllWallets()`

`listDepositAddresses()`

`listSupportedTokens()`

`listWalletTransactions()`