> ## 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.

# Get account snapshot

> Get a full snapshot of a trading account: balance, equity, open positions, unrealized P&L, group settings, and KYC status.

## Path parameters

<ParamField path="login" type="number" required>
  The MT5 login number of the authenticated user. Must match the login in the JWT — returns 403 otherwise.
</ParamField>

## Response

`200` Success.

<ResponseField name="login" type="number" />

<ResponseField name="balance" type="number" />

<ResponseField name="credit" type="number" default="0" />

<ResponseField name="storage" type="number" />

<ResponseField name="assets" type="number" default="0" />

<ResponseField name="prevEquity" type="number" />

<ResponseField name="prevBalance" type="number" />

<ResponseField name="leverage" type="number" />

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

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

<ResponseField name="createdAt" type="number" />

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

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

<ResponseField name="equity" type="number" />

<ResponseField name="Invested" type="number" />

<ResponseField name="Profits" type="number" />

<ResponseField name="access" type="object">
  <Expandable title="properties">
    <ResponseField name="id" type="string" />

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

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

    <ResponseField name="currencyDigits" type="number" />

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

    <ResponseField name="noPl" type="boolean" />
  </Expandable>
</ResponseField>

<ResponseField name="positions" type="object[]">
  <Expandable title="properties">
    <ResponseField name="id" type="string" />

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

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

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

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

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

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

    <ResponseField name="units" type="number" />

    <ResponseField name="priceOpen" type="number" />

    <ResponseField name="priceCurrent" type="number" />

    <ResponseField name="timeCreate" type="number" />

    <ResponseField name="timeUpdate" type="number" />

    <ResponseField name="leverage" type="number" />

    <ResponseField name="rateMargin" type="number" default="1" />

    <ResponseField name="rateProfit" type="number" default="1" />

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

    <ResponseField name="sl" type="number" default="0" />

    <ResponseField name="tp" type="number" default="0" />

    <ResponseField name="storage" type="number" default="0" />

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

    <ResponseField name="profit" type="number" default="0" />

    <ResponseField name="invested" type="number" default="0" />
  </Expandable>
</ResponseField>

<ResponseField name="orders" type="object[]">
  <Expandable title="properties">
    <ResponseField name="id" type="string" />

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

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

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

    <ResponseField name="units" type="number" />

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

    <ResponseField name="state" type="number" />

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

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

    <ResponseField name="priceOpen" type="number" />

    <ResponseField name="priceCurrent" type="number" />

    <ResponseField name="leverage" type="number" />

    <ResponseField name="timeCreate" type="number" />

    <ResponseField name="timeUpdate" type="number" />

    <ResponseField name="rateMargin" type="number" default="1" />

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

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

    <ResponseField name="sl" type="number" default="0" />

    <ResponseField name="tp" type="number" default="0" />

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

    <ResponseField name="invested" type="number" default="0" />

    <ResponseField name="useMargin" type="boolean" />
  </Expandable>
</ResponseField>

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 400 | Invalid or missing field, amount outside limits | Check the request against the schema and the instrument's size limits. |
| 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/trading/session/{login}' \
    --header 'Authorization: Bearer <token>'
  ```

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

  url = "https://gateway.amana.io/trading/session/{login}"
  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/trading/session/{login}', {
    method: 'GET',
    headers: {"Authorization": "Bearer <token>"},
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "login": 123.45,
    "balance": 123.45,
    "credit": 0,
    "storage": 123.45,
    "assets": 0,
    "prevEquity": 123.45,
    "prevBalance": 123.45,
    "leverage": 123.45,
    "group": "<string>",
    "server": "<string>",
    "createdAt": 123.45,
    "currency": "<string>",
    "kyc_status": "<string>",
    "equity": 123.45,
    "Invested": 123.45,
    "Profits": 123.45,
    "access": {
      "id": "<string>",
      "name": "<string>",
      "currency": "<string>",
      "currencyDigits": 123.45,
      "isHedged": true,
      "noPl": true
    },
    "positions": [
      {
        "id": "<string>",
        "symbol": "<string>",
        "logo": "<string>",
        "delayed": false,
        "sharia": false,
        "digits": 123.45,
        "friendlyName": "<string>",
        "units": 123.45,
        "priceOpen": 123.45,
        "priceCurrent": 123.45,
        "timeCreate": 123.45,
        "timeUpdate": 123.45,
        "leverage": 123.45,
        "rateMargin": 1,
        "rateProfit": 1,
        "isBuy": true,
        "sl": 0,
        "tp": 0,
        "storage": 0,
        "comment": "<string>",
        "profit": 0,
        "invested": 0
      }
    ],
    "orders": [
      {
        "id": "<string>",
        "symbol": "<string>",
        "logo": "<string>",
        "friendlyName": "<string>",
        "units": 123.45,
        "digits": 123.45,
        "state": 123.45,
        "delayed": false,
        "sharia": false,
        "priceOpen": 123.45,
        "priceCurrent": 123.45,
        "leverage": 123.45,
        "timeCreate": 123.45,
        "timeUpdate": 123.45,
        "rateMargin": 1,
        "isBuy": true,
        "isLimit": true,
        "sl": 0,
        "tp": 0,
        "comment": "<string>",
        "invested": 0,
        "useMargin": true
      }
    ]
  }
  ```

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

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

  ```json 403 theme={null}
  {
    "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.