Comprehensive search and analytics engine for user discovery and analysis

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

Comprehensive search and analytics engine for user discovery and analysis

cURL

curl --request GET \
  --url https://public-api.etoro.com/api/v1/user-info/people/search \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-user-key: <x-user-key>'

200

{
  "status": "<string>",
  "totalRows": 123,
  "items": [
    {
      "customerId": 123,
      "userName": "<string>",
      "fullName": "<string>",
      "hasAvatar": true,
      "isSocialConnected": true,
      "isTestAccount": true,
      "displayFullName": true,
      "bonusOnly": true,
      "blocked": true,
      "verified": true,
      "popularInvestor": true,
      "copyBlock": true,
      "isFund": true,
      "isBronze": true,
      "fundType": 123,
      "tags": [
        123
      ],
      "gain": 123,
      "dailyGain": 123,
      "thisWeekGain": 123,
      "riskScore": 123,
      "maxDailyRiskScore": 123,
      "maxMonthlyRiskScore": 123,
      "copiers": 123,
      "copiedTrades": 123,
      "copyTradesPct": 123,
      "copyInvestmentPct": 123,
      "baseLineCopiers": 123,
      "copiersGain": 123,
      "aumTier": 123,
      "aumTierV2": 123,
      "aumTierDesc": "<string>",
      "virtualCopiers": 123,
      "trades": 123,
      "winRatio": 123,
      "dailyDd": 123,
      "weeklyDd": 123,
      "profitableWeeksPct": 123,
      "profitableMonthsPct": 123,
      "velocity": 123,
      "exposure": 123,
      "avgPosSize": 123,
      "optimalCopyPosSize": 123,
      "highLeveragePct": 123,
      "mediumLeveragePct": 123,
      "lowLeveragePct": 123,
      "peakToValley": 123,
      "peakToValleyStart": "2023-11-07T05:31:56Z",
      "peakToValleyEnd": "2023-11-07T05:31:56Z",
      "longPosPct": 123,
      "topTradedInstrumentId": 123,
      "topTradedAssetClassId": 123,
      "topTradedInstrumentPct": 123,
      "totalTradedInstruments": 123,
      "activeWeeks": 123,
      "firstActivity": "2023-11-07T05:31:56Z",
      "lastActivity": "2023-11-07T05:31:56Z",
      "activeWeeksPct": 123,
      "weeksSinceRegistration": 123,
      "country": "<string>",
      "affiliateId": 123,
      "instrumentPct": 123
    }
  ]
}

Headers

x-request-id · string<uuid> · required

A unique request identifier.

Example:

"97488d63-f3d6-48f7-9cc3-bb4d826e482d"

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"

popularInvestor · boolean

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

200 - application/json

OK

status · string · required

totalRows · integer · required

items · object[] · required

Show child attributes