Skip to main content
GET
Get Positions

Authorizations

X-River-Key-Id
string
header
required

UUID of your API key (from Settings → API Keys).

X-River-Timestamp
string
header
required

Current unix seconds. Must be within 30s of server time.

X-River-Signature
string
header
required

Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTED_QUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full recipe.

Query Parameters

subaccount_id
string<uuid> | null

Filter by specific subaccount

river_id
integer | null

Filter by instrument

include_closed
boolean
default:false

Include positions in closed markets

Response

Successful Response

Positions grouped by subaccount.

subaccount_to_positions
Subaccount To Positions · object[]
required