Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

owner
string
default:0x06A9aF046187895AcFc7258450B15397CAc67400
required

End-user EOA whose activity should be fetched.

builder
string | null

Optional builder address. When provided, the response includes the current builder-fee approval state for this (owner, builder) pair.

Response

Successful Response

Aggregated HL activity for a single end-user.

Any section may be null if its upstream HL call failed — see partial_errors for details. positions/fills/open_orders are always either a populated list or null; an empty list means the user has no activity of that type, not a failure.

owner
string
required

Owner address that was queried (checksummed)

positions
PerpetualTradingPosition · object[] | null
required

Open positions (null if the upstream call failed)

account_value
string | null
required

Total account value in USDC (null if positions failed)

withdrawable
string | null
required

Withdrawable USDC balance (null if positions failed)

fills
PerpetualTradingFill · object[] | null
required

Recent fills (null if the upstream call failed)

open_orders
PerpetualTradingOpenOrder · object[] | null
required

Resting orders (null if the upstream call failed)

builder_approval
PerpetualTradingBuilderApproval · object | null

Builder approval state — only present when the builder query parameter was supplied (null on upstream failure).

partial_errors
PerpetualTradingActivityPartialError · object[]

One entry per section that failed to load.