AGG is currently in alpha. APIs, components, and docs may change.
Agg.market — Prediction Market Aggregator logo

Get a paper trading portfolio

Get a paper trading portfolio

GEThttps://api.agg.market/apps/{appId}/paper-trading/accounts/{accountId}/portfolio
Loading code example
Loading code example

Authorizations

appApiKeystringheaderrequired

API key passed in the header.

Path Parameters

appIdstringrequired
accountIdstringrequired

Response

application/json

200

accountobjectrequired
account.idstringrequired
account.appIdstringrequired
account.namestringrequired
account.externalIdstringrequired
account.currencystringrequired
account.startingBalanceRawstringrequired
account.startingBalancenumberrequired
account.cashBalanceRawstringrequired
account.cashBalancenumberrequired
account.realizedPnlRawstringrequired
account.realizedPnlnumberrequired
account.kycStatus"verified"required
Allowed values: "verified"
account.kycVerifiedtruerequired
Allowed values: true
account.status"active" | "archived"required
Allowed values: "active" | "archived"
account.createdAtstringrequired
account.updatedAtstringrequired
cashBalanceRawstringrequired
cashBalancenumberrequired
marketValueRawstringrequired
marketValuenumberrequired
equityRawstringrequired
equitynumberrequired
realizedPnlRawstringrequired
realizedPnlnumberrequired
unrealizedPnlRawstringrequired
unrealizedPnlnumberrequired
liquidationValueRawstringrequired
liquidationValuenumberrequired
liquidationEquityRawstringrequired
liquidationEquitynumberrequired
liquidationPnlRawstringrequired
liquidationPnlnumberrequired
positionsarray<object>required
positions.idstringrequired
positions.accountIdstringrequired
positions.venuestringrequired
positions.venueMarketIdstringrequired
positions.venueMarketOutcomeIdstringrequired
positions.marketQuestionstringrequired
positions.outcomeLabelstringrequired
positions.winnerbooleanrequired
positions.sizenumberrequired
positions.avgEntryPricenumberrequired
positions.markPricenumberrequired
positions.markSource"orderbook_midpoint" | "orderbook_best_bid" | "catalog_price"required
Allowed values: "orderbook_midpoint" | "orderbook_best_bid" | "catalog_price"
positions.markTimestampnumberrequired
positions.bestBidPricenumberrequired
positions.bestAskPricenumberrequired
positions.midpointnumberrequired
positions.spreadnumberrequired
positions.marketValueRawstringrequired
positions.marketValuenumberrequired
positions.unrealizedPnlRawstringrequired
positions.unrealizedPnlnumberrequired
positions.liquidationPricenumberrequired
positions.liquidationValueRawstringrequired
positions.liquidationValuenumberrequired
positions.liquidationPnlRawstringrequired
positions.liquidationPnlnumberrequired
positions.liquiditySharesnumberrequired
positions.liquidityStatus"full" | "partial" | "none"required
Allowed values: "full" | "partial" | "none"
positions.realizedPnlRawstringrequired
positions.realizedPnlnumberrequired
positions.createdAtstringrequired
positions.updatedAtstringrequired