Read symbols#
About#
Returns symbols available on an account
GET /users/current/accounts/:accountId/symbols
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 |
Responses:
- 200 - Symbols returned successfully. Response schema: Array
- 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'
Example response:
["EURUSD", "AUDNZD"]