> ## 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 current user balance, positions, kyc state, and group configuration

> Returns a comprehensive account snapshot including balance, equity, open positions, unrealized P&L, group trading configuration, and KYC status. This is the primary endpoint for rendering the trading dashboard. Call this once per session to populate account state, then use getOpenPositions for live position updates.



## OpenAPI

````yaml /openapi-readme.json get /trading/session/{login}
openapi: 3.1.0
info:
  title: Amana API
  version: 1.0.0
  description: API documentation for Amana platform
servers:
  - url: https://gateway.amana.io
    description: Amana app
security: []
tags:
  - name: onboarding
    description: Endpoints related to user onboarding, KYC processes, and account setup.
  - name: auth
    description: Endpoints for user authentication, token management, and session handling.
  - name: trading
    description: >-
      Endpoints related to trading operations, account management, and market
      data retrieval.
  - name: charting
    description: >-
      Endpoints for retrieving historical price data, technical indicators, and
      other charting-related information.
  - name: uaepass
    description: Endpoints for UAE Pass authentication and identity verification.
  - name: alerts
  - name: cms
  - name: dw
  - name: events
  - name: geo-location
  - name: high-leverage
  - name: kyc
  - name: mt
  - name: nafath
  - name: payments
  - name: promo-codes
  - name: smart-money
  - name: support
  - name: symbols
  - name: trading-accounts
  - name: transactions
  - name: user
  - name: watchlists
paths:
  /trading/session/{login}:
    get:
      tags:
        - trading
      summary: Get current user balance, positions, kyc state, and group configuration
      description: >-
        Returns a comprehensive account snapshot including balance, equity, open
        positions, unrealized P&L, group trading configuration, and KYC status.
        This is the primary endpoint for rendering the trading dashboard. Call
        this once per session to populate account state, then use
        getOpenPositions for live position updates.
      operationId: getAccountOverview
      parameters:
        - schema:
            type: number
          in: path
          name: login
          required: true
          description: >-
            The MT5 login number of the authenticated user. Must match the login
            in the JWT — returns 403 otherwise.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  login:
                    type: number
                  balance:
                    type: number
                  credit:
                    default: 0
                    type: number
                  storage:
                    type: number
                  assets:
                    default: 0
                    type: number
                  prevEquity:
                    type: number
                  prevBalance:
                    type: number
                  leverage:
                    type: number
                  group:
                    type: string
                  server:
                    type: string
                  createdAt:
                    type: number
                  currency:
                    type: string
                  kyc_status:
                    type: string
                  equity:
                    type: number
                  Invested:
                    type: number
                  Profits:
                    type: number
                  access:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      currency:
                        type: string
                      currencyDigits:
                        type: number
                      isHedged:
                        type: boolean
                      noPl:
                        anyOf:
                          - type: boolean
                          - type: 'null'
                    required:
                      - id
                      - name
                      - currency
                      - currencyDigits
                      - isHedged
                      - noPl
                    additionalProperties: false
                  positions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        symbol:
                          type: string
                        logo:
                          type: string
                        delayed:
                          default: false
                          type: boolean
                        sharia:
                          default: false
                          type: boolean
                        digits:
                          type: number
                        friendlyName:
                          type: string
                        units:
                          type: number
                        priceOpen:
                          type: number
                        priceCurrent:
                          type: number
                        timeCreate:
                          type: number
                        timeUpdate:
                          type: number
                        leverage:
                          type: number
                        rateMargin:
                          default: 1
                          type: number
                        rateProfit:
                          default: 1
                          type: number
                        isBuy:
                          type: boolean
                        sl:
                          default: 0
                          type: number
                        tp:
                          default: 0
                          type: number
                        storage:
                          default: 0
                          type: number
                        comment:
                          type: string
                        profit:
                          default: 0
                          type: number
                        invested:
                          default: 0
                          type: number
                      required:
                        - id
                        - symbol
                        - logo
                        - delayed
                        - sharia
                        - digits
                        - friendlyName
                        - units
                        - priceOpen
                        - priceCurrent
                        - timeCreate
                        - timeUpdate
                        - leverage
                        - rateMargin
                        - rateProfit
                        - isBuy
                        - sl
                        - tp
                        - storage
                        - comment
                        - profit
                        - invested
                      additionalProperties: false
                  orders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        symbol:
                          type: string
                        logo:
                          type: string
                        friendlyName:
                          type: string
                        units:
                          type: number
                        digits:
                          type: number
                        state:
                          type: number
                        delayed:
                          default: false
                          type: boolean
                        sharia:
                          default: false
                          type: boolean
                        priceOpen:
                          type: number
                        priceCurrent:
                          type: number
                        leverage:
                          type: number
                        timeCreate:
                          type: number
                        timeUpdate:
                          type: number
                        rateMargin:
                          default: 1
                          type: number
                        isBuy:
                          type: boolean
                        isLimit:
                          type: boolean
                        sl:
                          default: 0
                          type: number
                        tp:
                          default: 0
                          type: number
                        comment:
                          type: string
                        invested:
                          default: 0
                          type: number
                        useMargin:
                          type: boolean
                      required:
                        - id
                        - symbol
                        - logo
                        - friendlyName
                        - units
                        - digits
                        - state
                        - delayed
                        - sharia
                        - priceOpen
                        - priceCurrent
                        - leverage
                        - timeCreate
                        - timeUpdate
                        - rateMargin
                        - isBuy
                        - isLimit
                        - sl
                        - tp
                        - comment
                        - invested
                      additionalProperties: false
                required:
                  - login
                  - balance
                  - credit
                  - storage
                  - assets
                  - prevEquity
                  - prevBalance
                  - leverage
                  - group
                  - server
                  - createdAt
                  - kyc_status
                  - equity
                  - Invested
                  - Profits
                  - access
                  - positions
                  - orders
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from authentication endpoints

````

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