Get portfolio summary

GET 
/portfolio

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.

Request

Responses

200

Successful response

401

Authentication required or token is invalid/expired. This error occurs when:

• No Authorization header is provided
• The access token is invalid or malformed
• The access token has expired
• The access token has been revoked

To resolve: Obtain a new access token using the OAuth 2.0 flow.

403

The authenticated user does not have permission to access this resource. This typically means:

• The user is authenticated but lacks the required OAuth scope
• The resource belongs to a different user
• The user's role doesn't allow this operation

Check that your OAuth token includes the necessary scopes for this endpoint.

429

Too many requests in a short time period. The API enforces rate limits to ensure fair usage and system stability. When you exceed the limit, you'll receive this error along with headers indicating when you can retry.

Check the X-RateLimit-Reset header to know when your limit will reset. Consider implementing exponential backoff in your application.

Response Headers

X-RateLimit-Limit

Request limit per hour

X-RateLimit-Remaining

Remaining requests

X-RateLimit-Reset

UTC timestamp when the limit resets