Show / Hide Table of Contents

Class ConfigurationExtensions

Set of extensions methods for creating strongly-typed Alpaca REST API clients.

Inheritance
System.Object
ConfigurationExtensions
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.Extensions
Assembly: Alpaca.Markets.dll
Syntax
public static class ConfigurationExtensions

Methods

| Improve this Doc View Source

GetClient(AlpacaCryptoDataClientConfiguration)

Creates a new instance of IAlpacaCryptoDataClient interface implementation using the configuration argument.

Declaration
public static IAlpacaCryptoDataClient GetClient(this AlpacaCryptoDataClientConfiguration configuration)
Parameters
Type Name Description
AlpacaCryptoDataClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaCryptoDataClient

A new instance of IAlpacaCryptoDataClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaCryptoStreamingClientConfiguration)

Creates a new instance of IAlpacaCryptoStreamingClient interface implementation using the configuration argument.

Declaration
public static IAlpacaCryptoStreamingClient GetClient(this AlpacaCryptoStreamingClientConfiguration configuration)
Parameters
Type Name Description
AlpacaCryptoStreamingClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaCryptoStreamingClient

A new instance of IAlpacaCryptoStreamingClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaDataClientConfiguration)

Creates a new instance of IAlpacaDataClient interface implementation using the configuration argument.

Declaration
public static IAlpacaDataClient GetClient(this AlpacaDataClientConfiguration configuration)
Parameters
Type Name Description
AlpacaDataClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaDataClient

A new instance of IAlpacaDataClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaDataStreamingClientConfiguration)

Creates a new instance of IAlpacaDataStreamingClient interface implementation using the configuration argument.

Declaration
public static IAlpacaDataStreamingClient GetClient(this AlpacaDataStreamingClientConfiguration configuration)
Parameters
Type Name Description
AlpacaDataStreamingClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaDataStreamingClient

A new instance of IAlpacaDataStreamingClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaNewsStreamingClientConfiguration)

Creates a new instance of IAlpacaNewsStreamingClient interface implementation using the configuration argument.

Declaration
public static IAlpacaNewsStreamingClient GetClient(this AlpacaNewsStreamingClientConfiguration configuration)
Parameters
Type Name Description
AlpacaNewsStreamingClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaNewsStreamingClient

A new instance of IAlpacaNewsStreamingClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaOptionsDataClientConfiguration)

Creates a new instance of IAlpacaOptionsDataClient interface implementation using the configuration argument.

Declaration
public static IAlpacaOptionsDataClient GetClient(this AlpacaOptionsDataClientConfiguration configuration)
Parameters
Type Name Description
AlpacaOptionsDataClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaOptionsDataClient

A new instance of IAlpacaOptionsDataClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaStreamingClientConfiguration)

Creates a new instance of IAlpacaStreamingClient interface implementation using the configuration argument.

Declaration
public static IAlpacaStreamingClient GetClient(this AlpacaStreamingClientConfiguration configuration)
Parameters
Type Name Description
AlpacaStreamingClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaStreamingClient

A new instance of IAlpacaStreamingClient interface implementation.

| Improve this Doc View Source

GetClient(AlpacaTradingClientConfiguration)

Creates a new instance of IAlpacaTradingClient interface implementation using the configuration argument.

Declaration
public static IAlpacaTradingClient GetClient(this AlpacaTradingClientConfiguration configuration)
Parameters
Type Name Description
AlpacaTradingClientConfiguration configuration

Client configuration parameters.

Returns
Type Description
IAlpacaTradingClient

A new instance of IAlpacaTradingClient interface implementation.

| Improve this Doc View Source

WithHttpMessageHandlerFactory<TClientConfiguration>(TClientConfiguration, Func<HttpMessageHandler, HttpMessageHandler>)

Creates a new instance of TClientConfiguration object with configured custom factory method.

Declaration
public static TClientConfiguration WithHttpMessageHandlerFactory<TClientConfiguration>(this TClientConfiguration configuration, Func<HttpMessageHandler, HttpMessageHandler> httpMessageHandlerFactory)
    where TClientConfiguration : AlpacaClientConfigurationBase
Parameters
Type Name Description
TClientConfiguration configuration

Client configuration parameters.

Func<HttpMessageHandler, HttpMessageHandler> httpMessageHandlerFactory

Factory method for creating custom (delegating) instance of inheritor.

Returns
Type Description
TClientConfiguration

An original configuration object with configured factory method.

Type Parameters
Name Description
TClientConfiguration

Type of configuration parameters.

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX