Skip to content

Latest commit

 

History

History
713 lines (467 loc) · 35.7 KB

XRPRippleApi.md

File metadata and controls

713 lines (467 loc) · 35.7 KB
Raw

\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

GetLatestMinedXRPRippleBlockR GetLatestMinedXRPRippleBlock(ctx, network).Context(context).Execute()

Get Latest Mined XRP (Ripple) Block

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.GetLatestMinedXRPRippleBlock(context.Background(), network).Context(context).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.GetLatestMinedXRPRippleBlock``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLatestMinedXRPRippleBlock`: GetLatestMinedXRPRippleBlockR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.GetLatestMinedXRPRippleBlock`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.

Other Parameters

Other parameters are passed through a pointer to a apiGetLatestMinedXRPRippleBlockRequest struct via the builder pattern

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. |

Return type

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

GetXRPRippleAddressDetailsR GetXRPRippleAddressDetails(ctx, network, address).Context(context).Execute()

Get XRP (Ripple) Address Details

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.GetXRPRippleAddressDetails(context.Background(), network, address).Context(context).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.GetXRPRippleAddressDetails``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetXRPRippleAddressDetails`: GetXRPRippleAddressDetailsR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.GetXRPRippleAddressDetails`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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", are test networks.
address string Represents the public address, which is a compressed and shortened form of a public key.

Other Parameters

Other parameters are passed through a pointer to a apiGetXRPRippleAddressDetailsRequest struct via the builder pattern

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. |

Return type

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

GetXRPRippleBlockDetailsByBlockHashR GetXRPRippleBlockDetailsByBlockHash(ctx, network, blockHash).Context(context).Execute()

Get XRP (Ripple) Block Details By Block Hash

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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.
    blockHash := "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. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.GetXRPRippleBlockDetailsByBlockHash(context.Background(), network, blockHash).Context(context).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.GetXRPRippleBlockDetailsByBlockHash``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetXRPRippleBlockDetailsByBlockHash`: GetXRPRippleBlockDetailsByBlockHashR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.GetXRPRippleBlockDetailsByBlockHash`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.
blockHash 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.

Other Parameters

Other parameters are passed through a pointer to a apiGetXRPRippleBlockDetailsByBlockHashRequest struct via the builder pattern

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. |

Return type

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

GetXRPRippleBlockDetailsByBlockHeightR GetXRPRippleBlockDetailsByBlockHeight(ctx, network, blockHeight).Context(context).Execute()

Get XRP (Ripple) Block Details By Block Height

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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.
    blockHeight := "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. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.GetXRPRippleBlockDetailsByBlockHeight(context.Background(), network, blockHeight).Context(context).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.GetXRPRippleBlockDetailsByBlockHeight``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetXRPRippleBlockDetailsByBlockHeight`: GetXRPRippleBlockDetailsByBlockHeightR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.GetXRPRippleBlockDetailsByBlockHeight`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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", are test networks.
blockHeight 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".

Other Parameters

Other parameters are passed through a pointer to a apiGetXRPRippleBlockDetailsByBlockHeightRequest struct via the builder pattern

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. |

Return type

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

GetXRPRippleTransactionDetailsByTransactionIDR GetXRPRippleTransactionDetailsByTransactionID(ctx, network, transactionHash).Context(context).Execute()

Get XRP (Ripple) Transaction Details By Transaction ID

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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.
    transactionHash := "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. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.GetXRPRippleTransactionDetailsByTransactionID(context.Background(), network, transactionHash).Context(context).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.GetXRPRippleTransactionDetailsByTransactionID``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetXRPRippleTransactionDetailsByTransactionID`: GetXRPRippleTransactionDetailsByTransactionIDR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.GetXRPRippleTransactionDetailsByTransactionID`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.
transactionHash 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.

Other Parameters

Other parameters are passed through a pointer to a apiGetXRPRippleTransactionDetailsByTransactionIDRequest struct via the builder pattern

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. |

Return type

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

ListXRPRippleTransactionsByAddressR ListXRPRippleTransactionsByAddress(ctx, network, address).Context(context).Limit(limit).Offset(offset).TransactionType(transactionType).Execute()

List XRP (Ripple) Transactions by Address

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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. (optional)
    limit := int64(50) // int64 | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset := int64(0) // int64 | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)
    transactionType := "payment" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.ListXRPRippleTransactionsByAddress(context.Background(), network, address).Context(context).Limit(limit).Offset(offset).TransactionType(transactionType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.ListXRPRippleTransactionsByAddress``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListXRPRippleTransactionsByAddress`: ListXRPRippleTransactionsByAddressR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.ListXRPRippleTransactionsByAddress`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.
address string Represents the public address, which is a compressed and shortened form of a public key.

Other Parameters

Other parameters are passed through a pointer to a apiListXRPRippleTransactionsByAddressRequest struct via the builder pattern

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. | limit | int64 | Defines how many items should be returned in the response per page basis. | [default to 50] offset | int64 | The starting index of the response items, i.e. where the response should start listing the returned items. | [default to 0] transactionType | string | |

Return type

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

ListXRPRippleTransactionsByAddressAndTimeRangeR ListXRPRippleTransactionsByAddressAndTimeRange(ctx, network, address).FromTimestamp(fromTimestamp).ToTimestamp(toTimestamp).Context(context).Limit(limit).Offset(offset).TransactionType(transactionType).Execute()

List XRP (Ripple) Transactions By Address And Time Range

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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.
    fromTimestamp := int32(1616347862) // int32 | Defines the specific time/date from which the results will start being listed.
    toTimestamp := int32(1616347870) // int32 | 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. (optional)
    limit := int64(50) // int64 | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset := int64(0) // int64 | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)
    transactionType := "payment" // string | Defines the transaction type. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.ListXRPRippleTransactionsByAddressAndTimeRange(context.Background(), network, address).FromTimestamp(fromTimestamp).ToTimestamp(toTimestamp).Context(context).Limit(limit).Offset(offset).TransactionType(transactionType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.ListXRPRippleTransactionsByAddressAndTimeRange``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListXRPRippleTransactionsByAddressAndTimeRange`: ListXRPRippleTransactionsByAddressAndTimeRangeR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.ListXRPRippleTransactionsByAddressAndTimeRange`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.
address string Represents the public address, which is a compressed and shortened form of a public key.

Other Parameters

Other parameters are passed through a pointer to a apiListXRPRippleTransactionsByAddressAndTimeRangeRequest struct via the builder pattern

Name Type Description Notes

fromTimestamp | int32 | Defines the specific time/date from which the results will start being listed. | toTimestamp | int32 | 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. | limit | int64 | Defines how many items should be returned in the response per page basis. | [default to 50] offset | int64 | The starting index of the response items, i.e. where the response should start listing the returned items. | [default to 0] transactionType | string | Defines the transaction type. |

Return type

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

ListXRPRippleTransactionsByBlockHashR ListXRPRippleTransactionsByBlockHash(ctx, network, blockHash).Context(context).Limit(limit).Offset(offset).Execute()

List XRP (Ripple) Transactions By Block Hash

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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.
    blockHash := "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. (optional)
    limit := int64(50) // int64 | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset := int64(0) // int64 | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.ListXRPRippleTransactionsByBlockHash(context.Background(), network, blockHash).Context(context).Limit(limit).Offset(offset).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.ListXRPRippleTransactionsByBlockHash``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListXRPRippleTransactionsByBlockHash`: ListXRPRippleTransactionsByBlockHashR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.ListXRPRippleTransactionsByBlockHash`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.
blockHash 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.

Other Parameters

Other parameters are passed through a pointer to a apiListXRPRippleTransactionsByBlockHashRequest struct via the builder pattern

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. | limit | int64 | Defines how many items should be returned in the response per page basis. | [default to 50] offset | int64 | The starting index of the response items, i.e. where the response should start listing the returned items. | [default to 0]

Return type

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

ListXRPRippleTransactionsByBlockHeightR ListXRPRippleTransactionsByBlockHeight(ctx, network, blockHeight).Context(context).Limit(limit).Offset(offset).Execute()

List XRP (Ripple) Transactions By Block Height

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    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.
    blockHeight := int64(15971358) // int64 | 
    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. (optional)
    limit := int64(50) // int64 | Defines how many items should be returned in the response per page basis. (optional) (default to 50)
    offset := int64(0) // int64 | The starting index of the response items, i.e. where the response should start listing the returned items. (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.XRPRippleApi.ListXRPRippleTransactionsByBlockHeight(context.Background(), network, blockHeight).Context(context).Limit(limit).Offset(offset).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `XRPRippleApi.ListXRPRippleTransactionsByBlockHeight``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListXRPRippleTransactionsByBlockHeight`: ListXRPRippleTransactionsByBlockHeightR
    fmt.Fprintf(os.Stdout, "Response from `XRPRippleApi.ListXRPRippleTransactionsByBlockHeight`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, 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.
blockHeight int64

Other Parameters

Other parameters are passed through a pointer to a apiListXRPRippleTransactionsByBlockHeightRequest struct via the builder pattern

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. | limit | int64 | Defines how many items should be returned in the response per page basis. | [default to 50] offset | int64 | The starting index of the response items, i.e. where the response should start listing the returned items. | [default to 0]

Return type

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]