metaapi.cloud-sdk
Version:
SDK for MetaApi, a professional cloud forex API which includes MetaTrader REST API and MetaTrader websocket API. Supports both MetaTrader 5 (MT5) and MetaTrader 4 (MT4). CopyFactory copy trading API included. (https://metaapi.cloud)
150 lines (121 loc) • 3.32 kB
TypeScript
import MetaApiClient from "../metaApi.client"
/**
* metaapi.cloud MetaTrader account generator API client
*/
export default class MetatraderAccountGeneratorClient extends MetaApiClient {
/**
* Creates new MetaTrader 4 demo account
* See https://metaapi.cloud/docs/provisioning/api/generateAccount/createMT4DemoAccount/
* Method is accessible only with API access token
* @param {NewMT4DemoAccount} account account to create
* @param {string} [profileId] id of the provisioning profile that will be used as the basis for creating this account
* @return {Promise<MetatraderAccountCredentialsDto>} promise resolving with MetaTrader account credetials
*/
createMT4DemoAccount(account: NewMT4DemoAccount, profileId?: string): Promise<MetatraderAccountCredentialsDto>;
/**
* Creates new MetaTrader 5 demo account.
* See https://metaapi.cloud/docs/provisioning/api/generateAccount/createMT5DemoAccount/
* Method is accessible only with API access token
* @param {NewMT5DemoAccount} account account to create
* @param {string} [profileId] id of the provisioning profile that will be used as the basis for creating this account
* @return {Promise<MetatraderAccountCredentialsDto>} promise resolving with MetaTrader account credentials
*/
createMT5DemoAccount(account: NewMT5DemoAccount, profileId?: string): Promise<MetatraderAccountCredentialsDto>;
}
/**
* New MetaTrader 4 demo account request model
*/
export declare type NewMT4DemoAccount = {
/**
* Account type. Available account type values can be found in mobile MT application or in MT terminal downloaded
* from our broker
*/
accountType: string,
/**
* account balance
*/
balance: number,
/**
* account holder's email
*/
email: string,
/**
* account leverage
*/
leverage: number,
/**
* account holder's name
*/
name: string,
/**
* account holder's phone, in international format
*/
phone: string,
/**
* server name
*/
serverName: string,
/**
* keywords to be used for broker server search. We recommend to include exact broker company name in this list
*/
keywords?: Array<String>
}
/**
* New MetaTrader 5 demo account request model
*/
export declare type NewMT5DemoAccount = {
/**
* Account type. Available account type values can be found in mobile MT application or in MT terminal downloaded
* from our broker
*/
accountType: string,
/**
* account balance
*/
balance: number,
/**
* account holder's email
*/
email: string,
/**
* account leverage
*/
leverage: number,
/**
* account holder's name
*/
name: string,
/**
* account holder's phone, in international format
*/
phone: string,
/**
* server name
*/
serverName: string,
/**
* keywords to be used for broker server search. We recommend to include exact broker company name in this list
*/
keywords?: Array<String>
}
/**
* MetaTrader demo account model
*/
export declare type MetatraderAccountCredentialsDto = {
/**
* account login
*/
login: string,
/**
* account password
*/
password: string,
/**
* MetaTrader server name
*/
serverName: string,
/**
* account investor (read-only) password
*/
investorPassword: string
}