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

Exposes functions to interact with Effects in Horizon.

You can:

  • List all effects.

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

Summary

Functions

Lists all effects.

Types

Functions

@spec all(options :: options()) :: response()

Lists all effects.

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(limit: 10, order: :asc)
{:ok, %Collection{records: [%Effect{}, ...]}}