Skip to content

Get Accounts By Loogins

GetAccountsByLogins

Description:
Returns detailed account information for a specified list of login IDs. The response includes financial data, permissions, margin statistics, and online status.


Access Control

🛡️ Access Level Required: SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER


Endpoint

GET /accounts/logins/list


Request Parameters

Name Type Required Description
logins array Yes List of account login IDs (int)

Request Example

{
  "logins": [1001, 1002, 1050]
}

Response Structure

The response contains two keys:

  • structure — array describing column order
  • rows — array of account records matching the structure

Structure Fields

Field Description
login Account login ID
enable Account enabled flag
enable_read_only Read-only flag
enable_change_password Change password permission
leverage Account leverage
currency Account currency
group Account group
email Email address
country Country
phone Phone number
comment Comment
address Address
city City
zipcode Zip code
name Full name
regdate Registration timestamp
prevbalance Previous balance
prevmonthbalance Previous month balance
balance Current balance
credit Credit amount
margin Used margin
margin_free Free margin
margin_level Margin level
equity Equity
online Online status flag

Example Response

{
  "structure": [
    "login", "enable", "enable_read_only", "enable_change_password",
    "leverage", "currency", "group", "email", "country", "phone",
    "comment", "address", "city", "zipcode", "name", "regdate",
    "prevbalance", "prevmonthbalance", "balance", "credit",
    "margin", "margin_free", "margin_level", "equity", "online"
  ],
  "rows": [
    [
      1001, 1, 0, 1, 100, "USD", "standard",
      "[email protected]", "US", "+123456789",
      "", "Street 1", "NY", "10001", "John Doe",
      1680000000, 5000.0, 4800.0, 5200.0, 0.0,
      1200.0, 4000.0, 350.0, 5200.0, 1
    ]
  ]
}

Error Responses

Validation Error

{
  "error": "INVALID_DATA",
  "message": "logins is required"
}

Not Found

{
  "error": "ACCOUNT_NOT_FOUND"
}