Sign in
Syndicate Portfolio

Get syndicate portfolio summary

Changed on

Returns totals across the syndicate's portfolio: cost basis, current value, gains, per-status deal counts, and the number of distinct investors. Accepts the same status and company filters as the positions endpoint to total a slice of the portfolio, such as only exited deals.

The summary covers the syndicate's funded deals, summed across everyone holding their securities (not just current members), as aggregate figures only. Member-level data is available on the members endpoints.

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/syndicates/{syndicate_id}/portfolio

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/syndicates/{syndicate_id}/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:syndicates)

Path parameters

syndicate_idstring required

The syndicate's id (syn_...).

Query parameters

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

Total only deals 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": "syndicate_portfolio_summary",
    "attributes": {
      "currency": "usd"
    }
  }
}

Changes