CryptoAPIs\XRPRippleApi

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

Method	HTTP request	Description
getLatestMinedXRPRippleBlock()	GET /blockchain-data/xrp-specific/{network}/blocks/last	Get Latest Mined XRP (Ripple) Block
getXRPRippleAddressDetails()	GET /blockchain-data/xrp-specific/{network}/addresses/{address}	Get XRP (Ripple) Address Details
getXRPRippleBlockDetailsByBlockHash()	GET /blockchain-data/xrp-specific/{network}/blocks/hash/{blockHash}	Get XRP (Ripple) Block Details By Block Hash
getXRPRippleBlockDetailsByBlockHeight()	GET /blockchain-data/xrp-specific/{network}/blocks/height/{blockHeight}	Get XRP (Ripple) Block Details By Block Height
getXRPRippleTransactionDetailsByTransactionID()	GET /blockchain-data/xrp-specific/{network}/transactions/{transactionHash}	Get XRP (Ripple) Transaction Details By Transaction ID
listXRPRippleTransactionsByAddress()	GET /blockchain-data/xrp-specific/{network}/addresses/{address}/transactions	List XRP (Ripple) Transactions by Address
listXRPRippleTransactionsByAddressAndTimeRange()	GET /blockchain-data/xrp-specific/{network}/addresses/{address}/transactions-by-time-range	List XRP (Ripple) Transactions By Address And Time Range
listXRPRippleTransactionsByBlockHash()	GET /blockchain-data/xrp-specific/{network}/blocks/hash/{blockHash}/transactions	List XRP (Ripple) Transactions By Block Hash
listXRPRippleTransactionsByBlockHeight()	GET /blockchain-data/xrp-specific/{network}/blocks/height/{blockHeight}/transactions	List XRP (Ripple) Transactions By Block Height

`getLatestMinedXRPRippleBlock()`

getLatestMinedXRPRippleBlock($network, $context): \CryptoAPIs\Model\GetLatestMinedXRPRippleBlockR

Get Latest Mined XRP (Ripple) Block

Through this endpoint customers can fetch the last mined XRP block in the blockchain, along with its details. These could include the hash of the specific, the previous and the next block, its transactions count, its height, etc. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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.
$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->getLatestMinedXRPRippleBlock($network, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->getLatestMinedXRPRippleBlock: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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]

Return type

\CryptoAPIs\Model\GetLatestMinedXRPRippleBlockR

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]

`getXRPRippleAddressDetails()`

getXRPRippleAddressDetails($network, $address, $context): \CryptoAPIs\Model\GetXRPRippleAddressDetailsR

Get XRP (Ripple) Address Details

Through this endpoint the customer can receive basic information about a given XRP address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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\",  are test networks.
$address = rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z; // string | Represents the public address, which is a compressed and shortened form of a public key.
$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->getXRPRippleAddressDetails($network, $address, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->getXRPRippleAddressDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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", are test networks.
address	string	Represents the public address, which is a compressed and shortened form of a public key.
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\GetXRPRippleAddressDetailsR

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]

`getXRPRippleBlockDetailsByBlockHash()`

getXRPRippleBlockDetailsByBlockHash($network, $block_hash, $context): \CryptoAPIs\Model\GetXRPRippleBlockDetailsByBlockHashR

Get XRP (Ripple) Block Details By Block Hash

Through this endpoint customers can obtain basic information about a given XRP block (a block on the XRP blockchain), specifically by using the hash parameter. These block details could include the hash of the specific, the previous and the next block, the number of included transactions, etc. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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.
$block_hash = 1ab0614d2a438da8b23086cbceef7d443edbd295d9c7619fc8a19c7618bc22c9; // string | Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
$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->getXRPRippleBlockDetailsByBlockHash($network, $block_hash, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->getXRPRippleBlockDetailsByBlockHash: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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.
block_hash	string	Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
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\GetXRPRippleBlockDetailsByBlockHashR

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]

`getXRPRippleBlockDetailsByBlockHeight()`

getXRPRippleBlockDetailsByBlockHeight($network, $block_height, $context): \CryptoAPIs\Model\GetXRPRippleBlockDetailsByBlockHeightR

Get XRP (Ripple) Block Details By Block Height

Through this endpoint customers can obtain basic information about a given XRP block (a block on the XRP blockchain), specifically by using the height parameter. These block details could include the hash of the specific, the previous and the next block, its transactions count, etc. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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\",  are test networks.
$block_height = 15886156; // string | Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".
$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->getXRPRippleBlockDetailsByBlockHeight($network, $block_height, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->getXRPRippleBlockDetailsByBlockHeight: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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", are test networks.
block_height	string	Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the "Genesis block".
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\GetXRPRippleBlockDetailsByBlockHeightR

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]

`getXRPRippleTransactionDetailsByTransactionID()`

getXRPRippleTransactionDetailsByTransactionID($network, $transaction_hash, $context): \CryptoAPIs\Model\GetXRPRippleTransactionDetailsByTransactionIDR

Get XRP (Ripple) Transaction Details By Transaction ID

Through this endpoint customers can obtain details about a XRP transaction by the transaction's unique identifier. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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_hash = 36a1737481edec87bacc3101dfb752ae2c76f9171e7edebe587e330c1ea77c8d; // string | Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.
$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->getXRPRippleTransactionDetailsByTransactionID($network, $transaction_hash, $context);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->getXRPRippleTransactionDetailsByTransactionID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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_hash	string	Represents the same as `transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.
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\GetXRPRippleTransactionDetailsByTransactionIDR

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]

`listXRPRippleTransactionsByAddress()`

listXRPRippleTransactionsByAddress($network, $address, $context, $limit, $offset, $transaction_type): \CryptoAPIs\Model\ListXRPRippleTransactionsByAddressR

List XRP (Ripple) Transactions by Address

This endpoint will list XRP transactions by a attribute address. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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.
$address = rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z; // string | Represents the public address, which is a compressed and shortened form of a public key.
$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.
$transaction_type = payment; // string

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

Parameters

Name	Type	Description	Notes
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.
address	string	Represents the public address, which is a compressed and shortened form of a public key.
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]
transaction_type	string		[optional]

Return type

\CryptoAPIs\Model\ListXRPRippleTransactionsByAddressR

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]

`listXRPRippleTransactionsByAddressAndTimeRange()`

listXRPRippleTransactionsByAddressAndTimeRange($network, $address, $from_timestamp, $to_timestamp, $context, $limit, $offset, $transaction_type): \CryptoAPIs\Model\ListXRPRippleTransactionsByAddressAndTimeRangeR

List XRP (Ripple) Transactions By Address And Time Range

Тhis endpoint lists XRP transactions by the attribute address and the query parameters fromTimestamp and toTimestamp which gives customers the opportunity to filter the results by a specified time period.

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\XRPRippleApi(
    // 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
);
$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.
$address = rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z; // string | Represents the public address, which is a compressed and shortened form of a public key.
$from_timestamp = 1616347862; // int | Defines the specific time/date from which the results will start being listed.
$to_timestamp = 1616347870; // int | Defines the specific time/date to which the results will be listed.
$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.
$transaction_type = payment; // string | Defines the transaction type.

try {
    $result = $apiInstance->listXRPRippleTransactionsByAddressAndTimeRange($network, $address, $from_timestamp, $to_timestamp, $context, $limit, $offset, $transaction_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->listXRPRippleTransactionsByAddressAndTimeRange: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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.
address	string	Represents the public address, which is a compressed and shortened form of a public key.
from_timestamp	int	Defines the specific time/date from which the results will start being listed.
to_timestamp	int	Defines the specific time/date to which the results will be listed.
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]
transaction_type	string	Defines the transaction type.	[optional]

Return type

\CryptoAPIs\Model\ListXRPRippleTransactionsByAddressAndTimeRangeR

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]

`listXRPRippleTransactionsByBlockHash()`

listXRPRippleTransactionsByBlockHash($network, $block_hash, $context, $limit, $offset): \CryptoAPIs\Model\ListXRPRippleTransactionsByBlockHashR

List XRP (Ripple) Transactions By Block Hash

This endpoint will list transactions by an attribute blockHash. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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.
$block_hash = 14754656235f865a74eba27791fd41a47bdfe07fe811ff6d78f53db32e129e39; // string | Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
$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->listXRPRippleTransactionsByBlockHash($network, $block_hash, $context, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->listXRPRippleTransactionsByBlockHash: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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.
block_hash	string	Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
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\ListXRPRippleTransactionsByBlockHashR

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]

`listXRPRippleTransactionsByBlockHeight()`

listXRPRippleTransactionsByBlockHeight($network, $block_height, $context, $limit, $offset): \CryptoAPIs\Model\ListXRPRippleTransactionsByBlockHeightR

List XRP (Ripple) Transactions By Block Height

This endpoint will list transactions by an attribute blockHeight. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc. Since XRP is a different blockchain than Bitcoin and Ethereum, it isn't unified.

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\XRPRippleApi(
    // 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
);
$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.
$block_height = 15971358; // int
$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->listXRPRippleTransactionsByBlockHeight($network, $block_height, $context, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XRPRippleApi->listXRPRippleTransactionsByBlockHeight: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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.
block_height	int
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\ListXRPRippleTransactionsByBlockHeightR

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

XRPRippleApi.md

Latest commit

History

XRPRippleApi.md

File metadata and controls

CryptoAPIs\XRPRippleApi

getLatestMinedXRPRippleBlock()

Example

Parameters

Return type

Authorization

HTTP request headers

getXRPRippleAddressDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

getXRPRippleBlockDetailsByBlockHash()

Example

Parameters

Return type

Authorization

HTTP request headers

getXRPRippleBlockDetailsByBlockHeight()

Example

Parameters

Return type

Authorization

HTTP request headers

getXRPRippleTransactionDetailsByTransactionID()

Example

Parameters

Return type

Authorization

HTTP request headers

listXRPRippleTransactionsByAddress()

Example

Parameters

Return type

Authorization

HTTP request headers

listXRPRippleTransactionsByAddressAndTimeRange()

Example

Parameters

Return type

Authorization

HTTP request headers

listXRPRippleTransactionsByBlockHash()

Example

Parameters

Return type

Authorization

HTTP request headers

listXRPRippleTransactionsByBlockHeight()

Example

Parameters

Return type

Authorization

HTTP request headers

`getLatestMinedXRPRippleBlock()`

`getXRPRippleAddressDetails()`

`getXRPRippleBlockDetailsByBlockHash()`

`getXRPRippleBlockDetailsByBlockHeight()`

`getXRPRippleTransactionDetailsByTransactionID()`

`listXRPRippleTransactionsByAddress()`

`listXRPRippleTransactionsByAddressAndTimeRange()`

`listXRPRippleTransactionsByBlockHash()`

`listXRPRippleTransactionsByBlockHeight()`