Read symbol specification

About

Returns specification for a specific symbol

GET /users/current/accounts/:accountId/symbols/:symbol/specification

For more information see Swagger documentation. Note, that this URL is valid for new-york region only. You can find URLs for other regions on API access page.

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)

Responses:

• 200 - Symbol specification returned successfully. Response schema: MetatraderSymbolSpecification
• 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.new-york.agiliumtrade.ai/users/current/accounts/865d3a4d-3803-486d-bdf3-a85679d9fad2/symbols/AUDNZD/specification'

Example response:

{
  "symbol": "AUDNZD",
  "tickSize": 0.00001,
  "minVolume": 0.01,
  "maxVolume": 100,
  "volumeStep": 0.01,
  "contractSize": 100000,
  "quoteSessions": {
    "SUNDAY": [],
    "MONDAY": [{"from": "00:00:00.000", "to": "23:59:59.999"}],
    "TUESDAY": [{"from": "00:00:00.000", "to": "23:59:59.999"}],
    "WEDNESDAY": [{"from": "00:00:00.000", "to": "23:59:59.999"}],
    "THURSDAY": [{"from": "00:00:00.000", "to": "23:59:59.999"}],
    "FRIDAY": [{"from": "00:00:00.000", "to": "23:59:59.999"}],
    "SATURDAY": []
  },
  "tradeSessions": {
    "SUNDAY": [],
    "MONDAY": [{"from": "00:05:00.000", "to": "23:59:59.999"}],
    "TUESDAY": [{"from": "00:05:00.000", "to": "23:59:59.999"}],
    "WEDNESDAY": [{"from": "00:05:00.000", "to": "23:59:59.999"}],
    "THURSDAY": [{"from": "00:05:00.000", "to": "23:59:59.999"}],
    "FRIDAY": [{"from": "00:05:00.000", "to": "23:59:59.999"}],
    "SATURDAY": []
  },
  "initialMargin": 100000,
  "maintenenceMargin": 0,
  "hedgedMargin": 0,
  "priceCalculationMode": "SYMBOL_CALC_MODE_FOREX",
  "marginCurrency": "AUD",
  "baseCurrency": "AUD",
  "profitCurrency": "NZD",
  "swapMode": "SYMBOL_SWAP_MODE_DISABLED",
  "allowedExpirationModes": ["SYMBOL_EXPIRATION_GTC", "SYMBOL_EXPIRATION_DAY", "SYMBOL_EXPIRATION_SPECIFIED", "SYMBOL_EXPIRATION_SPECIFIED_DAY"],
  "allowedOrderTypes": ["SYMBOL_ORDER_MARKET", "SYMBOL_ORDER_LIMIT", "SYMBOL_ORDER_STOP", "SYMBOL_ORDER_STOP_LIMIT", "SYMBOL_ORDER_SL", "SYMBOL_ORDER_TP", "SYMBOL_ORDER_CLOSEBY"],
  "digits": 5,
  "description": "Australian Dollar vs New Zealand Dollar"
}