Skip to main content
GET
Search users

Authorizations

Authorization
string
header
required

eToro OAuth2. Each operation lists the scopes that grant access as separate security requirements (OpenAPI OR semantics): the caller's token only needs ONE of them — you do NOT need all of them. The same scopes back the x-api-key/x-user-key credential pair.

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"39accae2-2977-4a68-8e08-99f4d30692ab"

x-api-key
string<password>
required

API key for authentication.

Example:

"lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663"

x-user-key
string<password>
required

User-specific authentication key.

Example:

"eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_"

Query Parameters

period
enum<string>
required

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

Available options:
CurrMonth,
CurrQuarter,
CurrYear,
LastYear,
LastTwoYears,
OneMonthAgo,
TwoMonthsAgo,
ThreeMonthsAgo,
SixMonthsAgo,
OneYearAgo
isTestAccount
boolean

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

optIn
boolean

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

blocked
boolean

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

page
integer

Page number for pagination.

Example:

1

pageSize
integer

Number of results per page.

Example:

10

sort
string

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

Example:

"-copiers"

Filter for popular investors.

gainMax
integer

Max gain value filter.

Example:

100

maxDailyRiskScoreMin
integer

Minimum daily risk score.

Example:

1

maxDailyRiskScoreMax
integer

Maximum daily risk score.

Example:

7

maxMonthlyRiskScoreMin
integer

Minimum monthly risk score.

Example:

1

maxMonthlyRiskScoreMax
integer

Maximum monthly risk score.

Example:

6

weeksSinceRegistrationMin
integer

Minimum weeks since registration.

Example:

75

countryId
integer

The registered country ID of the user

Example:

101

instrumentId
integer

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

Example:

-5

instrumentPctMin
integer

Minimum percentage of investment in the requested instrument ID.

Example:

100

instrumentPctMax
integer

Maximum percentage of investment in the requested instrument ID.

Example:

100

Response

OK

totalItems
integer
required
items
object[]
required