Skip to main content
GET
Get user positions

Integration guide

Authorizations

x-app-api-key
string
header
required

App-scoped API key. It is the only credential on partner-admin reads, paper-trading admin, and webhook rotate or replay. POST /bot-protection/verify requires it together with x-app-id.

Path Parameters

appId
string
required
userId
string
required

Query Parameters

cursor
string
limit
integer
Required range: 1 <= x <= 100
venueEventId
string
venueMarketId
string
status
enum<string>

active: shares still held. closed: fully sold or settled.

Available options:
active,
closed
categoryIds

Only positions on events in any of these categories (Category.ids, as /venue-events?categoryIds= takes; a league is a category). At most 20.

Maximum array length: 20
Minimum string length: 1
sort
enum<string>

realizedPnl: highest realized P&L first (e.g. biggest wins with status=closed). Default: stable group order. Live positions only.

Available options:
realizedPnl

Response

200

data
object[]
required

This page of results.

nextCursor
string | null
required

Pass as cursor to fetch the next page; null on the last page.

hasMore
boolean
required

true when another page exists.