v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Users Info

Get user trade info

Rate limit: 60 requests per 60 seconds. This is a dedicated limit for this endpoint — it is not shared with (pooled across) any other endpoint, so the full rate is available to this endpoint alone.

get/api/v1/user-info/people/{username}/tradeinfo

Path parameters

usernamestring required

The username of the user to retrieve the discovery info for.

Query parameters

period'CurrMonth' | 'CurrQuarter' | 'CurrYear' | 'LastYear' | 'LastTwoYears' | 'OneMonthAgo' | 'TwoMonthsAgo' | 'ThreeMonthsAgo' | 'SixMonthsAgo' | 'OneYearAgo' required

The period filter (e.g., LastTwoYears).

Headers

x-request-idstring uuid required
Example:38d9aa67-37be-46c1-b969-fda6eda2b387

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

OK

userNamestring

The username of the customer

fullNamestring

Full name of the customer

weeksSinceRegistrationinteger

Number of weeks since registration

countryIdinteger

The registered country ID of the user

affiliateIdinteger

The affiliate ID of the user

isPopularInvestorboolean

Is the customer a popular investor

isFundboolean

Does this customer represent a fund

hasAvatarboolean

Does the customer have a picture

gainnumber float

The periodic gain of the user

dailyGainnumber float

The user's last day gain

thisWeekGainnumber float

The user's gain from the beginning of the trading week

riskScoreinteger

The current risk score of the user

maxDailyRiskScoreinteger

The maximum daily risk score of the user in this interval

maxMonthlyRiskScoreinteger

The maximum monthly risk score of the user in this interval

copiersinteger

The current number of copiers of this user

copiedTradesinteger

The total number of copied trades in this interval

copyTradesPctnumber float

The percentage of copied trades in this interval of all trades

copyInvestmentPctnumber float

The percentage of invested amounts in copied trades in this interval of all investments

baseLineCopiersinteger

The number of copiers one week ago

copiersGainnumber float

The gain percentage of the number of copiers in a week

aumTierinteger

The total assets under management of the user, in a scale of 0-4, where 4 is the highest tier

aumTierDescstring

Description of the AUM Tier

fundTypeinteger

Fund Type

virtualCopiersinteger

The total amount of virtual copiers of this user

tradesinteger

The total number of trades in this interval

topTradedInstrumentIdinteger

Top Traded Instrument ID in this interval

topTradedAssetIdinteger

Top Traded Asset ID in this interval

winRationumber float

The winning ratio of all closed trades in this interval

dailyDdnumber float

The maximum daily draw-down of the user in this interval

weeklyDdnumber float

The maximum weekly draw-down of this user in this interval

peakToValleynumber float

The peak to valley draw-down in this interval

profitableWeeksPctnumber float

The percentage of trading weeks which were profitable in this interval

profitableMonthsPctnumber float

The percentage of months which were profitable in this interval

avgPosSizenumber float

Average position size relative to the realized equity on opening the trade

highLeveragePctnumber float

High leverage trades percentage in this interval

mediumLeveragePctnumber float

Medium leverage trades percentage in this interval

lowLeveragePctnumber float

Low leverage trades percentage in this interval

firstActivityinteger

Number of days since the beginning of the interval of a user trading activity

lastActivityinteger

Number of days from the last trading activity till the end of the interval

activeWeeksPctnumber float

The percentage of weeks in the interval which the user had active trades

instrumentPctnumber float

Percentage of investment in the requested instrument ID