Skip to content

Get Market Short List

GetMarketShortList

GetMarketShortList

Description: Returns a compact market list for a target account login using structure + rows.

Available for:

  • SESSION_USER
  • SESSION_MANAGER
  • SESSION_ADMIN
  • SESSION_DEALER

Note

Request should include Authorization token.

Request Parameters

Name Type Required Description
login int Yes Target account login

Request Example

{
  "login": 100001
}

Response Parameters

Name Type Description
assets object Object containing structure and rows
groups array Visible security group names for the account group

assets.structure is an ordered list of field names.
assets.rows contains array rows aligned with that structure.

Response Example (truncated)

{
  "assets": {
    "structure": [
      "symbol",
      "description",
      "currency",
      "margin_currency",
      "quote_currency",
      "group",
      "digits",
      "trade",
      "spread",
      "spread_balance",
      "market_state",
      "market_reason"
    ],
    "rows": [
      [
        "EURUSD",
        "Euro vs US Dollar",
        "EUR",
        "USD",
        "USD",
        "Forex",
        5,
        1,
        12,
        0,
        1,
        0
      ]
    ]
  },
  "groups": ["Forex", "Metals"]
}

Error Responses

Code Error Description
400 INVALID_DATA Missing or invalid login
403 USER_NOT_FOUND_OR_INCORRECT Account was not found
404 GROUP_NOT_FOUND Account group was not found