cloud.metaapi.sdk.clients.copy_factory

Class ConfigurationClient

java.lang.Object

cloud.metaapi.sdk.clients.MetaApiClient

cloud.metaapi.sdk.clients.copy_factory.ConfigurationClient

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

metaapi.cloud CopyFactory configuration API (trade copying configuration 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
ConfigurationClient(cloud.metaapi.sdk.clients.HttpClient httpClient, String token) Constructs CopyFactory configuration API client instance.
ConfigurationClient(cloud.metaapi.sdk.clients.HttpClient httpClient, String token, String domain) Constructs CopyFactory configuration API client instance

Method Summary

Modifier and Type	Method and Description
String	generateAccountId() Generates random account id
CompletableFuture<StrategyId>	generateStrategyId() Retrieves new unused strategy id.
CompletableFuture<CopyFactoryAccount>	getAccount(String accountId) Retrieves CopyFactory copy trading account by id.
CompletableFuture<List<CopyFactoryAccount>>	getAccounts() Retrieves CopyFactory copy trading accounts.
CompletableFuture<List<ResynchronizationTask>>	getActiveResynchronizationTasks(String connectionId) Returns list of active resynchronization tasks for a specified connection.
CompletableFuture<List<CopyFactoryPortfolioStrategy>>	getPortfolioStrategies() Retrieves CopyFactory copy portfolio strategies.
CompletableFuture<CopyFactoryPortfolioStrategy>	getPortfolioStrategy(String portfolioId) Retrieves CopyFactory copy portfolio strategy by id.
CompletableFuture<List<CopyFactoryStrategy>>	getStrategies() Retrieves CopyFactory copy trading strategies.
CompletableFuture<CopyFactoryStrategy>	getStrategy(String strategyId) Retrieves CopyFactory copy trading strategy by id.
CompletableFuture<Void>	removeAccount(String id) Deletes a CopyFactory trade copying account.
CompletableFuture<Void>	removePortfolioStrategy(String id) Deletes a CopyFactory portfolio strategy.
CompletableFuture<Void>	removeStrategy(String id) Deletes a CopyFactory strategy.
CompletableFuture<Void>	updateAccount(String id, CopyFactoryAccountUpdate account) Updates a CopyFactory trade copying account.
CompletableFuture<Void>	updatePortfolioStrategy(String id, CopyFactoryPortfolioStrategyUpdate strategy) Updates a CopyFactory portfolio strategy.
CompletableFuture<Void>	updateStrategy(String id, CopyFactoryStrategyUpdate strategy) Updates a CopyFactory strategy.
CompletableFuture<Void>	waitResynchronizationTasksCompleted(String connectionId) Waits until active resynchronization tasks are completed with default timeout and reloading interval.
CompletableFuture<Void>	waitResynchronizationTasksCompleted(String connectionId, Integer timeoutInSeconds, Integer intervalInMilliseconds) Waits until active resynchronization tasks are completed.

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

ConfigurationClient

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

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

Parameters:

httpClient - HTTP client

token - authorization token

ConfigurationClient

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

Constructs CopyFactory configuration API client instance

Parameters:

httpClient - HTTP client

token - authorization token

domain - domain to connect to

Method Detail

generateStrategyId

public CompletableFuture<StrategyId> generateStrategyId()

Retrieves new unused strategy id. Method is accessible only with API access token. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/generateStrategyId/

Returns:

completable future resolving with strategy id generated

generateAccountId

public String generateAccountId()

Generates random account id

Returns:

account id

getAccounts

public CompletableFuture<List<CopyFactoryAccount>> getAccounts()

Retrieves CopyFactory copy trading accounts. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getAccounts/

Returns:

completable future resolving with CopyFactory accounts found

getAccount

public CompletableFuture<CopyFactoryAccount> getAccount(String accountId)

Retrieves CopyFactory copy trading account by id. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getAccount/

Parameters:

accountId - CopyFactory account id

Returns:

completable future resolving with CopyFactory account found

updateAccount

public CompletableFuture<Void> updateAccount(String id,
                                             CopyFactoryAccountUpdate account)

Updates a CopyFactory trade copying account. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/updateAccount/

Parameters:

id - copy trading account id

account - trading account update

Returns:

completable future resolving when account is updated

removeAccount

public CompletableFuture<Void> removeAccount(String id)

Deletes a CopyFactory trade copying account. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/removeAccount/

Parameters:

id - copy trading account id

Returns:

completable future resolving when account is removed

getStrategies

public CompletableFuture<List<CopyFactoryStrategy>> getStrategies()

Retrieves CopyFactory copy trading strategies. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getStrategies/

Returns:

completable future resolving with CopyFactory strategies found

getStrategy

public CompletableFuture<CopyFactoryStrategy> getStrategy(String strategyId)

Retrieves CopyFactory copy trading strategy by id. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getStrategy/

Parameters:

strategyId - id trading strategy id

Returns:

completable future resolving with CopyFactory strategy found

updateStrategy

public CompletableFuture<Void> updateStrategy(String id,
                                              CopyFactoryStrategyUpdate strategy)

Updates a CopyFactory strategy. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/updateStrategy/

Parameters:

id - copy trading strategy id

strategy - trading strategy update

Returns:

completable future resolving when strategy is updated

removeStrategy

public CompletableFuture<Void> removeStrategy(String id)

Deletes a CopyFactory strategy. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/removeStrategy/

Parameters:

id - strategy id

Returns:

completable future resolving when strategy is removed

getPortfolioStrategies

public CompletableFuture<List<CopyFactoryPortfolioStrategy>> getPortfolioStrategies()

Retrieves CopyFactory copy portfolio strategies. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getPortfolioStrategies/

Returns:

completable future resolving with CopyFactory portfolio strategies found

getPortfolioStrategy

public CompletableFuture<CopyFactoryPortfolioStrategy> getPortfolioStrategy(String portfolioId)

Retrieves CopyFactory copy portfolio strategy by id. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getPortfolioStrategy/

Parameters:

portfolioId - portfolio strategy id

Returns:

completable future resolving with CopyFactory portfolio strategy found

updatePortfolioStrategy

public CompletableFuture<Void> updatePortfolioStrategy(String id,
                                                       CopyFactoryPortfolioStrategyUpdate strategy)

Updates a CopyFactory portfolio strategy. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/updatePortfolioStrategy/

Parameters:

id - copy trading portfolio strategy id

strategy - portfolio strategy update

Returns:

completable future resolving when portfolio strategy is updated

removePortfolioStrategy

public CompletableFuture<Void> removePortfolioStrategy(String id)

Deletes a CopyFactory portfolio strategy. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/removePortfolioStrategy/

Parameters:

id - portfolio strategy id

Returns:

completable future resolving when portfolio strategy is removed

getActiveResynchronizationTasks

public CompletableFuture<List<ResynchronizationTask>> getActiveResynchronizationTasks(String connectionId)

Returns list of active resynchronization tasks for a specified connection. See https://metaapi.cloud/docs/copyfactory/restApi/api/configuration/getActiveResynchronizationTasks/

Parameters:

connectionId - MetaApi account id to return tasks for

Returns:

completable future resolving with list of active resynchronization tasks

waitResynchronizationTasksCompleted

public CompletableFuture<Void> waitResynchronizationTasksCompleted(String connectionId)

Waits until active resynchronization tasks are completed with default timeout and reloading interval. Completes exceptionally with TimeoutException if tasks have not completed to the broker withing timeout allowed.

Parameters:

connectionId - MetaApi account id to wait tasks completed for

Returns:

completable future which resolves when tasks are completed

waitResynchronizationTasksCompleted

public CompletableFuture<Void> waitResynchronizationTasksCompleted(String connectionId,
                                                                   Integer timeoutInSeconds,
                                                                   Integer intervalInMilliseconds)

Waits until active resynchronization tasks are completed. Completes exceptionally with TimeoutException if tasks have not completed to the broker withing timeout allowed.

Parameters:

connectionId - MetaApi account id to wait tasks completed for

timeoutInSeconds - wait timeout in seconds, default is 5m

intervalInMilliseconds - interval between tasks reload while waiting for a change, default is 1s

Returns:

completable future which resolves when tasks are completed