m8ty-dto - m8ty Data Transfer Objects/eu.m8ty.dtos.securities

Package-level declarations

Types

data class DescriptionDto(var language: String? = null, var description: String? = null, var descriptionShort: String? = null)

Provides a description, if available. The language of the description can be determined via the Accept-Language header using an ISO 3166 alpha-2 code. If there is no description in the language, a default language is used. The actual language supplied is defined via the language field.

DescriptionSimpleDto

data class DescriptionSimpleDto(var language: String? = null, var description: String? = null)

MaturityDto

data class MaturityDto(var maturityDate: LocalDate? = null, var rate: BigDecimal? = null, var daysUntilMaturity: Int? = null, var yieldToMaturity: BigDecimal? = null)

Details for the maturity date

SecuritiesSearchRequestDto

data class SecuritiesSearchRequestDto(var isin: String? = null, var securityNumber: String? = null, var name: String? = null, var securityType: String? = null)

Object with the data for an order.

SecurityDetailsDto

data class SecurityDetailsDto(var currency: String? = null, var currencyRisk: MutableList<String>? = null, var dividendFrequency: DividendFrequencyEnumDto? = null, var maturity: MaturityDto? = null, var modifiedDuration: BigDecimal? = null, var tradingProperties: TradingPropertiesDto? = null, var securityRating: SecurityRatingDto? = null, var withdrawalInformation: WithdrawalDto? = null)

Details of the security.

SecurityListingResponseDto

data class SecurityListingResponseDto(var id: String, var rate: BigDecimal, var securitySymbol: String? = null, var roundLot: BigDecimal? = null, var rateDatetime: OffsetDateTime? = null)

The securities listing specifies on which marketplaces and in which currencies the securities are traded. This object also contains the associated security symbol and the prices of the security on the specified trading venues.

SecurityListingSearchRequestDto

data class SecurityListingSearchRequestDto(var securityId: String? = null, var stockExchangeId: String? = null)

Search query to list securities to which the user has access.

SecurityListingSearchResponseDto

data class SecurityListingSearchResponseDto(var securityListings: MutableList<SecurityListingResponseDto>? = null, var page: PageDto? = null)

Overview of the securities list to which the user has access.

SecurityOptionTypeEnumDto

enum SecurityOptionTypeEnumDto : Enum<SecurityOptionTypeEnumDto>

Describes which type of option was used. This field is only filled for options.

CALL - The holder of a call option has the right, but not the obligation, to buy at a price agreed in advance in a quantity agreed in advance at the time of exercise.
PUT - The holder of a put option has the right, but not the obligation, to sell a specified quantity of a specified underlying asset at a predetermined price within a specified period (American options) or at a specified time (European options).
NONE - No option.

Values: CALL,PUT,NONE

SecurityOrderTypeEnumDto

enum SecurityOrderTypeEnumDto : Enum<SecurityOrderTypeEnumDto>

Type of limit:

MARKET_PRICE - It is only possible to buy or sell immediately, regardless of the limit.
LIMITED - Trade is only allowed to be limited.
STOP_LOSS - A transaction may not be executed at a price that is below the specified limit.
STOP_LIMIT - Only limited trading with triggers is permitted.

Values: MARKET_PRICE,LIMITED,STOP_LOSS,STOP_LIMIT

SecurityRatingDto

data class SecurityRatingDto(var rating: String? = null, var source: String? = null)

Rating of the security.

SecurityResponseDto

data class SecurityResponseDto(var id: String, var isin: String? = null, var securityNumber: String? = null, var name: String? = null, var description: DescriptionDto? = null, var details: SecurityDetailsDto? = null)

Describes a security with its values and trading capabilities.

SecuritySearchResponseDto

data class SecuritySearchResponseDto(var securities: MutableList<SecurityResponseDto>, var page: PageDto)

Object containing the result of the search for securities.

SecurityTradingRestrictionEnumDto

enum SecurityTradingRestrictionEnumDto : Enum<SecurityTradingRestrictionEnumDto>

Restrictions on buying or selling.

UNRESTRICTED - No restrictions are available.
BUY_ONLY - Can only be bought.
SELL_ONLY - Can only be sold.

Values: UNRESTRICTED,BUY_ONLY,SELL_ONLY

SecurityTypeListResponseDto

data class SecurityTypeListResponseDto(var securitytypes: MutableList<SecurityTypeResponseDto>, var page: PageDto)

Provides an overview of all available security types.

SecurityTypeResponseDto

data class SecurityTypeResponseDto(var id: String? = null, var code: String? = null, var description: DescriptionSimpleDto? = null)

Information about a security type with description.

SecurityValueDto

data class SecurityValueDto(var value: BigDecimal? = null, var valueType: ValueTypeEnumDto? = null)

Value of a security with the corresponding unit.

StockExchangeOpeningHoursDto

data class StockExchangeOpeningHoursDto(var openingTime: String? = null, var lunchTime: String? = null, var afternoonOpeningTime: String? = null, var closingTime: String? = null)

Opening hours of the stock exchange.

StockExchangeResponseDto

data class StockExchangeResponseDto(var id: String, var code: String, var country: String, var tradingOptions: StockExchangeTradingOptionsDto, var name: String? = null, var description: DescriptionDto? = null, var openingHours: StockExchangeOpeningHoursDto? = null)

Details of a stock exchange.

StockExchangeSearchRequestDto

data class StockExchangeSearchRequestDto(var code: String? = null)

Request with search parameters for the search for stock exchanges.

StockExchangeSearchResponseDto

data class StockExchangeSearchResponseDto(var page: PageDto, var stockexchanges: MutableList<StockExchangeResponseDto>? = null)

Request with search parameters for the search for stock exchanges.

StockExchangeTradingOptionsDto

data class StockExchangeTradingOptionsDto(var tradingAllowed: Boolean, var onlineTradingAllowed: Boolean, var executionDeadline: String? = null)

Options available in the stock exchange.

TradingPropertiesDto

data class TradingPropertiesDto(var tradable: Boolean? = null, var tradeUnit: BigDecimal? = null, var optionType: SecurityOptionTypeEnumDto? = null, var securityValue: SecurityValueDto? = null, var strikePrice: AmountDto? = null, var orderType: MutableList<SecurityOrderTypeEnumDto>? = null, var restrictions: SecurityTradingRestrictionEnumDto? = null, var usQIAgreementRequired: Boolean? = null)

Properties that are relevant for trading. Additional Information Strike Price

The strike price of an option determines the price of the underlying asset at which the option can be exercised. In the case of call options, the buyer has the right to buy the underlying asset (e.g. shares) at the strike price. With put options, on the other hand, he can sell the underlying asset at the strike price.

ValueTypeEnumDto

enum ValueTypeEnumDto : Enum<ValueTypeEnumDto>

Describes the type of value.

NOMINAL - Type of nominal value is expressed as a decimal value (e.g. monetary value)
NOMIMAL_PERCENT - The type of percentage nominal value is expressed as a decimal number and represents a percentage.
PIECE - The piece refers to the physical nature of securities (e.g. certificate securities), the value here is an integer.
HOLDING - Type of holding value refers to debt or equity and represents the dividend as a decimal number.

WithdrawalDto

data class WithdrawalDto(var interestRate: BigDecimal? = null, var interestPeriod: Int? = null)

Information about security withdrawal.