Portfolio

Get your portfolio

The key owner's own paper portfolio in one call: the account, open positions (at most 500) and resting orders (at most 200), each naming the Arena instrument its market lists and the side held. Private picks included. With no X-Arena-Org header this is the key's own main account. With the header it is that organization's paper sandbox: its cash, positions and resting orders, and organization.slug. An unknown or forbidden organization is refused rather than answered from the personal account. No ticker, title or price while the venue-data switch is off. Not cached.

get/portfolio

Request

  • Base URL: https://arena-predictions.com/api/v1
  • URL: https://arena-predictions.com/api/v1/portfolio
  • Auth: HTTP bearer

Headers

X-Arena-Orgstring

Organization id. When present, this call uses that organization's paper sandbox. When absent, the key owner's personal paper account. A value that is not an organization id is 400 invalid_request. An unknown organization is 404 organization_not_found and one this key cannot use is 403 organization_forbidden. The personal account is never the fallback. Paper only. This header does not select a Combine evaluation account.

Response

Your portfolio.

positionsCountinteger required
positionsTruncatedboolean required
ordersCountinteger required
ordersTruncatedboolean required
asOfstring date-time required
venueDataboolean required
mode'paper' required

Changes

No recorded changes to this operation across all 1 revision of this API.