Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountInfoResult

Hierarchy

  • AccountInfoResult

Index

Properties

AccountHandle

AccountHandle: string

AccountHandle is a unique user-assigned name that is checked at create time by the Order Management System to assure its uniqueness.

type

{string}

memberof

AccountInfoResult

AccountId

AccountId: number

The ID of the account for which information was requested.

type

{number}

memberof

AccountInfoResult

AccountName

AccountName: string

A non-unique name for the account assigned by the user

type

{string}

memberof

AccountInfoResult

AccountType

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.

type

{Acc}

memberof

AccountInfoResult

FeeGroupID

FeeGroupID: number

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

type

{number}

memberof

AccountInfoResult

FeeProduct

FeeProduct: number

The ID of the preferred fee product, if any. Defaults to 0

type

{number}

memberof

AccountInfoResult

FeeProductType

FeeProductType: string

One of:

  • BaseProduct
  • SingleProduct

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

type

{AccountTypeOrRiskTypeOrFeeProductType}

memberof

AccountInfoResult

FirmId

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.

type

{string}

memberof

AccountInfoResult

FirmName

FirmName: string

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

type

{string}

memberof

AccountInfoResult

OMSID

OMSID: number

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

type

{number}

memberof

AccountInfoResult

ParentID

ParentID: number

Reserved for future development.

type

{number}

memberof

AccountInfoResult

RefererId

RefererId: number

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

type

{number}

memberof

AccountInfoResult

RiskType

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.

type

{string}

memberof

AccountInfoResult

SupportedVenueIds

SupportedVenueIds: number[]

Comma-separated array. Reserved for future expansion.

type

{number[]}

memberof

AccountInfoResult

VerificationLevel

VerificationLevel: number

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

type

{number}

memberof

AccountInfoResult

Generated using TypeDoc