Class OptionsContract

Namespace

MassiveDotNet.Rest.Models

Assembly

MassiveDotNet.Rest.dll

An options contract's terms: its ticker and underlying, whether it is a call or a put, its style, expiration, strike, and share count, and any additional underlyings from a corporate action.

public sealed record OptionsContract : IEquatable<OptionsContract>

Inheritance

object

OptionsContract

Implements

IEquatable<OptionsContract>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Reference data, so a class (decision D4). Declared from the list and reused as the payload of GetOptionsContractAsync(string, LocalDate?, CancellationToken), where the generator verifies the shape (decision D16). ContractType is the wire string, call or put; the request-side enum ContractType is for filtering. ExpirationDate is a bare string in the description and an ISO calendar date on the wire (D-R9).

Properties

AdditionalUnderlyings

If an option contract has additional underlyings or deliverables associated with it, they will appear here. See here for some examples of what might cause a contract to have additional underlyings.

[JsonPropertyName("additional_underlyings")]
[JsonConverter(typeof(PooledArrayConverter<AdditionalUnderlying>))]
public AdditionalUnderlying[]? AdditionalUnderlyings { get; init; }

Property Value

AdditionalUnderlying[]

Cfi

The 6 letter CFI code of the contract (defined in ISO 10962)

[JsonPropertyName("cfi")]
public string? Cfi { get; init; }

Property Value

string

ContractType

The type of contract. Can be "put", "call", or in some rare cases, "other".

[JsonPropertyName("contract_type")]
public string? ContractType { get; init; }

Property Value

string

Correction

The correction number for this option contract.

[JsonPropertyName("correction")]
public int? Correction { get; init; }

Property Value

int?

ExerciseStyle

The exercise style of this contract. See this link for more details on exercise styles.

[JsonPropertyName("exercise_style")]
public string? ExerciseStyle { get; init; }

Property Value

string

ExpirationDate

The contract's expiration date. The description types this a bare string; the wire carries an ISO calendar date (D-R9).

[JsonPropertyName("expiration_date")]
public LocalDate? ExpirationDate { get; init; }

Property Value

LocalDate?

PrimaryExchange

The MIC code of the primary exchange that this contract is listed on.

[JsonPropertyName("primary_exchange")]
public string? PrimaryExchange { get; init; }

Property Value

string

SharesPerContract

The number of shares per contract for this contract.

[JsonPropertyName("shares_per_contract")]
public double? SharesPerContract { get; init; }

Property Value

double?

StrikePrice

The strike price of the option contract.

[JsonPropertyName("strike_price")]
public double? StrikePrice { get; init; }

Property Value

double?

Ticker

The ticker for the option contract.

[JsonPropertyName("ticker")]
public string? Ticker { get; init; }

Property Value

string

UnderlyingTicker

The underlying ticker that the option contract relates to.

[JsonPropertyName("underlying_ticker")]
public string? UnderlyingTicker { get; init; }

Property Value

string