List All Effects REST API Endpoint
Please note that this method can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger.
Query Parameters
cursor
string
A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record
order
string
The order of the returned data. The possible value includes ascending and descending order
limit
string
The maximum number of records to return
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 containing individual operation records that match the query parameters
_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 the effect that succeeds the current one
templated
boolean
A boolean value that indicates whether the link is templated or not
precedes
object
The precedes link object which contains the following field:
href
string
A link to the effect that precedes the current one
templated
boolean
A boolean value that indicates whether the link is templated or not
id
string
The unique identifier for the effect record
paging_token
string
The paging token for the effect record, aiding in navigation
account
string
The Stellar account affected by the effect. Value must match regular expression G[A-Z0-9]{55}
type
string
The type of effect, indicating the nature of the event
amount
string
The Stellar amount balance
type_i
integer
The numeric code representing the effect type
created_at
string
The timestamp indicating when the effect was created
starting_balance
string
The starting balance amount
Request
1curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/effects' \2-H 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free