Project API

Get symbol mappings

get/rest/api/v1/projects/{projectId}/symbolMappings

Path parameters

projectIdstring uuid required

Response

brokerFromstring required

This symbol mapping is only applied if the trade comes from a specific broker, for example, 'ICMarkets.'. For all brokers, you can enter '.' (this is a regex)

brokerTostring required

This symbol mapping is only applied if the trade is copied to a specific broker, for example, 'ICMarkets.'. For all brokers, you can enter '.' (this is a regex)

brokerToSuggestionstring[]

This is read-only. The system attempts to automatically map symbols, but if there are multiple findings, they will be listed here. (This member is used only for the endpoint symbolMappings/current)

fromstring required

Enter a symbol e.g. GBPUSD (is not a regex)

idinteger

priorityinteger required

The priority is ascending, which means that 0 has a higher priority than 1. Priority is always positive

projectIdstring uuid

tostring required

Enter a symbol e.g. GBPEUR (is not a regex)

Changes

No recorded changes to this endpoint across all 3 revisions of this API.