v1
latestOpenAPI 3.0.12026-07-26171200932.8 KBRankings
Get ranking row for a single investor
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 the full ranking row for the specified investor for a given time period. Returns 404 if the user is private, not found, or not ranked. period is required because every performance field is computed over a defined time window.
get/api/v2/portfolios/{username}/rankings
Path parameters
usernamestring required
Query parameters
period'CurrMonth' | 'OneMonthAgo' | 'TwoMonthsAgo' | 'CurrQuarter' | 'ThreeMonthsAgo' | 'SixMonthsAgo' | 'CurrYear' | 'OneYearAgo' | 'LastYear' | 'LastTwoYears' required
Rolling time window for performance metrics.
Headers
x-request-idstring uuid required
Example:b7bfaf43-c92c-4d14-b679-099ea326e280
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