MetaTrader GPT
MetaTrader GPT · Ações GPT
Get Trading Account
Get Trading account and ask for account ID if you don't have it before calling this function. If there is an error it is because you do not have the account ID so ask for it.
GET /users/current/accounts/{accountId}/account-informationGet Account InformationGet Account Information and ask for account ID if you don't have it before calling this function.
GET /users/current/accounts/{accountId}/positionsGet PositionsReturns positions for a trading account.
GET /users/current/accounts/{accountId}/server-timeCurrent TimeReturns current server time for a trading account
GET /users/current/accounts/{accountId}/positions/{positionId}Get A PositionReturns specific position for a trading account
GET /users/current/accounts/{accountId}/symbolsGet All SymbolsReturns all symbols available on a trading account.
GET /users/current/accounts/{accountId}/symbols/{symbol}/specificationGet A Symbol SpecificationsReturns symbol specification for a symbol on a trading account.
GET /users/current/accounts/{accountId}/symbols/{symbol}/current-priceGet Symbol PriceReturns current price for a symbol on a trading account.
GET /users/current/accounts/{accountId}/symbols/{symbol}/current-candles/{timeframe}Get Current CandlestickReturns current candle for a symbol and timeframe on a trading account
POST /users/current/accounts/{accountId}/tradePlace TradePlace a trade on a trading account.
Esquema API original
{
"openapi": "3.1.0",
"info": {
"title": "Get Trading Account",
"description": "Get Trading account and ask for account ID if you don't have it before calling this function. If there is an error it is because you do not have the account ID so ask for it.",
"version": "v0.0.1"
},
"servers": [
{
"url": "https://mt-client-api-v1.new-york.agiliumtrade.ai"
}
],
"paths": {
"/users/current/accounts/{accountId}/account-information": {
"get": {
"description": "Get Account Information and ask for account ID if you don't have it before calling this function.",
"operationId": "Get Account Information",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/positions": {
"get": {
"description": "Returns positions for a trading account. ",
"operationId": "Get Positions",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/server-time": {
"get": {
"description": "Returns current server time for a trading account",
"operationId": "Current Time",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/positions/{positionId}": {
"get": {
"description": "Returns specific position for a trading account",
"operationId": "Get A Position",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/symbols": {
"get": {
"description": "Returns all symbols available on a trading account.",
"operationId": "Get All Symbols",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/symbols/{symbol}/specification": {
"get": {
"description": "Returns symbol specification for a symbol on a trading account.",
"operationId": "Get A Symbol Specifications",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "symbol",
"in": "path",
"description": "symbol (e.g. currency pair or an index)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/symbols/{symbol}/current-price": {
"get": {
"description": "Returns current price for a symbol on a trading account.",
"operationId": "Get Symbol Price",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "symbol",
"in": "path",
"description": "symbol (e.g. currency pair or an index)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/symbols/{symbol}/current-candles/{timeframe}": {
"get": {
"description": "Returns current candle for a symbol and timeframe on a trading account",
"operationId": "Get Current Candlestick",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "symbol",
"in": "path",
"description": "symbol (e.g. currency pair or an index)",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "timeframe",
"in": "path",
"description": "defines the timeframe according to which the candle must be generated. Allowed values for MT5 are 1m, 2m, 3m, 4m, 5m, 6m, 10m, 12m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, 1d, 1w, 1mn. Allowed values for MT4 are 1m, 5m, 15m 30m, 1h, 4h, 1d, 1w, 1mn",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
},
"/users/current/accounts/{accountId}/trade": {
"post": {
"description": "Place a trade on a trading account.",
"operationId": "Place Trade",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "MetaAPI Account ID",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "actionType",
"in": "body",
"description": "ORDER_TYPE_SELL, ORDER_TYPE_BUY",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "symbol",
"in": "body",
"description": "symbol to trade",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "volume",
"in": "body",
"description": "order volume, min: 0.01",
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "number"
}
},
{
"name": "stopLoss",
"in": "body",
"description": "stop loss price, min: 0",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "number"
}
},
{
"name": "takeProfit",
"in": "body",
"description": "take profit price, min: 0",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "integer"
}
},
{
"name": "stopLossUnits",
"in": "body",
"description": "stop loss units. ABSOLUTE_PRICE means the that the value of stopLoss field is a final stop loss value. RELATIVE_* means that the stopLoss field value contains relative stop loss expressed either in price, points, pips, account currency or balance percentage. Default is ABSOLUTE_PRICE. enum: ABSOLUTE_PRICE, RELATIVE_PRICE, RELATIVE_POINTS, RELATIVE_PIPS, RELATIVE_CURRENCY, RELATIVE_BALANCE_PERCENTAGE",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "string"
}
},
{
"name": "takeProfitUnits",
"in": "body",
"description": "take profit units. ABSOLUTE_PRICE means the that the value of takeProfit field is a final take profit value. RELATIVE_* means that the takeProfit field value contains relative take profit expressed either in price, points, pips, account currency or balance percentage. Default is ABSOLUTE_PRICE. enum: ABSOLUTE_PRICE, RELATIVE_PRICE, RELATIVE_POINTS, RELATIVE_PIPS, RELATIVE_CURRENCY, RELATIVE_BALANCE_PERCENTAGE",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "string"
}
},
{
"name": "trailingStopLoss",
"in": "body",
"description": "distance trailing stop loss configuration \"distance\": {\n \"distance\": 0.1,\n \"units\": \"RELATIVE_PRICE\"\n },\n \"threshold\": {\n \"thresholds\": [\n {\n \"threshold\": 1.3,\n \"stopLoss\": 1.1\n }\n ],\n \"units\": \"ABSOLUTE_PRICE\",\n \"stopPriceBase\": \"CURRENT_PRICE\"\n }",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": ""
}
},
{
"name": "stopPriceBase",
"in": "body",
"description": "defined the base price to calculate SL/TP relative to for pending order requests. Default is CURRENT_PRICE. enum: CURRENT_PRICE",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "string"
}
},
{
"name": "magic",
"in": "body",
"description": "magic number (expert adviser id)",
"required": false,
"deprecated": false,
"allowEmptyValue": false,
"explode": false,
"allowReserved": false,
"schema": {
"type": "number"
}
}
],
"deprecated": false,
"security": [
{
"apiKey": []
}
]
}
}
}
}