v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Identity

Get authenticated user profile

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.


Returns the profile of the currently authenticated user, including account identifiers (GCID, real and demo CIDs), profile fields from Scope Data API (username, name, player level, gender, language, date of birth, avatar URL), and the OAuth scopes granted to the current access token.

get/api/v1/me

Headers

x-request-idstring uuid required
Example:32067704-ab02-4653-b3cb-210349fb7ace

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

gcidinteger required

Global Customer ID - the unique identifier for the user across all eToro systems.

realCidinteger required

Real account Customer ID - the identifier for the user's real trading account.

demoCidinteger required

Demo account Customer ID - the identifier for the user's virtual/demo trading account.

usernamestring required

The user's unique username.

firstNamestring nullable

The user's first name.

middleNamestring nullable

The user's middle name.

lastNamestring nullable

The user's last name.

playerLevelinteger required

Player level. Possible values: 1 (Bronze), 2 (Platinum), 3 (Gold), 4 (Internal), 5 (Silver), 6 (PlatinumPlus), 7 (Diamond).

genderinteger required

Gender. Possible values: 0 (Unknown), 1 (Male), 2 (Female).

languageinteger required

Language ID (e.g. 1 = English, 2 = German).

dateOfBirthstring required

Date of birth.

avatarUrlstring nullable

Absolute URL of the user's profile avatar image.

scopesstring[] required

OAuth scopes granted to the authenticated token.