cloud.metaapi.sdk.clients.copy_factory

Class TradingClient

java.lang.Object

cloud.metaapi.sdk.clients.MetaApiClient

cloud.metaapi.sdk.clients.copy_factory.TradingClient

public class TradingClient
extends cloud.metaapi.sdk.clients.MetaApiClient

metaapi.cloud CopyFactory trading API (trade copying trading API) client (see https://metaapi.cloud/docs/copyfactory/)

Field Summary

Fields inherited from class cloud.metaapi.sdk.clients.MetaApiClient

host, httpClient, token

Constructor Summary

Constructors

Constructor and Description
TradingClient(cloud.metaapi.sdk.clients.HttpClient httpClient, String token) Constructs CopyFactory trading API client instance.
TradingClient(cloud.metaapi.sdk.clients.HttpClient httpClient, String token, String domain) Constructs CopyFactory trading API client instance

Method Summary

Modifier and Type	Method and Description
CompletableFuture<List<CopyFactoryStrategyStopout>>	getStopouts(String accountId) Returns subscriber account stopouts.
CompletableFuture<List<CopyFactoryUserLogRecord>>	getUserLog(String accountId) Returns copy trading user log for an account and time range.
CompletableFuture<List<CopyFactoryUserLogRecord>>	getUserLog(String accountId, cloud.metaapi.sdk.clients.models.IsoTime startTime, cloud.metaapi.sdk.clients.models.IsoTime endTime) Returns copy trading user log for an account and time range.
CompletableFuture<List<CopyFactoryUserLogRecord>>	getUserLog(String accountId, cloud.metaapi.sdk.clients.models.IsoTime startTime, cloud.metaapi.sdk.clients.models.IsoTime endTime, Integer offset, Integer limit) Returns copy trading user log for an account and time range.
CompletableFuture<Void>	resetStopouts(String accountId, String strategyId, String reason) Resets strategy stopouts.
CompletableFuture<Void>	resynchronize(String accountId, List<String> strategyIds) Resynchronizes the account.

Methods inherited from class cloud.metaapi.sdk.clients.MetaApiClient

getTokenType, handleNoAccessError, isNotAccountToken, isNotJwtToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TradingClient

public TradingClient(cloud.metaapi.sdk.clients.HttpClient httpClient,
                     String token)

Constructs CopyFactory trading API client instance. Domain is set to agiliumtrade.agiliumtrade.ai

Parameters:

httpClient - HTTP client

token - authorization token

TradingClient

public TradingClient(cloud.metaapi.sdk.clients.HttpClient httpClient,
                     String token,
                     String domain)

Constructs CopyFactory trading API client instance

Parameters:

httpClient - HTTP client

token - authorization token

domain - domain to connect to

Method Detail

resynchronize

public CompletableFuture<Void> resynchronize(String accountId,
                                             List<String> strategyIds)

Resynchronizes the account. See https://metaapi.cloud/docs/copyfactory/restApi/api/trading/resynchronize/

Parameters:

accountId - account id

strategyIds - optional array of strategy ids to recynchronize, or null. Default is to synchronize all strategies

Returns:

completable future which resolves when resynchronization is scheduled

getStopouts

public CompletableFuture<List<CopyFactoryStrategyStopout>> getStopouts(String accountId)

Returns subscriber account stopouts. See https://metaapi.cloud/docs/copyfactory/restApi/api/trading/getStopOuts/

Parameters:

accountId - account id

Returns:

completable future which resolves with stopouts found

resetStopouts

public CompletableFuture<Void> resetStopouts(String accountId,
                                             String strategyId,
                                             String reason)

Resets strategy stopouts. See https://metaapi.cloud/docs/copyfactory/restApi/api/trading/resetStopOuts/

Parameters:

accountId - account id

strategyId - strategy id

reason - stopout reason to reset. One of yearly-balance, monthly-balance, daily-balance, yearly-equity, monthly-equity, daily-equity, max-drawdown

Returns:

completable future which resolves when the stopouts are reset

getUserLog

public CompletableFuture<List<CopyFactoryUserLogRecord>> getUserLog(String accountId)

Returns copy trading user log for an account and time range. See https://metaapi.cloud/docs/copyfactory/restApi/api/trading/getUserLog/

Parameters:

accountId - account id

Returns:

completable future which resolves with log records found

getUserLog

public CompletableFuture<List<CopyFactoryUserLogRecord>> getUserLog(String accountId,
                                                                    cloud.metaapi.sdk.clients.models.IsoTime startTime,
                                                                    cloud.metaapi.sdk.clients.models.IsoTime endTime)

Returns copy trading user log for an account and time range. See https://metaapi.cloud/docs/copyfactory/restApi/api/trading/getUserLog/

Parameters:

accountId - account id

startTime - time to start loading data from, or null

endTime - time to stop loading data at, or null

Returns:

completable future which resolves with log records found

getUserLog

public CompletableFuture<List<CopyFactoryUserLogRecord>> getUserLog(String accountId,
                                                                    cloud.metaapi.sdk.clients.models.IsoTime startTime,
                                                                    cloud.metaapi.sdk.clients.models.IsoTime endTime,
                                                                    Integer offset,
                                                                    Integer limit)

Returns copy trading user log for an account and time range. See https://metaapi.cloud/docs/copyfactory/restApi/api/trading/getUserLog/

Parameters:

accountId - account id

startTime - time to start loading data from, or null

endTime - time to stop loading data at, or null

offset - pagination offset, or null. Default is 0

limit - pagination limit, or null. Default is 1000

Returns:

completable future which resolves with log records found