Skip to main content

Retrieve a Ledger Effects REST API Endpoint

Returns the effects of a specific ledger

Updated on
Oct 04, 2023

Path Parameters

sequence
integer
REQUIRED

The sequence number of a specific ledger

Query Parameters

cursor
integer

A number that points to a specific location in a collection of responses which is pulled from the paging_token value of a record

order
string

The designation of the order of the records. It can be ascending or descending. By default it is set to ascending

limit
integer

The maximum number of records returned

Returns

_links
object

The link object which provides links to various related resources

self
object

The self link object which contains the following field:

href
string

A link that points to the current page of liquidity_pools

templated
boolean

A boolean value that indicates whether the link is templated or not

next
object

The next link object which contains the following field:

href
string

A link to the next page of liquidity_pools, allowing for pagination

templated
boolean

A boolean value that indicates whether the link is templated or not

prev
object

The prev link object which contains the following field:

href
string

A link to the previous page of liquidity_pools, enabling navigation backward

templated
boolean

A boolean value that indicates whether the link is templated or not

_embedded
object

Embedded object which contains the following fields:

records
array

An array of transaction records, each representing a specific transaction

_links
object

Links to related resources associated with the specific operation

operation
object

The operation link object which contains the following field:

href
string

A link to the operation associated with the effect

templated
boolean

A boolean value that indicates whether the link is templated or not

succeeds
object

The succeeds link object which contains the following field:

href
string

A link to effects with an order in descending order relative to this operation's order

precedes
object

The precedes link object which contains the following field:

href
string

A link to effects with an order in ascending order relative to this operation's order

id
string

The Account ID

paging_token
string

The paging token for navigation purposes

account
string

The account that initiated the operation

type
string

The type of operation

type_i
integer

The numeric code representing the operation type

created_at
string

The timestamp indicating when the operation was created

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free