Skip to main content
Requires authentication.
The Portfolio resource provides access to your trading positions and activity history.

​
Methods

MethodEndpointDescription
positions(params?)GET /v1/portfolio/positionsGet trading positions
activities(params?)GET /v1/portfolio/activitiesGet activity history

​
positions

Get your current trading positions. Returns a map of market slug to position data. 
const positions = await client.portfolio.positions();

for (const [slug, pos] of Object.entries(positions.positions)) {
  const meta = pos.marketMetadata;
  console.log(meta.title);
  console.log(`  Net Position: ${pos.netPosition}`);
  console.log(`  Cost: $${pos.cost.value}`);
  console.log(`  Cash Value: $${pos.cashValue.value}`);
}

​
Parameters

ParameterTypeDescription
cursorstringPagination cursor
limitnumberMaximum results

​
Position Fields

FieldTypeDescription
netPositionstringNet quantity (positive = long, negative = short)
qtyBoughtstringTotal quantity bought
qtySoldstringTotal quantity sold
costAmountTotal cost basis
realizedAmountRealized profit/loss
cashValueAmountCurrent unrealized value
qtyAvailablestringQuantity available to trade
expiredbooleanWhether position has expired
marketMetadataobjectMarket information

​
activities

Get your trading activity history including trades, settlements, deposits, and withdrawals. 
const activities = await client.portfolio.activities({ limit: 20 });

for (const act of activities.activities) {
  console.log(`${act.type}: ${JSON.stringify(act.trade ?? act.accountBalanceChange)}`);
}

​
Parameters

ParameterTypeDescription
limitnumberMaximum results
cursorstringPagination cursor
typesstring[]Filter by activity types
marketSlugstringFilter by market
sortOrderstringSORT_ORDER_DESCENDING (default) or SORT_ORDER_ASCENDING

​
Activity Types

TypeNested FieldDescription
ACTIVITY_TYPE_TRADEtradeTrade execution
ACTIVITY_TYPE_POSITION_RESOLUTIONpositionResolutionMarket settlement
ACTIVITY_TYPE_ACCOUNT_DEPOSITaccountBalanceChangeDeposit
ACTIVITY_TYPE_ACCOUNT_WITHDRAWALaccountBalanceChangeWithdrawal

​
Trade Fields

FieldTypeDescription
idstringTrade ID
marketSlugstringMarket slug
priceAmountTrade price
qtystringTrade quantity
isAggressorbooleanTrue if taker
realizedPnlAmountRealized P&L
For real-time position updates, use the WebSocket with SUBSCRIPTION_TYPE_POSITION instead of polling.