---
title: "Get a symbol mapping"
method: GET
path: "/rest/api/v1/projects/{projectId}/symbolMappings/{symbolMappingId}"
tags: ["Project API"]
---

# Get a symbol mapping

`GET /rest/api/v1/projects/{projectId}/symbolMappings/{symbolMappingId}`

## Request

- Base URL: `https://api.metacopier.io`
- URL: `https://api.metacopier.io/rest/api/v1/projects/{projectId}/symbolMappings/{symbolMappingId}`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/metacopier/apis/metacopier-api/docs/rest/api/v1/projects/:projectId/symbolMappings/:symbolMappingId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `projectId` string, uuid, required
- `symbolMappingId` integer, required

## Response `200`

OK

- SymbolMappingDTO
  - `brokerFrom` string, 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)
  - `brokerTo` string, 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)
  - `brokerToSuggestion` string[]: 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)
  - `from` string, required: Enter a symbol e.g. GBPUSD (is not a regex)
  - `id` integer
  - `priority` integer, required: The priority is ascending, which means that 0 has a higher priority than 1. Priority is always positive
  - `projectId` string, uuid
  - `to` string, required: Enter a symbol e.g. GBPEUR (is not a regex)

---

[API](https://skmtc.dev/metacopier/apis/metacopier-api.md) - [All operations](https://skmtc.dev/metacopier/apis/metacopier-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metacopier/apis/metacopier-api/revisions/2ac6d7461345?raw)
