Sign in

v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
User Stats

Get asset allocation history

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

Returns a daily asset-allocation breakdown for a publicly visible portfolio. Data is only available for investors who have not opted out — opted-out portfolios return 403 for third-party callers. Callers must authenticate with their own token. Use period OR minDate+maxDate (mutually exclusive). All ratio fields use decimal fraction format: 0.5 = 50%.

get/api/v2/portfolios/{username}/assets/history

Path parameters

usernamestring required

Query parameters

period'CurrMonth' | 'OneMonthAgo' | 'TwoMonthsAgo' | 'CurrQuarter' | 'ThreeMonthsAgo' | 'SixMonthsAgo' | 'CurrYear' | 'OneYearAgo' | 'LastYear' | 'LastTwoYears'

Predefined rolling window. Mutually exclusive with minDate/maxDate.

minDatestring date

Start date inclusive (YYYY-MM-DD). Mutually exclusive with period. Required together with maxDate when period is omitted.

maxDatestring date

End date inclusive (YYYY-MM-DD). Mutually exclusive with period. Required together with minDate when period is omitted.

countinteger

Downsample time axis to at most N buckets. Omit or pass 0 for no downsampling.

Headers

x-request-idstring uuid required
Example:1bcd6f33-aafd-455c-b2ed-1215e61e7451

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Successful response

userNamestring required

Echoes the requested username.