BluxBlux

Get Trades

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

The getTrades function returns a paginated list of Stellar trades. forAccount accepts G…, M…, SEP-2 federation, or .xlm; see address resolution.

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 GetTradesOptions = CallBuilderOptions & {
  forAssetPair?: [base: AssetArg, counter: AssetArg];
  forOffer?: string;
  forType?: Horizon.ServerApi.TradeType;
  forAccount?: string; // G…/M…, SEP-2 address, or .xlm name
  forLiquidityPool?: string;
};

type GetTradesResult = {
  builder: TradesCallBuilder;
  response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.TradeRecord>;
};

Usage

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

const result = await core.getTrades({ forAccount: "alice.xlm" });

On this page