GetCopyTradeMasterFollowersByFilter¶
Endpoint¶
GET /copytrade/master/followers
Authorization¶
Requires an authenticated session. The endpoint is public for authorized users, but only for copy masters that explicitly enabled follower display.
Description¶
Returns a table of followers subscribed to the requested copy master account.
The request must include login. The server verifies that this login belongs to
a copy trading master and that the master has show_followers = 1. If the
master is disabled or did not allow follower display, the endpoint returns 403.
The response exposes limited follower data only:
- follower login;
- masked follower email;
- subscription time and state;
- number of copied trade links;
- realized PNL from closed copied market trades under this master;
- copied volume from linked follower orders.
Private account fields such as full email, name, group, phone and comments are not returned.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
login |
int | Yes | Copy master account login |
limit |
int | Yes | Page size. Maximum 50000 |
offset |
int | Yes | Page offset |
where |
array | No | Standard where filters |
whereNot |
array | No | Standard negative filters |
whereIn |
array | No | Standard include-by-list filters |
whereNotIn |
array | No | Standard exclude-by-list filters |
whereBetween |
array | No | Standard range filters |
whereNotBetween |
array | No | Standard negative range filters |
orderBy |
array | No | Sort definition |
Available Fields¶
The same field list is used for response columns, filtering and sorting.
| Field | Type | Description |
|---|---|---|
subscription_id |
int | Subscription id |
id |
int | Alias for subscription_id in filters |
master_login |
int | Master account login |
follower_login |
int | Follower account login |
follower_email |
string | Masked follower email |
subscribed_time |
int64 | Subscription creation time |
status |
int | Subscription status |
enabled |
int | Subscription enabled flag |
copied_trades |
int | Number of copied trade links under this subscription |
pnl |
number | Realized net PNL from closed copied market trades under this master |
volume |
int | Total copied follower-order volume from linked trades |
PNL Calculation¶
pnl is calculated only from follower trades connected to this master through
copy trade links. The server sums closed market follower orders as:
profit + commission + storage
The value does not include unrelated follower account trades.
Request Example¶
{
"login": 100001,
"where": [
["pnl", ">", 0]
],
"orderBy": ["pnl", "desc"],
"limit": 50,
"offset": 0
}
Response¶
{
"structure": [
"subscription_id",
"master_login",
"follower_login",
"follower_email",
"subscribed_time",
"status",
"enabled",
"copied_trades",
"pnl",
"volume"
],
"rows": [
[
501,
100001,
200045,
"jo***@example.com",
1778160000,
0,
1,
14,
245.75,
1400
]
],
"count": 1
}
Rows follow the order defined in structure.
Errors¶
| HTTP | Error | Description |
|---|---|---|
400 |
INVALID_DATA |
Request validation failed or a private field was used in filter/sort |
403 |
FOLLOWERS_NOT_PUBLIC |
Master is disabled or did not allow public follower display |
404 |
MASTER_NOT_FOUND |
login is not a copy trading master |