Class OptionChainRequest

Encapsulates data for latest options data requests on Alpaca Data API v2.

Inheritance
System.Object
OptionChainRequest
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 OptionChainRequest

Constructors

| Improve this Doc View Source

OptionChainRequest(String)

Creates new instance of OptionChainRequest object.

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

Option underlying symbol for data retrieval.

Properties

| 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

OptionsFeed

Gets options feed for data retrieval.

Declaration
public OptionsFeed? OptionsFeed { get; set; }
Property Value
Type Description
System.Nullable<OptionsFeed>
| 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

UnderlyingSymbol

Gets options symbols list for data retrieval.

Declaration
public String UnderlyingSymbol { get; }
Property Value
Type Description
String