Skip to main content
GET
Get instrument breakdown

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"b345f9a4-c63f-4d47-9617-458b5b21cedf"

CID
integer<int32>
required

Client identifier.

Query Parameters

conversionMode
enum<string>
default:eToroApp

Conversion to use for non-USD assets when the market is closed. 'eToroApp' uses the last conversion at market close; 'Realtime' uses the realtime conversion.

Available options:
eToroApp,
Realtime
positionLevel
enum<string>
default:Normal

Level of position data to return. 'Normal' returns position-level data; 'None' omits it.

Available options:
None,
Normal
orderLevel
enum<string>
default:Normal

Level of order data to return. 'Normal' returns order-level data; 'None' omits it.

Available options:
None,
Normal
mirrorLevel
enum<string>
default:None

Level of mirror data to return. 'None' returns only the manual part of the portfolio; 'Details' includes position/order-level data inside mirrors.

Available options:
None,
Details
instrumentIds
integer<int32>[]

Filter by instrument IDs. Default: all instruments. Maximum 100 IDs.

Maximum array length: 100
mirrorIds
integer<int32>[]

Filter by mirror IDs. MirrorId=0 means the manual part of the portfolio. When mirrorLevel=None the default is manual only ([0]); otherwise the default is all mirrors and manual. Maximum 100 IDs.

Maximum array length: 100

Response

Portfolio instrument breakdown.

accountCurrency
string

ISO 4217 code (uppercase) of the account's base currency, e.g. 'USD'.

timestamp
string<date-time>

Time when the portfolio snapshot was generated (UTC).

instruments
object[]

Manually held (non copy-trading) positions/orders, grouped by instrument.

mirrors
object[]

Copy-trading mirrors. Empty unless mirrorLevel=details.