Class OptionContractsRequest

Encapsulates request parameters for ListOptionContractsAsync(OptionContractsRequest, CancellationToken) call.

Inheritance
System.Object
OptionContractsRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Alpaca.Markets
Assembly: Alpaca.Markets.dll
Syntax
public sealed class OptionContractsRequest

Constructors

| Improve this Doc View Source

OptionContractsRequest()

Creates new instance of OptionContractsRequest object.

Declaration
public OptionContractsRequest()
| Improve this Doc View Source

OptionContractsRequest(IEnumerable<String>)

Creates new instance of OptionContractsRequest object.

Declaration
public OptionContractsRequest(IEnumerable<String> underlyingSymbols)
Parameters
Type Name Description
IEnumerable<String> underlyingSymbols

The symbols list of the underlying asset for filtering.
| Improve this Doc View Source

OptionContractsRequest(String)

Creates new instance of OptionContractsRequest object.

Declaration
public OptionContractsRequest(String underlyingSymbol)
Parameters
Type Name Description
String underlyingSymbol

The symbol of the underlying asset for filtering.

Properties

| Improve this Doc View Source

AssetStatus

Gets or sets filter by the asset status. By default, only active contracts are returned.

Declaration
public AssetStatus? AssetStatus { get; set; }
Property Value
Type Description
System.Nullable<AssetStatus>
| Improve this Doc View Source

ExpirationDateEqualTo

Gets or sets filter by the exact option contract expiration date.

Declaration
public DateOnly? ExpirationDateEqualTo { get; set; }
Property Value
Type Description
System.Nullable<DateOnly>
| Improve this Doc View Source

ExpirationDateGreaterThanOrEqualTo

Gets or sets filter by the expiration date greater than or equal to the specified value.

Declaration
public DateOnly? ExpirationDateGreaterThanOrEqualTo { get; set; }
Property Value
Type Description
System.Nullable<DateOnly>
| Improve this Doc View Source

ExpirationDateLessThanOrEqualTo

Gets or sets filter by the expiration date less than or equal to the specified value.

Declaration
public DateOnly? ExpirationDateLessThanOrEqualTo { get; set; }
Property Value
Type Description
System.Nullable<DateOnly>
| Improve this Doc View Source

OptionStyle

Gets or sets filter the option contract execution style.

Declaration
public OptionStyle? OptionStyle { get; set; }
Property Value
Type Description
System.Nullable<OptionStyle>
| Improve this Doc View Source

OptionType

Gets or sets filter the option contract type.

Declaration
public OptionType? OptionType { get; set; }
Property Value
Type Description
System.Nullable<OptionType>
| Improve this Doc View Source

Pagination

Gets the pagination parameters for the request (page size and token).

Declaration
public Pagination Pagination { get; }
Property Value
Type Description
Pagination
| Improve this Doc View Source

RootSymbol

Gets or sets filter ty the root symbol.

Declaration
public String? RootSymbol { get; set; }
Property Value
Type Description
System.Nullable<String>
| Improve this Doc View Source

StrikePriceGreaterThanOrEqualTo

Gets or sets filter by the strike price greater than or equal to the specified value.

Declaration
public Decimal? StrikePriceGreaterThanOrEqualTo { get; set; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

StrikePriceLessThanOrEqualTo

Gets or sets filter by the strike price less than or equal to the specified value.

Declaration
public Decimal? StrikePriceLessThanOrEqualTo { get; set; }
Property Value
Type Description
System.Nullable<Decimal>
| Improve this Doc View Source

UnderlyingSymbols

Gets the symbols list of the underlying asset for filtering.

Declaration
public IReadOnlyCollection<String> UnderlyingSymbols { get; }
Property Value
Type Description
IReadOnlyCollection<String>