View Source Stellar.Horizon.Effects (Elixir Stellar SDK v0.21.0)

Exposes functions to interact with Effects in Horizon.

You can:

  • List all effects.

Horizon API reference: https://developers.stellar.org/api/resources/effects/

Summary

Types

Functions

Link to this function

all(server, options \\ [])

View Source
@spec all(server :: server(), options :: options()) :: response()

Lists all effects.

Parameters

  • server: The Horizon server to query.

Options

  • cursor: 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: A designation of the order in which records should appear. Options include asc (ascending) or desc (descending).
  • limit: The maximum number of records returned. The limit can range from 1 to 200. Defaults to 10.

Examples

iex> Effects.all(Stellar.Horizon.Server.testnet(), limit: 10, order: :asc)
{:ok, %Collection{records: [%Effect{}, ...]}}