v1 .2023-04-25

Jump to

Ctrl

General Information

REST APIs

Wallet as a Service

Generating

Transactions

Informative

Blockchain Data

Unified Endpoints

Tokens

Internal

HD Wallets

Solana

XRP (Ripple)

Blockchain Events

Create Subscriptions for

Manage Subscriptions

Blockchain Automations

Automatic Coins Forwarding

Delete Automatic Coins Forwarding

DELETE

Automatic Tokens Forwarding

Blockchain Tools

Features

Market Data

Metadata

List Supported Assets

GET

Exchange Rates

Assets

List XRP (Ripple) Transactions By Block Hash

GET

/blockchain-data/xrp-specific/{network}/blocks/hash/{blockHash}/transactions

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.

Path Parameters

network string Required

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 network like "testnet" is a test network.

blockHash string Required

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.

Query Parameters

context string Optional

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 integer Optional

Defines how many items should be returned in the response per page basis.

Default : 50

offset integer Optional

The starting index of the response items, i.e. where the response should start listing the returned items.

Default : 0

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30

context string Optional

yourExampleString

data object Required

limit integer Required

Defines how many items should be returned in the response per page basis.

offset integer Required

The starting index of the response items, i.e. where the response should start listing the returned items.

total integer Required

Defines the total number of items returned in the response.

100

items array Items (object) Required

additionalData string Optional

Represents any additional data that may be needed.

r4CmvbkDWGt9AZmkfuubmiSdsxGZFxAKBY

destinationTag integer Optional

3999472835

index integer Required

Represents the index position of the transaction in the specific block.

minedInBlockHeight integer Required

Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.

15971358

offer object Required

amount string Required

Defines the amount of the offer.

8.2365

unit string Required

Defines the unit of the offer.

XRP

recipients array Items (object) Required

Represents an object of addresses that receive the transactions.

address string Required

Represents the hash of the address that receives the funds.

rNUY3X3HovAXuTesTbMh8PAX6CM5V2RzMY

amount string Required

Defines the amount of the received funds as a string.

0.0001

senders array Items (object) Required

Represents an object of addresses that provide the funds.

address string Required

Represents the hash of the address that provides the funds.

rPmPErQe4g9725pcNxJpuvKkdqTESTQ6Tu

amount string Required

Represents the total amount sent by this address including the fee.

0.0001

sequence integer Required

Defines the transaction input's sequence as an integer, which is is used when transactions are replaced with newer versions before LockTime.

32568

status string Required

Defines the status of the transaction.

tesSUCCESS

timestamp integer Required

Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.

236589

transactionHash string Required

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.

ba3bc1337071c8e73b441fe12a1911f4365d7ea82cace7c8ecba3ee9f364978b

type string Required

Defines the type of the transaction.

Payment

fee object Required

amount string Required

Defines the amount of the fee.

2.0325

unit string Required

Defines the unit of the fee.

XRP

receive object Required

amount string Required

Defines the received amount.

6.2354

unit string Required

Defines the unit of the received amount.

XRP

value object Required

amount string Required

Defines the amount of the value.

22.023

unit string Required

Defines the unit of the value.

XRP

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

uri_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified URI has not been found. Check the URI and try again.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2023-04-25

requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

banned_ip_address

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This IP address has been banned. To check the reason for that, please contact our team via email.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

Credits Cost : 100 Credits for 1 Results

Was this page helpful?

Yes

Language

URL

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "additionalData": "r4CmvbkDWGt9AZmkfuubmiSdsxGZFxAKBY",
                "destinationTag": 3999472835,
                "index": 3,
                "minedInBlockHeight": 15971358,
                "offer": {
                    "amount": "8.2365",
                    "unit": "XRP"
                },
                "recipients": [
                    {
                        "address": "rNUY3X3HovAXuTesTbMh8PAX6CM5V2RzMY",
                        "amount": "0.0001"
                    }
                ],
                "senders": [
                    {
                        "address": "rPmPErQe4g9725pcNxJpuvKkdqTESTQ6Tu",
                        "amount": "0.0001"
                    }
                ],
                "sequence": 32568,
                "status": "tesSUCCESS",
                "timestamp": 236589,
                "transactionHash": "ba3bc1337071c8e73b441fe12a1911f4365d7ea82cace7c8ecba3ee9f364978b",
                "type": "Payment",
                "fee": {
                    "amount": "2.0325",
                    "unit": "XRP"
                },
                "receive": {
                    "amount": "6.2354",
                    "unit": "XRP"
                },
                "value": {
                    "amount": "22.023",
                    "unit": "XRP"
                }
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

List XRP (Ripple) Transactions By Block Hash

Path Parameters

Query Parameters

Response Schema

Credits Cost : 100 Credits for 1 Results

Security schema

URL Schema