BluxBlux

Get Effects

Fetch a paginated list of Stellar effects using the Blux core SDK.

The getEffects function returns a paginated list of Stellar effects.

The return value contains two properties:

  • response — the records you can use directly
  • builder — exposes next() and prev() to paginate through results

Type

export type CallBuilderOptions = {
  cursor?: string;
  limit?: number;
  network?: string;
  order?: "asc" | "desc";
};

type GetEffectsOptions = CallBuilderOptions & {
  forAccount?: string;
  forLedger?: string | number;
  forTransaction?: string;
  forOperation?: string;
  forLiquidityPool?: string;
};

type GetEffectsResult = {
  builder: EffectCallBuilder;
  response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.EffectRecord>;
};

Usage

import { core } from "@bluxcc/core";

const result = await core.getEffects({});

On this page