v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Rankings

Bulk-fetch ranking rows

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 ranking rows for a list of investors identified by username. Missing, private, or unranked users are silently omitted. Maximum 100 usernames per request.

post/api/v2/portfolios/rankings/multiple

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:14e1bde5-547e-4183-a878-f0f8ededb0fa

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.

Request body

usernamesstring[] required

Example request

{
  "usernames": [
    "investor1",
    "investor2"
  ]
}

Response

Successful response (order preserved, missing users omitted)