Package cloud.metaapi.sdk.meta_api

Class MetatraderAccountApi

java.lang.Object

cloud.metaapi.sdk.meta_api.MetatraderAccountApi

public class MetatraderAccountApi
extends Object

Exposes MetaTrader account API logic to the consumers

Constructor Summary

Constructors

Constructor	Description
MetatraderAccountApi(MetatraderAccountClient metatraderAccountClient, MetaApiWebsocketClient metaApiWebsocketClient, ConnectionRegistry connectionRegistry)	Constructs a MetaTrader account API instance

Method Summary

Modifier and Type	Method	Description
CompletableFuture<MetatraderAccount>	createAccount(NewMetatraderAccountDto account)	Creates a MetaTrader account
CompletableFuture<MetatraderAccount>	getAccount(String accountId)	Retrieves a MetaTrader account by id
CompletableFuture<MetatraderAccount>	getAccountByToken()	Retrieves a MetaTrader account by token
CompletableFuture<List<MetatraderAccount>>	getAccounts()	Retrieves MetaTrader accounts without filtering
CompletableFuture<List<MetatraderAccount>>	getAccounts(AccountsFilter accountsFilter)	Retrieves MetaTrader accounts

Methods inherited from class java.lang.Object

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

Constructor Detail

MetatraderAccountApi

public MetatraderAccountApi(MetatraderAccountClient metatraderAccountClient,
                            MetaApiWebsocketClient metaApiWebsocketClient,
                            ConnectionRegistry connectionRegistry)

Constructs a MetaTrader account API instance

Parameters:

metatraderAccountClient - MetaTrader account REST API client

metaApiWebsocketClient - MetaApi websocket client

connectionRegistry - metatrader account connection registry

Method Detail

getAccounts

public CompletableFuture<List<MetatraderAccount>> getAccounts()

Retrieves MetaTrader accounts without filtering

Returns:

completable future resolving with a list of MetaTrader account entities

getAccounts

public CompletableFuture<List<MetatraderAccount>> getAccounts(AccountsFilter accountsFilter)

Retrieves MetaTrader accounts

Parameters:

accountsFilter - optional filter or null

Returns:

completable future resolving with a list of MetaTrader account entities

getAccount

public CompletableFuture<MetatraderAccount> getAccount(String accountId)

Retrieves a MetaTrader account by id

Parameters:

accountId - MetaTrader account id

Returns:

completable future resolving with MetaTrader account entity

getAccountByToken

public CompletableFuture<MetatraderAccount> getAccountByToken()

Retrieves a MetaTrader account by token

Returns:

completable future resolving with MetaTrader account entity

createAccount

public CompletableFuture<MetatraderAccount> createAccount(NewMetatraderAccountDto account)

Creates a MetaTrader account

Parameters:

account - MetaTrader account data

Returns:

completable future resolving with MetaTrader account entity