Skip to main content
GET
Get paginated investor rankings

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"21e7a9ab-f83c-468a-9de4-25611d185306"

Query Parameters

period
enum<string>
required

Rolling time window for performance metrics. Rolling time window over which all performance metrics are computed. Every window ends at the max date (the latest ranking refresh); examples below use a max date of 2026-07-15:

  • CurrMonth – current month to date, from the 1st of the current month. E.g. 2026-07-01 to 2026-07-15.
  • CurrQuarter – current quarter to date, from the 1st day of the current calendar quarter. E.g. 2026-07-01 to 2026-07-15.
  • CurrYear – year to date, from January 1st of the current year. E.g. 2026-01-01 to 2026-07-15.
  • LastYear – from January 1st of the previous calendar year to the max date. E.g. 2025-01-01 to 2026-07-15.
  • LastTwoYears – from January 1st two calendar years ago to the max date. E.g. 2024-01-01 to 2026-07-15.
  • OneMonthAgo – rolling ~1 month window, from the 1st of the previous month. E.g. 2026-06-01 to 2026-07-15.
  • TwoMonthsAgo – rolling ~2 month window, from the 1st of the month two months ago. E.g. 2026-05-01 to 2026-07-15.
  • ThreeMonthsAgo – rolling ~3 month window, from the 1st of the month three months ago. E.g. 2026-04-01 to 2026-07-15.
  • SixMonthsAgo – rolling ~6 month window, from the 1st of the month six months ago. E.g. 2026-01-01 to 2026-07-15.
  • OneYearAgo – rolling ~12 month window, from the 1st of the month twelve months ago. E.g. 2025-07-01 to 2026-07-15.
  • AbsOneYear – exactly one year before the max date, with no rounding to month/year start. E.g. 2025-07-15 to 2026-07-15.
  • AbsTwoYears – exactly two years before the max date, with no rounding. E.g. 2024-07-15 to 2026-07-15.
Available options:
CurrMonth,
OneMonthAgo,
TwoMonthsAgo,
CurrQuarter,
ThreeMonthsAgo,
SixMonthsAgo,
CurrYear,
OneYearAgo,
LastYear,
LastTwoYears,
AbsOneYear,
AbsTwoYears
sort
string

Sort field in camelCase; prefix with - for descending (e.g. -copiers). Unknown values are rejected with 400.

Example:

"-copiers"

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:20
Required range: 1 <= x <= 100
country
string

Filter by ISO 3166-1 alpha-2 country code (e.g. "GB", "US").

gainMin
number
gainMax
number
copiersMin
integer
copiersMax
integer
riskScoreMin
integer
Required range: 1 <= x <= 10
riskScoreMax
integer
Required range: 1 <= x <= 10

When true, filters to active Popular Investors only.

aumTier
integer

Response

Successful response

results
object[]
required
pagination
object
required