eToro Users Info API
The Users Info API from eToro — 6 operation(s) for users info.
OpenAPI Specification
openapi: 3.0.1
info:
title: Deprecated eToro Public API operations Agent Portfolios Users Info API
version: v1.158.0
description: Snapshot of API operations that existed in the previous docs OpenAPI file and are no longer present in the current upstream Swagger.
tags:
- name: Users Info
paths:
/api/v1/user-info/people:
get:
tags:
- Users Info
summary: Retrieve comprehensive user profile data and aggregated account information
description: Returns detailed user profile information including account status, verification levels, biographical data, and associated metadata. This endpoint aggregates essential user information from multiple sources to provide a complete user profile overview.
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 5394d844-f44c-4169-8122-0091d9c0051c
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: usernames
in: query
schema:
type: array
items:
type: string
explode: false
required: false
- name: cidList
in: query
schema:
type: array
items:
type: integer
explode: false
required: false
responses:
'200':
description: Successfully retrieved user information
content:
application/json:
schema:
$ref: '#/components/schemas/PublicAggregatedInfoResponse'
example:
users:
- gcid: 1536861
realCID: 1563191
demoCID: 1563191
username: exampleuser
language: 1
languageIsoCode: en-GB
country: 54
allowDisplayFullName: false
userBio:
gcid: 1536861
languageCode: null
whiteLabel: 1
optOut: true
homepage: null
playerStatus: null
piLevel: 0
isPi: false
avatars:
- url: https://***.s3.amazonaws.com/images/avatoros/35x35/cy.png
width: 35
height: 35
type: Resized
- url: https://***.s3.amazonaws.com/images/avatoros/50x50/cy.png
width: 50
height: 50
type: Resized
- url: https://***.s3.amazonaws.com/images/avatoros/150x150/cy.png
width: 150
height: 150
type: Resized
masterAccountCid: null
accountType: 1
fundType: null
isVerified: false
verificationLevel: 1
accountStatus: 1
gdprInfo: null
userFlowSignature: 233a065f3f8d7e344516fc75f7e6c4646a0c0d38798c00e4655fa0a9447ea223
'400':
description: Invalid request - Typically due to exceeding maximum usernames limit or invalid username format
'404':
description: One or more requested usernames not found
operationId: retrieveComprehensiveUserProfileDataAggregated
/api/v1/user-info/people/search:
get:
tags:
- Users Info
summary: Comprehensive search and analytics engine for user discovery and analysis
description: 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.
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 84e852a9-bbac-4fc1-8556-40a295a06bc6
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: period
in: query
description: Defines the time period for analyzing user metrics and performance data. Supports various predefined intervals for consistent analysis.
required: true
schema:
type: string
enum:
- CurrMonth
- CurrQuarter
- CurrYear
- LastYear
- LastTwoYears
- OneMonthAgo
- TwoMonthsAgo
- ThreeMonthsAgo
- SixMonthsAgo
- OneYearAgo
example: LastYear
- name: isTestAccount
in: query
description: When set to true, filters results to include only test/demo accounts. When false, shows only live accounts. Optional filter.
required: false
schema:
type: boolean
example: false
- name: optIn
in: query
description: Filter for users who have explicitly opted in to specific features or programs. Used for compliance and feature-specific filtering.
required: false
schema:
type: boolean
example: true
- name: blocked
in: query
description: When true, includes only blocked accounts in the results. Used for compliance and risk management purposes.
required: false
schema:
type: boolean
example: false
- name: page
in: query
description: Page number for pagination.
required: false
schema:
type: integer
example: 1
- name: pageSize
in: query
description: Number of results per page.
required: false
schema:
type: integer
example: 10
- name: sort
in: query
description: Sort results by specific field (e.g., -copiers).
required: false
schema:
type: string
example: -copiers
- name: popularInvestor
in: query
description: Filter for popular investors.
required: false
schema:
type: boolean
- name: gainMax
in: query
description: Max gain value filter.
required: false
schema:
type: integer
example: 100
- name: maxDailyRiskScoreMin
in: query
description: Minimum daily risk score.
required: false
schema:
type: integer
example: 1
- name: maxDailyRiskScoreMax
in: query
description: Maximum daily risk score.
required: false
schema:
type: integer
example: 7
- name: maxMonthlyRiskScoreMin
in: query
description: Minimum monthly risk score.
required: false
schema:
type: integer
example: 1
- name: maxMonthlyRiskScoreMax
in: query
description: Maximum monthly risk score.
required: false
schema:
type: integer
example: 6
- name: weeksSinceRegistrationMin
in: query
description: Minimum weeks since registration.
required: false
schema:
type: integer
example: 75
- name: countryId
in: query
description: The registered country ID of the user
required: false
schema:
type: integer
example: 101
- name: instrumentId
in: query
description: The instrument ID (you can also use this to exclude an instrument e.g., -5).
required: false
schema:
type: integer
example: -5
- name: instrumentPctMin
in: query
description: Minimum percentage of investment in the requested instrument ID.
required: false
schema:
type: integer
example: 100
- name: instrumentPctMax
in: query
description: Maximum percentage of investment in the requested instrument ID.
required: false
schema:
type: integer
example: 100
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
totalItems:
type: integer
items:
type: array
items:
type: object
properties:
customerId:
type: integer
userName:
type: string
fullName:
type: string
hasAvatar:
type: boolean
isSocialConnected:
type: boolean
isTestAccount:
type: boolean
displayFullName:
type: boolean
bonusOnly:
type: boolean
blocked:
type: boolean
verified:
type: boolean
popularInvestor:
type: boolean
copyBlock:
type: boolean
isFund:
type: boolean
isBronze:
type: boolean
fundType:
type: integer
tags:
type: array
items:
type: integer
gain:
type: number
format: float
dailyGain:
type: number
format: float
thisWeekGain:
type: number
format: float
riskScore:
type: integer
maxDailyRiskScore:
type: integer
maxMonthlyRiskScore:
type: integer
copiers:
type: integer
copiedTrades:
type: integer
copyTradesPct:
type: number
format: float
copyInvestmentPct:
type: number
format: float
baseLineCopiers:
type: integer
copiersGain:
type: number
format: float
aumTier:
type: integer
aumTierV2:
type: integer
aumTierDesc:
type: string
nullable: true
virtualCopiers:
type: integer
trades:
type: integer
winRatio:
type: number
format: float
dailyDd:
type: number
format: float
weeklyDd:
type: number
format: float
profitableWeeksPct:
type: number
format: float
profitableMonthsPct:
type: number
format: float
velocity:
type: number
format: float
exposure:
type: number
format: float
avgPosSize:
type: number
format: float
optimalCopyPosSize:
type: number
format: float
highLeveragePct:
type: number
format: float
mediumLeveragePct:
type: number
format: float
lowLeveragePct:
type: number
format: float
peakToValley:
type: number
format: float
peakToValleyStart:
type: string
format: date-time
peakToValleyEnd:
type: string
format: date-time
longPosPct:
type: number
format: float
topTradedInstrumentId:
type: integer
topTradedAssetClassId:
type: integer
topTradedInstrumentPct:
type: number
format: float
totalTradedInstruments:
type: integer
activeWeeks:
type: integer
firstActivity:
type: integer
description: Number of days since the beginning of the interval of a user's first trading activity
lastActivity:
type: integer
description: Number of days from the last trading activity till the end of the interval
activeWeeksPct:
type: number
format: float
weeksSinceRegistration:
type: integer
country:
type: string
affiliateId:
type: integer
instrumentPct:
type: number
format: float
countryId:
type: integer
description: The registered country ID of the user
isPopularInvestor:
type: boolean
description: Indicates if the user is a popular investor
topTradedAssetId:
type: integer
description: Top traded asset class ID in this interval
required:
- totalItems
- items
operationId: comprehensiveSearchAnalyticsEngineUserDiscovery
/api/v1/user-info/people/{username}/daily-gain:
get:
tags:
- Users Info
summary: Retrieve granular performance data for specific time periods
description: Provides detailed performance analytics including daily gains, cumulative returns, and period-specific metrics within a specified date range. Supports various time-based analyses and performance reporting requirements.
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: f3fcbba2-53b9-46bb-87c2-5c5ec4ef4ee1
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: username
in: path
description: Unique identifier of the user whose performance data is being requested
schema:
type: string
required: true
example: trader123
- name: minDate
in: query
description: Start date for the analysis period (inclusive) in YYYY-MM-DD format
schema:
type: string
format: date
required: true
example: '2024-01-01'
- name: maxDate
in: query
description: End date for the analysis period (inclusive) in YYYY-MM-DD format
schema:
type: string
format: date
required: true
example: '2024-12-31'
- name: type
in: query
description: 'Specifies the granularity of the performance data: ''Daily'' for day-by-day metrics or ''Period'' for aggregated period statistics'
schema:
type: string
enum:
- Daily
- Period
required: true
example: Daily
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getUserDailyGainResponse'
examples:
dailyExample:
summary: Daily Gains Example
value:
- timestamp: '2023-01-01T00:00:00Z'
gain: 0.0
- timestamp: '2023-01-02T00:00:00Z'
gain: 0.14
- timestamp: '2023-01-03T00:00:00Z'
gain: -0.26
- timestamp: '2023-01-04T00:00:00Z'
gain: 0.68
periodExample:
summary: Period Gain Example
value:
gain: 7.52
operationId: retrieveGranularPerformanceDataSpecificTime
/api/v1/user-info/people/{username}/gain:
get:
tags:
- Users Info
summary: Retrieve detailed historical performance metrics and analytics for a specified user
description: Returns comprehensive historical monthly and yearly performance data including gain percentages, risk-adjusted returns, and detailed trading statistics. This endpoint provides both aggregated and time-series performance metrics.
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: a0f00368-7db0-4174-ad86-4cd6d313d7d3
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: username
description: Unique identifier of the user whose performance metrics are being requested
in: path
schema:
type: string
required: true
example: trader123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getUserGainResponse'
operationId: retrieveDetailedHistoricalPerformanceMetricsAnalytics
/api/v1/user-info/people/{username}/portfolio/live:
get:
tags:
- Users Info
summary: Get the live portfolio of a user
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 6adb70f2-6c01-47a0-8775-0c289ac3fe7a
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: username
description: The username of the user to retrieve the live portfolio for.
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
realizedCreditPct:
type: number
format: decimal
description: Credit as a percentage of the realized credit
unrealizedCreditPct:
type: number
format: decimal
description: Credit as a percentage of the unrealized credit
positions:
type: array
items:
type: object
properties:
positionId:
type: integer
description: Position ID
openTimestamp:
type: string
format: date-time
description: Open Timestamp
openRate:
type: number
format: decimal
description: Open Rate
instrumentId:
type: integer
description: Instrument ID
isBuy:
type: boolean
description: Buy/Sell
leverage:
type: integer
description: Leverage
takeProfitRate:
type: number
format: decimal
description: Take Profit
stopLossRate:
type: number
format: decimal
description: Stop Loss
socialTradeId:
type: integer
description: Mirror ID
parentPositionId:
type: integer
description: Parent Position ID
investmentPct:
type: number
format: decimal
description: Realized Investment
netProfit:
type: number
format: decimal
description: Profit Percentage
trailingStopLoss:
type: boolean
description: Trailing Stop loss enabled
socialTrades:
type: array
items:
type: object
properties:
socialTradeId:
type: integer
description: Internal Mirror ID
parentUsername:
type: string
description: Parent Username
stopLossPercentage:
type: number
format: decimal
description: Stop Loss
openTimestamp:
type: string
format: date-time
description: Opening Timestamp
investmentPct:
type: number
format: decimal
description: Investment Pct
openInvestmentPct:
type: number
format: decimal
description: Open Trades in Mirror
netProfit:
type: number
format: decimal
description: Profit Pct
openNetProfit:
type: number
format: decimal
description: Net profit of opened trades
closedNetProfit:
type: number
format: decimal
description: Net profit of closed trades
realizedPct:
type: number
format: decimal
description: Live Realized percentage
unrealizedPct:
type: number
format: decimal
description: Unrealized
isClosing:
type: boolean
description: Pending Close
positions:
type: array
items:
type: object
properties:
positionId:
type: integer
description: Position ID
openTimestamp:
type: string
format: date-time
description: Open Timestamp
openRate:
type: number
format: decimal
description: Open Rate
instrumentId:
type: integer
description: Instrument ID
isBuy:
type: boolean
description: Buy/Sell
leverage:
type: integer
description: Leverage
takeProfitRate:
type: number
format: decimal
description: Take Profit
stopLossRate:
type: number
format: decimal
description: Stop Loss
socialTradeId:
type: integer
description: Mirror ID
parentPositionId:
type: integer
description: Parent Position ID
investmentPct:
type: number
format: decimal
description: Realized Investment
netProfit:
type: number
format: decimal
description: Profit Percentage
trailingStopLoss:
type: boolean
description: Trailing Stop loss enabled
operationId: getLivePortfolioUser
/api/v1/user-info/people/{username}/tradeinfo:
get:
tags:
- Users Info
summary: Get trade info for a specific user
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 93d6c631-4763-45fc-9eca-9b15c40773c0
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: username
description: The username of the user to retrieve the discovery info for.
in: path
schema:
type: string
required: true
- name: period
in: query
description: The period filter (e.g., LastTwoYears).
required: true
schema:
type: string
enum:
- CurrMonth
- CurrQuarter
- CurrYear
- LastYear
- LastTwoYears
- OneMonthAgo
- TwoMonthsAgo
- ThreeMonthsAgo
- SixMonthsAgo
- OneYearAgo
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
userName:
type: string
description: The username of the customer
fullName:
type: string
description: Full name of the customer
weeksSinceRegistration:
type: integer
description: Number of weeks since registration
countryId:
type: integer
description: The registered country ID of the user
affiliateId:
type: integer
description: The affiliate ID of t
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/etoro/refs/heads/main/openapi/etoro-users-info-api-openapi.yml