v1
latestOpenAPI 3.0.12026-07-26171200932.8 KBRankings
Get paginated investor rankings
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 paged list of investor ranking rows filtered and sorted by query parameters. period is required; all filter parameters are optional.
get/api/v2/portfolios/rankings
Query parameters
period'CurrMonth' | 'OneMonthAgo' | 'TwoMonthsAgo' | 'CurrQuarter' | 'ThreeMonthsAgo' | 'SixMonthsAgo' | 'CurrYear' | 'OneYearAgo' | 'LastYear' | 'LastTwoYears' required
Rolling time window for performance metrics.
sortstring
Example:-copiers
Sort field in camelCase; prefix with - for descending (e.g. -copiers). Unknown values are rejected with 400.
pageinteger
pageSizeinteger
countrystring
Filter by ISO 3166-1 alpha-2 country code (e.g. "GB", "US").
gainMinnumber
gainMaxnumber
copiersMininteger
copiersMaxinteger
riskScoreMininteger
riskScoreMaxinteger
popularInvestorboolean
When true, filters to active Popular Investors only.
aumTierinteger
Headers
x-request-idstring uuid required
Example:1a783925-8963-4936-8b5c-133bd5de4fe6
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