GetUserAccountInfos

Category: User Permissions: Operator, Trading, AccountReadOnly Call Type: Synchronous

Returns a list of account information for all accounts belonging to the specified user.

Request

{
  "OMSId": 0,
  "UserId": 0,
  "UserName": "",
}
KeyValue

OMSId

integer. The Order Management System on which the user has one ore more accounts.

UserId

integer. The ID of the user whose accounts you want to return.

UserName

string. The name of the user.

Response

Returns a JSON list of account objects; one for each account associated with the user.

{
  "OMSID": 0,
  "AccountId": 0,
  "AccountName": "",
  "AccountHandle": "",
  "FirmId": "",
  "FirmName": "",
  "AccountType": {
    "Options":[
      "Asset",
      "Liability",
      "ProfitLoss"
    ] 
  },
  "FeeGroupID": 0,
  "ParentID": 0,
  "RiskType": {
    "Options": [
      "Unknown",
      "Normal",
      "NoRiskCheck",
      "NoTrading"
    ] 
  },
  "VerificationLevel": 0,
  "FeeProductType": {
    "Options": [
      "BaseProduct",
      "SingleProduct"
    ] 
  },
  "FeeProduct": 0,
  "RefererId": 0,
  "SupportedVenueIds": [
    0
  ],
}
KeyValue

OMSID

integer. The ID of the Order Management System on which the account resides.

AccountId

integer. The ID of the account for which information was requested.

AccountName

string. The name of the account.

AccountHandle

string. AccountHandle is a unique user-assigned name that is checked at create time by the Order Management System.

FirmId

string. An arbitrary identifier assigned by a trading venue operator to a trading firm as part of the initial company, user, and account set up process. For example, Smith Financial Partners might have the ID SMFP.

FirmName

string. A longer, non-unique version of the trading firm’s name; for example, Smith Financial Partners.

AccountType

string. The type of the account for which information is being returned. One of: Asset Liability ProfitLoss Responses for this string/value pair for Market Participants are almost exclusively Asset.

FeeGroupID

integer. Defines account attributes relating to how fees are calculated and assessed. Set by trading venue operator.

ParentID

integer. Reserved for future development.

RiskType

string. One of: Unkown (an error condition) Normal NoRiskCheck NoTrading Returns Normal for virtually all market participants. Other types indicate account configurations assignable by the trading venue operator.

VerificationLevel

Integer. Verification level ID (how much verification does this account require) defined by and set by the trading venue operator for this account.

FeeProductType

string. One of: BaseProduct SingleProduct Transaction fees may be charged by a trading venue operator. This value shows whether fees for this account’s trades are charged in the product being traded (BaseProduct, for example BitCoin) or whether the account has a preferred fee-paying product (SingleProduct, for example USD) to use in all cases and regardless of product being traded.

FeeProduct

integer. The ID of the preferred fee product, if SingleProduct is the value of FeeProductType.

RefererId

integer. Captures the ID of the person who referred this account to the trading venue, usually for marketing purposes.

SupportedVenueIds

integer array. Comma-separated array. Reserved for future expansion. Currently returns 0.

Last updated

Logo