API reference · v5

Gate Copy Trading API

Gate futures copy trading: rankings, profiles, performance, open positions, closed positions with fees and funding, fills and transfers.

Base URL https://api.kopyon.com/v5/gate-copy-trading/ · send your key in the X-API-KEY header · trader id: The numeric leader id in a lead trader's Gate URL.

Get a free API key · Interactive reference with Try it · Authentication, paging and errors

Traders

GET /v5/gate-copy-trading/traders

Gate's futures lead traders who are leading now, and their figures over a period.

Query parameters

Name	Type	Description
`period`required	enum	Days the figures cover7D, 30D
`sortBy`	enumdefault copierPnl	What to rank by, highest firstcopierPnl, roi, pnl, aum, sharpeRatio, copiers
`page`	intdefault 1	Page number
`rows`	intdefault 20	Rows per page1 to 50

Response fields, in `data`

Field	Type	Description
`traders[]`always	array
`traders[].traderId`always	string	The trader's id at the source; other operations take it as traderId
`traders[].name`always	string	Display name
`traders[].avatarUrl`	string
`traders[].roi`	number
`traders[].pnl`	number
`traders[].sourceDetails.daysActive`	only Gate
`traders[].sourceDetails.trades`	only Gate
`traders[].aum`	number
`traders[].maxDrawdown`	number
`traders[].winRate`	number
`traders[].copierPnl`	number
`traders[].sharpeRatio`	number
`traders[].copiers`	number	Current copiers
`traders[].maxCopiers`	number
`hasMore`always	boolean	true when another page follows
`total`always	number

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/traders?period=7D"

{
  "data": {
    "traders": [
      {
        "traderId": "34331",
        "name": "Humble Cooperation",
        "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-b3cddbf2c4-2f9baee1ee-c92a10-d3d944.jpg",
        "roi": 0.6176,
        "pnl": 1082.66,
        "winRate": 0.9148,
        "maxDrawdown": 0.1459,
        "copierPnl": 17809.79,
        "aum": 93835.15,
        "sharpeRatio": 7.31,
        "copiers": 167,
        "maxCopiers": 250,
        "sourceDetails": {
          "daysActive": 24,
          "trades": 47
        }
      },
      {
        "traderId": "30629",
        "name": "This is translate content : Very fierce and aggressive",
        "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-aa0f0627ec-1aba4f8ed9-c92a10-faeac4",
        "roi": 0.2887,
        "pnl": 2160.46,
        "winRate": 0.9523,
        "maxDrawdown": 0.0566,
        "copierPnl": 11861.69,
        "aum": 56982.68,
        "sharpeRatio": 7.86,
        "copiers": 20,
        "maxCopiers": 250,
        "sourceDetails": {
          "daysActive": 125,
          "trades": 105
        }
      },
      {
        "traderId": "29274",
        "name": "Moving into 2027",
        "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-153a1ea322-84e75ce57a-c92a10-0a8005.jpg",
        "roi": 0.0483,
        "pnl": 244.41,
        "winRate": 0.5,
        "maxDrawdown": 0,
        "copierPnl": 8865.1,
        "aum": 464305.4,
        "sharpeRatio": 8.78,
        "copiers": 11,
        "maxCopiers": 1000,
        "sourceDetails": {
          "daysActive": 151,
          "trades": 6
        }
      }
    ],
    "hasMore": true,
    "total": 180
  }
}

Search traders

GET /v5/gate-copy-trading/traderSearch

Every lead trader whose name contains this, leading now or not, in Gate's order, with 30-day figures.

Query parameters

Name	Type	Description
`name`required	string	Part of the trader's name
`page`	intdefault 1	Page number
`rows`	intdefault 20	Rows per page1 to 50

Response fields, in `data`

Field	Type	Description
`traders[]`always	array
`traders[].traderId`always	string	The trader's id at the source; other operations take it as traderId
`traders[].name`always	string	Display name
`traders[].avatarUrl`	string
`traders[].roi`	number
`traders[].pnl`	number
`traders[].sourceDetails.daysActive`	only Gate
`traders[].sourceDetails.trades`	only Gate
`traders[].aum`	number
`traders[].maxDrawdown`	number
`traders[].winRate`	number
`traders[].copierPnl`	number
`traders[].sharpeRatio`	number
`traders[].copiers`	number	Current copiers
`traders[].maxCopiers`	number
`hasMore`always	boolean	true when another page follows
`total`always	number

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/traderSearch?name=Humb"

{
  "data": {
    "traders": [
      {
        "traderId": "34331",
        "name": "Humble Cooperation",
        "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-b3cddbf2c4-2f9baee1ee-c92a10-d3d944.jpg",
        "roi": 2.622,
        "pnl": 2782.71,
        "winRate": 0.9707,
        "maxDrawdown": 0.0953,
        "copierPnl": 23814.37,
        "aum": 93835.15,
        "sharpeRatio": 8.19,
        "copiers": 167,
        "maxCopiers": 250,
        "sourceDetails": {
          "daysActive": 24,
          "trades": 205
        }
      },
      {
        "traderId": "25465",
        "name": "Stay humble and patient; unify knowledge and action.",
        "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-4e54cacb66-4dbcdc494a-c92a10-a2ef40.jpeg",
        "roi": 0.5066,
        "pnl": 1935.89,
        "winRate": 0.3333,
        "maxDrawdown": 0.1186,
        "copierPnl": 0,
        "aum": 0,
        "sharpeRatio": 3.51,
        "copiers": 0,
        "maxCopiers": 50,
        "sourceDetails": {
          "daysActive": 234,
          "trades": 15
        }
      },
      {
        "traderId": "31816",
        "name": "Determined to rise from humble beginnings",
        "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-d4f001d97d-3fc1da541e-c92a10-d72d18.jpg",
        "roi": 0.0058,
        "pnl": 1613.46,
        "winRate": 1,
        "maxDrawdown": 0.0148,
        "copierPnl": 0,
        "aum": 0,
        "sharpeRatio": 3.48,
        "copiers": 0,
        "maxCopiers": 50,
        "sourceDetails": {
          "daysActive": 96,
          "trades": 16
        }
      }
    ],
    "hasMore": false,
    "total": 7
  }
}

Trader profile

GET /v5/gate-copy-trading/traderProfile

The trader's name, bio, copiers, profit share and copiers' assets.

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders

Response fields, in `data`

Field	Type	Description
`traderId`always	string
`name`	string
`avatarUrl`	string
`bio`	string
`sourceDetails.daysActive`	only Gate
`sourceDetails.minCopyAmount`	only Gate
`sourceDetails.positionsHidden`	only Gate
`copiers`	number
`maxCopiers`	number
`totalCopiers`	number
`aum`	number
`profitShare`	number

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/traderProfile?traderId=34331"

{
  "data": {
    "traderId": "34331",
    "name": "Humble Cooperation",
    "avatarUrl": "https://gavatar.staticimgs.com/groupchat/avatar-b3cddbf2c4-2f9baee1ee-c92a10-d3d944.jpg",
    "bio": "Trading is unpredictable; the victorious general endures, those who can't, exit.",
    "copiers": 167,
    "maxCopiers": 250,
    "totalCopiers": 606,
    "profitShare": 0.1,
    "aum": 93835.15,
    "sourceDetails": {
      "daysActive": 24,
      "minCopyAmount": 50,
      "positionsHidden": true
    }
  }
}

Performance

GET /v5/gate-copy-trading/performance

Return, PnL, drawdown, win rate, Sharpe ratio, trades and what copiers made over a period.

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders
`period`required	enum	Days the figures cover7D, 30D, 90D

Response fields, in `data`

Field	Type	Description
`period`always	string
`roi`	number
`pnl`	number
`maxDrawdown`	number
`copierPnl`	number
`winRate`	number
`wins`	number
`trades`	number
`sharpeRatio`	number
`losses`	number

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/performance?traderId=34331&period=7D"

{
  "data": {
    "period": "7D",
    "roi": 0.6176,
    "pnl": 1082.66,
    "maxDrawdown": 0.1459,
    "winRate": 0.9148,
    "sharpeRatio": 7.31,
    "copierPnl": 17809.79,
    "trades": 47,
    "wins": 43,
    "losses": 4
  }
}

Chart

GET /v5/gate-copy-trading/traderChart

Cumulative ROI or PnL over the period, one point a day, oldest first.

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders
`period`required	enum	Days the figures cover7D, 30D
`metric`	enumdefault ROI	ROI as a fraction, or PnL in USDTROI, PNL

Response fields, in `data`

Field	Type	Description
`metric`always	string	What the points measure: ROI, PNL or BALANCE
`points[]`always	array
`points[].timestamp`always	number	Point time, in Unix milliseconds
`points[].value`always	number

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/traderChart?traderId=34331&period=7D"

{
  "data": {
    "metric": "ROI",
    "points": [
      {
        "timestamp": 1791763200000,
        "value": 0
      },
      {
        "timestamp": 1791849600000,
        "value": 0.2887
      },
      {
        "timestamp": 1791936000000,
        "value": 0.1236
      }
    ]
  }
}

Open positions

GET /v5/gate-copy-trading/openPositions

The trader's open positions, sizes in the base asset. A trader can hide them; then positions is empty and hidden is true.

Gate refreshes this Gate updates these positions within about a second..

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders

Response fields, in `data`

Field	Type	Description
`positions[]`always	array
`positions[].symbol`always	string
`positions[].side`always	LONG \| SHORT
`positions[].size`	number	Position size, always positive; side gives the direction
`positions[].entryPrice`always	number
`positions[].markPrice`	number	The exchange's mark price
`positions[].leverage`	number
`positions[].marginMode`	ISOLATED \| CROSS
`positions[].unrealizedPnl`	number	In pnlCurrency
`positions[].pnlCurrency`	string
`positions[].liquidationPrice`	number
`positions[].margin`	number	Margin the position uses, in pnlCurrency
`positions[].roi`	number	unrealizedPnl over margin, as a fraction. Where the exchange sends its own (KuCoin; BingX, over the opening margin), it is passed on and can differ from that ratio
`positions[].openedAt`	number
`positions[].fundingPnl`	number
`positions[].tradingFee`	number	Fee paid to open, as a positive cost
`hidden`always	boolean	true when the trader hides positions

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/openPositions?traderId=34837"

{
  "data": {
    "positions": [],
    "hidden": true
  }
}

Position history

GET /v5/gate-copy-trading/positionHistory

The trader's closed positions, newest first, with gross PnL, funding, fees and Gate's net PnL. Gate rounds each to the cent.

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders
`cursor`	string	The nextCursor of the previous answer; leave it out for the first page
`rows`	intdefault 20	Rows per page1 to 50

Response fields, in `data`

Field	Type	Description
`positions[]`always	array
`positions[].positionId`	string
`positions[].symbol`always	string
`positions[].side`	LONG \| SHORT
`positions[].status`	string
`positions[].marginMode`	ISOLATED \| CROSS
`positions[].leverage`	number
`positions[].roi`	number
`positions[].entryPrice`	number
`positions[].closePrice`	number
`positions[].openedAt`always	number	When the position opened, in Unix milliseconds
`positions[].closedAt`	number	When the position closed, in Unix milliseconds
`positions[].updatedAt`always	number	Last change, in Unix milliseconds
`positions[].openedVolume`	number
`positions[].closedVolume`	number
`positions[].maxOpenInterest`	number
`positions[].grossPnl`	number
`positions[].fundingPnl`	number
`positions[].tradingFee`	number
`positions[].liquidationFee`	number
`positions[].netPnl`	number
`positions[].pnlCurrency`	string
`positions[].sourceDetails.dividend`	only Gate
`positions[].margin`	number
`nextCursor`	string	Send it back as cursor, with the same query, to read the next page; absent on the last page

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/positionHistory?traderId=34331"

{
  "data": {
    "positions": [
      {
        "positionId": "22492231",
        "symbol": "BTCUSDT",
        "side": "LONG",
        "marginMode": "ISOLATED",
        "leverage": 200,
        "roi": -1.0167,
        "entryPrice": 81500,
        "closePrice": 81092.2,
        "openedAt": 1792239670000,
        "closedAt": 1792252370000,
        "updatedAt": 1792252370000,
        "closedVolume": 0.0283,
        "maxOpenInterest": 0.0283,
        "grossPnl": -11.54,
        "fundingPnl": 0,
        "tradingFee": 1.95,
        "netPnl": -13.49,
        "pnlCurrency": "USDT",
        "margin": 13.27,
        "sourceDetails": {
          "dividend": 0
        }
      },
      {
        "positionId": "22476417",
        "symbol": "ZECUSDT",
        "side": "LONG",
        "marginMode": "CROSS",
        "leverage": 75,
        "roi": 0.3347,
        "entryPrice": 1220,
        "closePrice": 1226,
        "openedAt": 1792161655000,
        "closedAt": 1792162079000,
        "updatedAt": 1792162079000,
        "closedVolume": 0.55,
        "maxOpenInterest": 0.55,
        "grossPnl": 3.3,
        "fundingPnl": 0,
        "tradingFee": 0.13,
        "netPnl": 3.16,
        "pnlCurrency": "USDT",
        "margin": 9.45,
        "sourceDetails": {
          "dividend": 0
        }
      },
      {
        "positionId": "22476082",
        "symbol": "ZECUSDT",
        "side": "LONG",
        "marginMode": "CROSS",
        "leverage": 75,
        "roi": 0.1528,
        "entryPrice": 1223.91,
        "closePrice": 1227.04,
        "openedAt": 1792152115000,
        "closedAt": 1792161335000,
        "updatedAt": 1792161335000,
        "closedVolume": 1.09,
        "maxOpenInterest": 1.09,
        "grossPnl": 3.4,
        "fundingPnl": 0,
        "tradingFee": 0.53,
        "netPnl": 2.87,
        "pnlCurrency": "USDT",
        "margin": 18.8,
        "sourceDetails": {
          "dividend": 0
        }
      }
    ],
    "nextCursor": "YzFiZGE5ODcwMjk4YTViMC4y"
  }
}

Order history

GET /v5/gate-copy-trading/orderHistory

The trader's filled orders, newest first.

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders
`cursor`	string	The nextCursor of the previous answer; leave it out for the first page
`rows`	intdefault 20	Rows per page1 to 50

Response fields, in `data`

Field	Type	Description
`orders[]`always	array
`orders[].symbol`always	string
`orders[].side`always	string
`orders[].price`	number
`orders[].quantity`	number
`orders[].updatedAt`always	number	Last change, in Unix milliseconds
`nextCursor`	string	Send it back as cursor, with the same query, to read the next page; absent on the last page

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/orderHistory?traderId=34331"

{
  "data": {
    "orders": [
      {
        "symbol": "ZECUSDT",
        "side": "BUY",
        "price": 1088,
        "quantity": 3.4,
        "updatedAt": 1792333906000
      },
      {
        "symbol": "ZECUSDT",
        "side": "BUY",
        "price": 1109,
        "quantity": 0.38,
        "updatedAt": 1792273059000
      },
      {
        "symbol": "ZECUSDT",
        "side": "BUY",
        "price": 1109,
        "quantity": 0.2,
        "updatedAt": 1792273059000
      }
    ],
    "nextCursor": "MmMxMTcwNzdkODI0ZGJjNC4y"
  }
}

Transfer history

GET /v5/gate-copy-trading/transferHistory

Money moved into and out of the lead account, newest first.

Query parameters

Name	Type	Description
`traderId`required	string	The lead trader's id, from traders
`cursor`	string	The nextCursor of the previous answer; leave it out for the first page
`rows`	intdefault 20	Rows per page1 to 50

Response fields, in `data`

Field	Type	Description
`transfers[]`always	array
`transfers[].time`always	number	In Unix milliseconds
`transfers[].amount`always	number
`transfers[].type`always	deposit \| withdraw \| transfer \| vaultDeposit \| vaultWithdraw \| commission \| other	deposit and withdraw move the owner's money into or out of the account; transfer, to or from another address; vaultDeposit and vaultWithdraw, into or out of a vault; commission is a vault leader's share; other is a kind none of these fits, named in sourceDetails.type
`nextCursor`	string	Send it back as cursor, with the same query, to read the next page; absent on the last page

Example

curl -H "X-API-KEY: $KOPYON_KEY" \
  "https://api.kopyon.com/v5/gate-copy-trading/transferHistory?traderId=34331"

{
  "data": {
    "transfers": [
      {
        "time": 1792086411000,
        "amount": -1400,
        "type": "withdraw"
      },
      {
        "time": 1791387578000,
        "amount": -1300,
        "type": "withdraw"
      },
      {
        "time": 1790534219000,
        "amount": 61.28309231,
        "type": "deposit"
      }
    ]
  }
}

Stream and webhooks

Paid plans can follow a trader in real time over wss://api.kopyon.com/v5/streamor through signed webhooks. Topics for this source:

openPositions: Open positions, whenever they change
positionEvents: Opened, increased, decreased, closed
orderHistory: New and updated orders
positionHistory: Newly closed positions

Stream messages and webhook signatures

Gate Copy Trading API

Traders

Query parameters

Response fields, in data

Example

Search traders

Query parameters

Response fields, in data

Example

Trader profile

Query parameters

Response fields, in data

Example

Performance

Query parameters

Response fields, in data

Example

Chart

Query parameters

Response fields, in data

Example

Open positions

Query parameters

Response fields, in data

Example

Position history

Query parameters

Response fields, in data

Example

Order history

Query parameters

Response fields, in data

Example

Transfer history

Query parameters

Response fields, in data

Example

Stream and webhooks

Try the Gate Copy Trading API for free.

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`

Response fields, in `data`