> ## Documentation Index
> Fetch the complete documentation index at: https://readme.amana-dev.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List watchlists

> List the user's watchlists.

## Response

`200` Success.

<ResponseField name="response" type="object[]">
  <Expandable title="properties">
    <ResponseField name="_id" type="string" />

    <ResponseField name="en" type="string" />

    <ResponseField name="ar" type="string" />

    <ResponseField name="logo" type="string" />

    <ResponseField name="items" type="object[]">
      <Expandable title="properties">
        <ResponseField name="_id" type="string" />

        <ResponseField name="logo" type="string" />

        <ResponseField name="friendlyName" type="string" />

        <ResponseField name="leveraged" type="boolean" />

        <ResponseField name="delayed" type="boolean" />

        <ResponseField name="sharia" type="boolean" />

        <ResponseField name="digits" type="number" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 401 | Token missing or expired | Log in again or use the refresh token. |
| 403 | IP not whitelisted, or account restricted | Confirm your IP is whitelisted; otherwise contact Amana. |
| 429 / 5xx | Rate limit, or temporary issue on our side | Retry with backoff; contact support if it persists. |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://gateway.amana.io/watchlist' \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gateway.amana.io/watchlist"
  headers = {"Authorization": "Bearer <token>"}

  response = requests.request("GET", url, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://gateway.amana.io/watchlist', {
    method: 'GET',
    headers: {"Authorization": "Bearer <token>"},
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "_id": "<string>",
      "en": "<string>",
      "ar": "<string>",
      "logo": "<string>",
      "items": [
        {
          "_id": "<string>",
          "logo": "<string>",
          "friendlyName": "<string>",
          "leveraged": true,
          "delayed": true,
          "sharia": true,
          "digits": 123.45
        }
      ]
    }
  ]
  ```

  ```json 401 theme={null}
  {
    "error": "<string>",
    "message": "<string>",
    "details": {}
  }
  ```

  ```json 403 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 429 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.