# Part I ## Definitions ### AccountValueItem | Name | Schema | | ---------------------- | ------------------ | | **Date** *optional* | string (date-time) | | **Value** *optional* | number (double) | ### Base64FileMapModel | Name | Schema | | --------------------- | ------ | | **Data** *optional* | string | | **Name** *optional* | string | | **Type** *optional* | string | ### ChartCompareRequestModel | Name | Schema | | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | **Securities** *optional* | < [SecuritySignature](/rest-api/trading-api/definitions.md#securitysignature) > array | | **SecuritiesHistorySettings** *optional* | [SecurityHistoryRequestSettings](/rest-api/trading-api/definitions.md#securityhistoryrequestsettings) | ### ChartHistoryModel | Name | Schema | | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | **IndicatorsHistory** *optional* | < < [IndicatorHistoryMapModel](/rest-api/trading-api/definitions.md#indicatorhistorymapmodel) > array > array | | **SecurityHistory** *optional* | < < [TimeSeriesValueCandleMapModel](/rest-api/trading-api/definitions.md#timeseriesvaluecandlemapmodel) > array > array | | **SupportResistanceHistory** *optional* | [SupportResistanceMapModel](/rest-api/trading-api/definitions.md#supportresistancemapmodel) | ### ChartHistoryRequestModel | Name | Schema | | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | | **IndicatorsHistorySettings** *optional* | < [IndicatorHistoryRequestSettings](/rest-api/trading-api/definitions.md#indicatorhistoryrequestsettings) > array | | **Security** *optional* | [SecuritySignature](/rest-api/trading-api/definitions.md#securitysignature) | | **SecurityHistorySettings** *optional* | [SecurityHistoryRequestSettings](/rest-api/trading-api/definitions.md#securityhistoryrequestsettings) | ### CreateOrderResource | Name | Description | Schema | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | **ClientId** *optional* | Client order id. | string | | **Exchange** *optional* | Desired exchange. | string | | **ExecInst** *optional* | Execution instruction. | enum (DoNotIncrease, DoNotReduce, AllOrNone) | | **ExecutionInstructions** *optional* | Algo order execution instructions. | < string, string > map | | **ExpireDate** *optional* | Expire date. Assigned by client. | string (date-time) | | **ExtendedHours** *optional* | indicates the extended trading session for GTX order execution (pre-market session, post-market session) if empty - than there is no specific requirement for extended session | string | | **Legs** *optional* | Order legs | < [CreateOrderResource](/rest-api/trading-api/definitions.md#createorderresource) > array | | **Price** *optional* | Price (not used for some order types). | number (double) | | **Quantity** *optional* | Quantity. Assigned by client. **Minimum value** : `0` | number (double) | | **Side** *optional* | Client side comments. | enum (Buy, Sell, SellShort, BuyToCover) | | **StopPrice** *optional* | Stop price (used for stop orders). | number (double) | | **Symbol** *optional* | Security symbol. | string | | **TimeInforce** *optional* | Time in force. | enum (Day, GoodTillCancel, AtTheOpening, ImmediateOrCancel, FillOrKill, GoodTillCrossing, GoodTillDate, GoodTillTime) | | **Token** *optional* | Additional identity key (usid in market scanner). | string | | **TrailingLimitAmount** *optional* | | number (double) | | **TrailingLimitAmountType** *optional* | | enum (Absolute, Persentage) | | **TrailingStopAmount** *optional* | | number (double) | | **TrailingStopAmountType** *optional* | | enum (Absolute, Persentage) | | **Type** *optional* | Type. Assigned by client. | enum (Market, Limit, Stop, StopLimit, Pegged, TrailingStop, TrailingStopLimit, OneCancelOther, OneTriggerOther, OneTriggerOneCancelOther, External) | | **ValidationsToBypass** *optional* | Flag property indicating validation rules to bypass | integer (int32) | ### CreateWatchlistModel | Name | Schema | | --------------------------- | ------------------------- | | **Name** *optional* | string | | **Securities** *optional* | < integer (int32) > array | ### EarningInfo | Name | Schema | | ------------------------ | --------------- | | **Percent** *optional* | number (double) | | **Value** *optional* | number (double) | ### EditableHotkeyModel | Name | Schema | | --------------------------------- | ------------------------------------------------------------------------------------------------- | | **ActionId** *optional* | integer (int32) | | **Description** *optional* | string | | **KeyboardShortcut** *optional* | string | | **Parameters** *optional* | < [HotkeyParameterMapModel](/rest-api/trading-api/definitions.md#hotkeyparametermapmodel) > array | ### EquityResource | Name | Schema | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **AddedDate** *optional* | string (date-time) | | **AllowMargin** *optional* | boolean | | **AllowShort** *optional* | boolean | | **AllowTrade** *optional* | boolean | | **Currency** *optional* | string | | **Description** *optional* | string | | **Enabled** *optional* | boolean | | **Exchange** *optional* | string | | **Id** *optional* | integer (int32) | | **ModifyDate** *optional* | string (date-time) | | **Precision** *optional* | integer (int32) | | **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) | | **VolumePrecision** *optional* | integer (int32) | ### Expecting | Name | Schema | | ------------------------------------ | ------ | | **Reason** *optional* | string | | **State** *optional* *read-only* | string | | **Step** *optional* | string | | **Token** *optional* | string | ### Failed | Name | Schema | | ------------------------------------ | ------ | | **Reason** *optional* | string | | **State** *optional* *read-only* | string | | **Step** *optional* | string | ### FeeModel | Name | Schema | | ----------------------------- | ------------------------------------------------------ | | **CommissionId** *optional* | string | | **Id** *optional* | integer (int32) | | **Leverage** *optional* | number (double) | | **Seizure** *optional* | enum (Placement, Execution, Fill, Proportional, Order) | | **Value** *optional* | number (double) | | **ValueType** *optional* | enum (Absolute, Coefficient) | ### Formula Formula model | Name | Schema | | --------------------------- | --------------- | | **Expression** *optional* | string | | **Id** *optional* | integer (int32) | | **Name** *optional* | string | ### FrameParams | Name | Schema | | ------------------------------ | --------------- | | **Description** *optional* | string | | **Name** *optional* | string | | **TargetPercent** *optional* | number (double) | | **Tolerance** *optional* | number (double) | ### HistoricalTradeDataExportDataModel | Name | Schema | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **DefaultFileName** *optional* | string | | **Indicators** *optional* | < [HistoricalTradeDataExportIndicatorModel](/rest-api/trading-api/definitions.md#historicaltradedataexportindicatormodel) > array | | **Securities** *optional* | < integer (int32) > array | | **TimeFrame** *optional* | [TimeFrameModel](/rest-api/trading-api/definitions.md#timeframemodel) | ### HistoricalTradeDataExportIndicatorModel | Name | Schema | | --------------------- | ---------------- | | **Args** *optional* | < object > array | | **Name** *optional* | string | | **Text** *optional* | string | | **Type** *optional* | string | ### HotkeyMapModel | Name | Schema | | --------------------------------- | ------------------------------------------------------------------------------------------------- | | **ActionId** *optional* | integer (int32) | | **ActionName** *optional* | string | | **ActionResource** *optional* | [WebActionMapModel](/rest-api/trading-api/definitions.md#webactionmapmodel) | | **Description** *optional* | string | | **Id** *optional* | integer (int32) | | **KeyboardShortcut** *optional* | string | | **Parameters** *optional* | < [HotkeyParameterMapModel](/rest-api/trading-api/definitions.md#hotkeyparametermapmodel) > array | ### HotkeyParameterMapModel | Name | Schema | | ------------------------------ | --------------- | | **HotkeyId** *optional* | integer (int32) | | **Id** *optional* | integer (int32) | | **ParameterId** *optional* | integer (int32) | | **ParameterName** *optional* | string | | **ParameterType** *optional* | integer (int32) | | **Value** *optional* | string | ### IFileUpload | Name | Description | Schema | | | ---------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------- | | **Data** *optional* | **Pattern** : \`"^(?:\[A-Za-z0-9+/]{4})\*(?:\[A-Za-z0-9+/]{2}==\\ | \[A-Za-z0-9+/]{3}=)?$"\` | string (byte) | | **Description** *optional* | | string | | | **FileKey** *optional* | | string | | | **FileName** *optional* | | string | | | **Id** *optional* | | integer (int32) | | | **Timestamp** *optional* | | string (date-time) | | | **Type** *optional* | | enum (Other, ImageJpeg, ImageGif, ImagePng, ImageBitmap, ImageIco, TextHtml, TextPlain, VideoMpeg, VideoQuicktime) | | ### ISecurity | Name | Schema | | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **AddedDate** *optional* *read-only* | string (date-time) | | **AllowMargin** *optional* *read-only* | boolean | | **AllowShort** *optional* *read-only* | boolean | | **AllowTrade** *optional* *read-only* | boolean | | **BaseCurrency** *optional* *read-only* | string | | **CmsSuffix** *optional* *read-only* | string | | **ContractSize** *optional* *read-only* | number (double) | | **CqsSuffix** *optional* *read-only* | string | | **Currency** *optional* *read-only* | string | | **Cusip** *optional* *read-only* | string | | **Description** *optional* *read-only* | string | | **Enabled** *optional* *read-only* | boolean | | **Exchange** *optional* *read-only* | string | | **ExpirationDate** *optional* *read-only* | string (date-time) | | **ExpirationName** *optional* *read-only* | string | | **ExpirationType** *optional* *read-only* | enum (Regular, Quarterly, Weekly, Flex, Undefined, Mini, NonStandard) | | **Id** *optional* *read-only* | integer (int32) | | **Industry** *optional* *read-only* | string | | **Isin** *optional* *read-only* | string | | **Leverage** *optional* *read-only* | number (double) | | **MarginRate** *optional* *read-only* | number (double) | | **ModifyDate** *optional* *read-only* | string (date-time) | | **Name** *optional* *read-only* | string | | **NasdaqSuffix** *optional* *read-only* | string | | **OptionType** *optional* *read-only* | enum (Call, Put, Undefined) | | **ParentId** *optional* *read-only* | integer (int32) | | **Precision** *optional* *read-only* | integer (int32) | | **Price** *optional* *read-only* | number (double) | | **QuoteSubscriptionKey** *optional* *read-only* | string | | **Sector** *optional* *read-only* | string | | **Sedol** *optional* *read-only* | string | | **SeriesId** *optional* *read-only* | integer (int32) | | **Source** *optional* *read-only* | integer (int32) | | **SourceId** *optional* *read-only* | string | | **StrikePrice** *optional* *read-only* | number (double) | | **Suffix** *optional* *read-only* | string | | **Symbol** *optional* *read-only* | string | | **TickSize** *optional* *read-only* | number (double) | | **Type** *optional* *read-only* | 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* *read-only* | string | | **Unit** *optional* *read-only* | string | | **VolumePrecision** *optional* *read-only* | integer (int32) | ### IndicatorHistoryMapModel | Name | Schema | | ----------------------- | ------------------------- | | **Date** *optional* | integer (int32) | | **Values** *optional* | < number (double) > array | ### IndicatorHistoryRequestSettings | Name | Schema | | ------------------------------------- | --------------- | | **CandlesCount** *optional* | integer (int32) | | **EndDate** *optional* | integer (int32) | | **IncludeNonMarketData** *optional* | boolean | | **Interval** *optional* | integer (int32) | | **Offset** *optional* | integer (int32) | | **Period** *optional* | string | | **Signature** *optional* | string | | **StartDate** *optional* | integer (int32) | ### LevelInfoMapModel | Name | Schema | | ----------------------------- | ------------------------- | | **BottomPrice** *optional* | number (double) | | **GreenCandles** *optional* | < integer (int32) > array | | **RedCandles** *optional* | < integer (int32) > array | | **TopPrice** *optional* | number (double) | ### ModifyOrderResource Modify order parameters | Name | Description | Schema | | ---------------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | **ClientId** *optional* | Client order id. | string | | **ExecutionInstructions** *optional* | Algo order execution instructions. | < string, string > map | | **ExpireDate** *optional* | Expire date. Assigned by client. | string (date-time) | | **Id** *required* | Internal order id. **Minimum value** : `1` **Maximum value** : `2147483647` | integer (int32) | | **Legs** *optional* | Order legs | < [ModifyOrderResource](/rest-api/trading-api/definitions.md#modifyorderresource) > array | | **Price** *optional* | Price (not used for some order types). | number (double) | | **Quantity** *optional* | Quantity. Assigned by client. **Minimum value** : `0` | number (double) | | **StopPrice** *optional* | Stop price (used for stop orders). | number (double) | | **TrailingLimitAmount** *optional* | | number (double) | | **TrailingLimitAmountType** *optional* | | enum (Absolute, Persentage) | | **TrailingStopAmount** *optional* | | number (double) | | **TrailingStopAmountType** *optional* | | enum (Absolute, Persentage) | | **ValidationsToBypass** *optional* | Flag property indicating validation rules to bypass | integer (int32) | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api-documentation.autoshares.dev/rest-api/trading-api/definitions/part-i.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.