---
title: "Canonical Symbols"
method: POST
path: "/api/symbols/canonical"
tags: ["symbols"]
---

# Canonical Symbols

`POST /api/symbols/canonical`

## Request

- Base URL: `https://api.halalterminal.com`
- URL: `https://api.halalterminal.com/api/symbols/canonical`
- Auth: API key in header `X-API-Key`

Resolve symbols to the canonical form the screening engine settled on.

**curl example:**
```bash
curl -X POST "https://api.halalterminal.com/api/symbols/canonical" \
     -H "X-API-Key: <API_KEY>" -H "Content-Type: application/json" \
     -d '{"symbols": ["NL0010273215", "ASML.AS"]}'
```

## Request body

- CanonicalRequest
  - `symbols` string[]

## Response `200`

Canonical form of each symbol the engine has resolved

- CanonicalResponse
  - `resolved` object: Input symbol to canonical symbol, for the subset that has one.

## Other responses

- `401`: API key required or invalid
- `422`: Validation Error
- `429`: Quota exceeded

---

[API](https://skmtc.dev/halalterminal/apis/halal-terminal-api.md) · [All operations](https://skmtc.dev/halalterminal/apis/halal-terminal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/halalterminal/apis/halal-terminal-api/revisions/78768b250943?raw)