Sign in
Portfolio

List portfolio positions

Changed on

Returns the authenticated investor's positions, one per offering (fundraise), newest first. Position totals cover everything the investor holds in that offering; securities breaks the total down by security offering and legal owner, so early bird tiers and personally-held vs entity-held stakes each appear separately. Fund and SPV positions identify the companies the vehicle invested in under holdings.

To compute an average cost per share, divide cost_basis_cents by shares_held.

Requires a user-authorized token, like GET /portfolio.

get/portfolio/positions

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/portfolio/positions
  • 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

cursorinteger

Cursor-based pagination token. Use the next_cursor value from the previous response's meta object to retrieve the next page of results. Omit this parameter to retrieve the first page.

per_pageinteger

Page size, 1-100. Defaults to 25.

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

Filter positions by status.

companystring

Filter to a single company by its id (co_...). Unknown ids return 404.

Response

Successful response

Example response

{
  "data": [
    {
      "id": "ofr_9aKxQ2vF8mNp1zT5wY7Qb3Cd",
      "attributes": {
        "offering_id": "ofr_9aKxQ2vF8mNp1zT5wY7Qb3Cd",
        "company": {
          "id": "co_2bt9eJn6X8C9gnShl63qlzkK",
          "name": "Acme Robotics",
          "slug": "acme-robotics"
        },
        "security": {
          "type": "safe",
          "label": "SAFE"
        },
        "currency": "usd",
        "return_multiple": "1.6492",
        "securities": [
          {
            "security": {
              "type": "safe",
              "label": "SAFE"
            },
            "terms": {
              "share_price": "10.0"
            }
          }
        ],
        "holdings": [
          {
            "company": {
              "id": "co_2bt9eJn6X8C9gnShl63qlzkK",
              "name": "Acme Robotics",
              "slug": "acme-robotics"
            }
          }
        ]
      }
    }
  ]
}

Changes

  • b13c74d0be35Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

  • d5f3a557f40dRevision changes
    • info

      endpoint added