Portfolio

Get portfolio summary

Changed on

Returns totals across the authenticated investor's portfolio: cost basis, current value, realized and unrealized gains, and per-status position counts. Accepts the same status and company filters as GET /portfolio/positions to total a slice of the portfolio, such as only exited positions.

Requires a user-authorized token. App-only (client credentials) tokens receive 403.

Portfolio values are recalculated periodically rather than on each request, so recent investments and valuation changes can take a few minutes to appear. as_of is the timestamp of the oldest calculation included in the response.

Monetary values are integer cents; per-share prices and return multiples are decimal strings.

get/portfolio

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/portfolio
  • Auth: OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: read:investments)

Query parameters

status'active' | 'exited' | 'sold' | 'failed'

Total only positions with this status.

companystring

Total only positions in this company, by its id (co_...). Unknown ids return 404.

Response

Successful response

Example response

{
  "data": {
    "type": "portfolio_summary",
    "attributes": {
      "currency": "usd",
      "return_multiple": "1.3107"
    }
  }
}

Changes