Part III
Definitions
RoboadvisorWhitelabelInfo
Name | Schema |
---|---|
Footer optional | string |
Icon optional | |
Logo optional | |
Title optional | string |
SecurityContainerFrame
Name | Schema |
---|---|
Descendants optional read-only | < RebalanceFrame > array |
Description optional | string |
Id optional | integer (int32) |
IsReferenced optional | boolean |
Name optional | string |
Security optional | |
SecurityId optional | integer (int32) |
TargetPercent optional | number (double) |
Tolerance optional | number (double) |
UnitType optional read-only | enum (Node, SecurityLeaf, Cash) |
SecurityFrameParams
Name | Schema |
---|---|
Description optional | string |
Name optional | string |
SecurityId optional | integer (int32) |
TargetPercent optional | number (double) |
Tolerance optional | number (double) |
SecurityHistoryRequestSettings
Name | Schema |
---|---|
CandlesCount optional | integer (int32) |
EndDate optional | integer (int32) |
IncludeNonMarketData optional | boolean |
Interval optional | integer (int32) |
Period optional | string |
StartDate optional | integer (int32) |
SecurityModel
Name | Schema |
---|---|
AddedDate optional | string (date-time) |
BaseCurrency optional | string |
ContractSize optional | number (double) |
Currency optional | string |
Cusip optional | string |
Description optional | string |
Exchange optional | string |
ExpirationDate optional | string (date-time) |
ExpirationType optional | enum (Regular, Quarterly, Weekly, Flex, Undefined, Mini, NonStandard) |
Id optional | integer (int32) |
Industry optional | string |
Isin optional | string |
MarginRate optional | number (double) |
ModifyDate optional | string (date-time) |
OptionType optional | enum (Call, Put, Undefined) |
ParentId optional | integer (int32) |
Precision optional | integer (int32) |
Sector optional | string |
Sedol optional | string |
SeriesId optional | integer (int32) |
Source optional | integer (int32) |
StrikePrice optional | number (double) |
Suffix optional | string |
Symbol optional | string |
TickSize optional | number (double) |
Type optional | enum (BankersAcceptance, CertificateOfDeposit, CollateralizeMortgageObligation, CorporateBond, CommercialPaper, CorporatePrivatePlacement, CommonStock, FederalHousingAuthority, FederalHomeLoan, FederalNationalMortgageAssociation, ForeignExchangeContract, Future, GovernmentNationalMortgageAssociation, TreasuriesPlusAgencyDebenture, MutualFund, MortgageInterestOnly, MortgagePrincipleOnly, MortgagePrivatePlacement, MiscellaneousPassThru, MunicipalBond, NoIsitcSecurityType, Option, PreferredStock, RepurchaseAgreement, ReverseRepurchaseAgreement, StudentLoanMarketingAssociation, TimeDeposit, UsTreasuryBill, Warrant, CatsTigersLions, WildcardEntry, ConvertibleBond, MortgageIoette, Index, FakeStockForNonStandartOption, Right, Cryptocurrency, ETF, DepositoryReceipt, CoveredWarrant, Unit) |
UnderlyingSecuritySymbol optional | string |
Unit optional | string |
VolumePrecision optional | integer (int32) |
SecuritySignature
Name | Schema |
---|---|
Currency optional | string |
Exchange optional | string |
Symbol optional | string |
SubmitFeedbackModel
Name | Schema |
---|---|
BuildVersion optional | string |
Comment optional | string |
Contacts optional | string |
ImagesToUpload optional | < Base64FileMapModel > array |
Subject optional | string |
SubscriptionModel
Web API notification service subscription representation
Name | Description | Schema |
---|---|---|
Channel optional | Channel for subscription messages delivery | enum (Email, MobileText, MobilePush, WebPopupAlert, Disabled) |
State optional | Subscription state | enum (NotLinked, Active, Suspended, NotVerified) |
SubscriptionType optional | Subscription notification type | enum (OrderExecution, OrderForReview, OrderOnReview, OrderPlacement, OrderReplacement, PriceAlert) |
Succeed
Name | Schema |
---|---|
State optional read-only | string |
Token optional | string |
SupportResistanceMapModel
Name | Schema |
---|---|
Levels optional | < LevelInfoMapModel > array |
ResistancePrice optional | number (double) |
SupportPrice optional | number (double) |
TimeFrameModel
Name | Schema |
---|---|
CandlesCount optional | integer (int32) |
EndDate optional | integer (int32) |
IncludeNonMarketData optional | boolean |
Period optional | string |
StartDate optional | integer (int32) |
TimeSeriesValueCandleMapModel
Name | Schema |
---|---|
Close optional | number (double) |
DateTime optional read-only | string (date-time) |
High optional | number (double) |
IsMarket optional | boolean |
Low optional | number (double) |
Open optional | number (double) |
OpenInterest optional | integer (int32) |
Time optional | integer (int32) |
ValuationLevels optional | < number (double) > array |
Volume optional | number (double) |
TimeZoneInfoItem
Name | Schema |
---|---|
description optional | string |
ianaId optional | string |
name optional | string |
TransactionMapModel
Name | Schema |
---|---|
AccountId optional | integer (int32) |
Date optional | string (date-time) |
Description optional | string |
Fee optional | |
Id optional | integer (int32) |
IsDayTrade optional | boolean |
LeavesQuantity optional | number (double) |
OrderStateId optional | integer (int32) |
Quantity optional | number (double) |
SecurityId optional | integer (int32) |
Type optional | enum (Undefined, Commission, OrderExecution, OptionExpiration, Payment, ManualManipulation, Clearing, Rpl) |
Value optional | number (double) |
Tuple[Int32,String]
Name | Schema |
---|---|
m_Item1 optional | integer (int32) |
m_Item2 optional | string |
Tuple[PhoneNumberModel,Int32]
Name | Schema |
---|---|
m_Item1 optional | |
m_Item2 optional | integer (int32) |
UserAccountModel
Name | Schema |
---|---|
AccessType optional | enum (Full, ReadOnly, ClosePositionsOnly) |
Alias optional | string |
ClearingAccount optional | string |
Enabled optional | boolean |
Id optional | integer (int32) |
MarginType optional | enum (Empty, Cash, Margin, DayTrader, MarginIra) |
UserInfoModel
Name | Schema |
---|---|
AddedDate optional | string (date-time) |
Email optional | string |
FirstName optional | string |
LastName optional | string |
Login optional | string |
MiddleName optional | string |
Salutation optional | enum (NoSalutation, Mr, Mrs, Ms, Dr, Sir, Madam) |
Suffix optional | enum (NoSuffix, Jr, Sr, Second, Third, Fourth) |
UserId optional | integer (int32) |
VerifyOrderModel
Name | Description | Schema |
---|---|---|
Commission optional | The commission of the order. | number (double) |
Commissions optional | The commission of the order. | < string, number (double) > map |
Cost optional | The cost of the order. | number (double) |
ErrorDescription optional | Error description. | string |
ErrorDescriptionArgs optional | Error description arguments. | < string > array |
IsSuccessful optional | Result. | boolean |
MarginChange optional | Expected margin value changed. | number (double) |
NetCost optional | The net cost of the order. | number (double) |
Quotes optional | Order validation quotes. | < QuoteModel > array |
WatchlistModel
Name | Schema |
---|---|
CreateDate optional | string (date-time) |
Description optional | string |
Id optional | integer (int32) |
ModifyDate optional | string (date-time) |
Name optional | string |
ReadOnly optional | boolean |
SecurityList optional | < SecurityModel > array |
Source optional | string |
Type optional | enum (UserList, SystemList, Snapshot) |
WebActionMapModel
Name | Schema |
---|---|
Action optional | string |
Description optional | string |
Id optional | integer (int32) |
Name optional | string |
Parameters optional | < WebActionParameterMapModel > array |
WebActionParameterMapModel
Name | Schema |
---|---|
ActionId optional | integer (int32) |
Id optional | integer (int32) |
Name optional | string |
Type optional | integer (int32) |
Last updated