Skip to content

Read candle (OHLCV)#

About#

Returns current candle for a specific symbol and timeframe

GET /users/current/accounts/:accountId/symbols/:symbol/current-candles/:timeframe

For more information see Swagger documentation

Headers#

Name Type Required Description
auth-token string Yes authorization token. See Authentication & authorization

Path parameters#

Name Type Required Description
accountId string Yes MetaTrader account id. You can retrieve account id from Web application after you add your MetaTrader account to our platform. The account id can also be obtained via Provisioning API
symbol string Yes symbol (e.g. a currency pair or an index)
timeframe string Yes 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

Query parameters#

Name Type Required Description
keepSubscription boolean if set to true, the account will get a long-term subscription to symbol market data. Long-term subscription means that on subsequent calls you will get updated value faster. If set to false or not set, the subscription will be set to expire in 12 minutes.

Responses:

  • 200 - Current candle returned successfully. Response schema: MetatraderCandle
  • 401 - Authorization failed. Response schema: Error
  • 404 - MetaTrader account not found or not provisioned yet or symbol is not defined for this broker. Response schema: Error

Examples#

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://mt-client-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/865d3a4d-3803-486d-bdf3-a85679d9fad2/symbols/AUDNZD/current-candles/15m'

Example response:

{
  "symbol": "AUDNZD",
  "timeframe": "15m",
  "time": "2020-04-07T03:45:00.000Z",
  "brokerTime": "2020-04-07 06:45:00.000",
  "open": 1.03297,
  "high": 1.06309,
  "low": 1.02705,
  "close": 1.043,
  "tickVolume": 1435,
  "spread": 17,
  "volume": 345
}