For the complete documentation index, see llms.txt. This page is also available as Markdown.

Account & positions

The basket snapshot and the enriched positions / orders reads.

A wallet's live state, decoded from its basket. Shared conventions: Conventions.

Method
Path

GET

/owner/{owner}

GET

/positions/owner/{owner}

GET

/orders/owner/{owner}

For the live WebSocket form, see WebSocket.


Basket snapshot

GET /owner/{owner}

One-shot fetch of the full basket — the same payload the WebSocket streams.

Param
In
Description

owner

path

Owner wallet pubkey

ResponseBasketSnapshotDto

{
  "owner": "bRXn4PPnUCLKP3kdHbX6FFQFpw2AhFzBVMgo4ZaWvtfb",
  "basketPubkey": "",
  "basketData": "base64-raw-basket-bytes…",
  "positionMetrics": { "<marketPubkey>": { /* PositionMetricsDto */ } },
  "orderMetrics": { "<marketPubkey>": { /* OrderMetricsDto */ } }
}
Field
Description

basketPubkey

Basket PDA (derived from owner); null if not yet ingested

basketData

Base64 raw basket bytes; null if not yet ingested. Decode with the client SDK for native PositionMeta[] / OrderMeta[]

positionMetrics

Per-position metrics keyed by market pubkey (active-pool, non-zero size)

orderMetrics

Per-market order metrics keyed by market pubkey (non-empty slots)

Field lists for PositionMetricsDto / OrderMetricsDto are on WebSocket.


Positions

GET /positions/owner/{owner}

The snapshot's positionMetrics on their own — a map of marketPubkey → PositionMetricsDto.

Param
In
Description

owner

path

Owner wallet pubkey

Key fields per position: sideUi, marketSymbol, entryPriceUi, sizeUsdUi, collateralUsdUi, pnlWithFeeUsdUi, pnlPercentageWithFee, liquidationPriceUi, leverageUi (full list: WebSocket › DTOs).


Orders

GET /orders/owner/{owner}

The snapshot's orderMetrics on their own — a map of marketPubkey → OrderMetricsDto, each with limitOrders[], takeProfitOrders[], stopLossOrders[] (trigger price, size, orderId, leverage).

Last updated

Was this helpful?