IOptionChainsResource.GetListAsync Method (DateTime, String, Nullable(Boolean), MarketParameters, CancellationToken)

IOptionChainsResourceGetListAsync Method (DateTime, String, NullableBoolean, MarketParameters, CancellationToken)

Note: This is preliminary documentation provided only as a preview, and is subject to change. Please contact the author for pricing and licensing information.

Returns a list of option chains associated with a specific underlier.

Namespace: ETradeNet.Market.OptionChains
Assembly: ETradeNet.Market (in ETradeNet.Market.dll) Version: 1.0.5793.41727

Syntax

C++

Copy

Task<IGetListResponse> GetListAsync(
	DateTime expirationDate,
	string underlier,
	Nullable<bool> skipAdjusted,
	MarketParameters parameters,
	CancellationToken cancellationToken
)

Function GetListAsync ( 
	expirationDate As DateTime,
	underlier As String,
	skipAdjusted As Nullable(Of Boolean),
	parameters As MarketParameters,
	cancellationToken As CancellationToken
) As Task(Of IGetListResponse)

Task<IGetListResponse^>^ GetListAsync(
	DateTime expirationDate, 
	String^ underlier, 
	Nullable<bool> skipAdjusted, 
	MarketParameters^ parameters, 
	CancellationToken cancellationToken
)

abstract GetListAsync : 
        expirationDate : DateTime * 
        underlier : string * 
        skipAdjusted : Nullable<bool> * 
        parameters : MarketParameters * 
        cancellationToken : CancellationToken -> Task<IGetListResponse>

Parameters

expirationDate: Type: SystemDateTime
The year and month the option will expire; the day value is ignored. Required.
underlier: Type: SystemString
The market symbol for the underlying security. Required.
skipAdjusted: Type: SystemNullableBoolean
Specifies whether to show adjusted options, i.e., options that have undergone a change resulting in a modification of the option contract.
parameters: Type: ETradeNet.MarketMarketParameters
Common parameters.
cancellationToken: Type: System.ThreadingCancellationToken
Cancellation token.

Return Value

Type: TaskIGetListResponse
GetList method response (asynchronous task).

Exceptions

Exception	Condition
ETradeException	E*TRADE API exception.
HttpRequestException	Network error.
ArgumentNullException	Null argument value (underlier).
ArgumentException	Argument value does not adhere to the specification (parameters).
OperationCanceledException	Asynchronous task canceled (cancellationToken).
ObjectDisposedException	Disposed object accessed (cancellationToken).

Reference

IOptionChainsResource Interface

GetListAsync Overload

ETradeNet.Market.OptionChains Namespace