v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Users Info

Search users

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.

Powerful search platform that enables advanced user discovery with comprehensive filtering capabilities. Supports complex queries across multiple dimensions including performance metrics, risk profiles, investment patterns, and account characteristics. Ideal for identifying users based on specific trading behaviors and performance criteria.

get/api/v1/user-info/people/search

Query parameters

Defines the time period for analyzing user metrics and performance data. Supports various predefined intervals for consistent analysis.

isTestAccountboolean

When set to true, filters results to include only test/demo accounts. When false, shows only live accounts. Optional filter.

optInboolean

Filter for users who have explicitly opted in to specific features or programs. Used for compliance and feature-specific filtering.

blockedboolean

When true, includes only blocked accounts in the results. Used for compliance and risk management purposes.

pageinteger

Example:1

Page number for pagination.

pageSizeinteger

Example:10

Number of results per page.

sortstring

Example:-copiers

Sort results by specific field (e.g., -copiers).

popularInvestorboolean

Filter for popular investors.

gainMaxinteger

Example:100

Max gain value filter.

maxDailyRiskScoreMininteger

Example:1

Minimum daily risk score.

maxDailyRiskScoreMaxinteger

Example:7

Maximum daily risk score.

maxMonthlyRiskScoreMininteger

Example:1

Minimum monthly risk score.

maxMonthlyRiskScoreMaxinteger

Example:6

Maximum monthly risk score.

weeksSinceRegistrationMininteger

Example:75

Minimum weeks since registration.

countryIdinteger

Example:101

The registered country ID of the user

instrumentIdinteger

Example:-5

The instrument ID (you can also use this to exclude an instrument e.g., -5).

instrumentPctMininteger

Example:100

Minimum percentage of investment in the requested instrument ID.

instrumentPctMaxinteger

Example:100

Maximum percentage of investment in the requested instrument ID.

Headers

x-request-idstring uuid required

Example:39accae2-2977-4a68-8e08-99f4d30692ab

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

totalItemsinteger required