VSLee.IEXSharp 1.2.0

IEX Cloud API for C# and other .net languages. Supports SSE streaming

Install-Package VSLee.IEXSharp -Version 1.2.0
dotnet add package VSLee.IEXSharp --version 1.2.0
<PackageReference Include="VSLee.IEXSharp" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add VSLee.IEXSharp --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

IEXSharp

IEX Cloud API for C# and other .net languages. Supports SSE streaming

Prerequisites

This library currently targets netstandard20. Thus, it can be used with .net framework 4.6.1+ and .net core 2.0+

Usage

Prerelease packages are on GH Packages.

NuGet Badge Releases are on NuGet

IEX Cloud

public IEXCloudClient(string publishableToken, string secretToken, bool signRequest, bool useSandBox, APIVersion version = APIVersion.stable)

First, create an instance of IEXCloudClient

//For FREE and LAUNCH users
IEXCloudClient iexClient = new IEXCloudClient("publishableToken", "secretToken", signRequest: false, useSandBox: false); 

//For SCALE and GROW users
IEXCloudClient iexClient = new IEXCloudClient("publishableToken", "secretToken", signRequest: true, useSandBox: false); 

//Sandbox
IEXCloudClient iexClient = new IEXCloudClient("publishableToken", "secretToken", signRequest: false, useSandBox: true); 

To use SSE streaming (only included with paid IEX subscription plans)

using (var sseClient = iexClient.SSE.SubscribeStockQuoteUSSSE(symbols: new string[] { "spy", "aapl" }, 
	UTP: false, interval: StockQuoteSSEInterval.OneSecond))
{
	sseClient.Error += (s, e) =>
	{
		Console.WriteLine("Error Occurred. Details: {0}", e.Exception.Message);
	};
	sseClient.MessageReceived += m =>
	{
		Console.WriteLine(m.ToString());
	};
	await sseClient.StartAsync(); // this will block until cancelled
}

Additional usage examples are illustrated in the test project: IEXSharpTest

Legacy (V1)

IEX has deprecated most of their legacy API. However, some functions are still active and you can access them via:

IEXV1RestClient iexClient = new IEXV1RestClient();

Contributing

We welcome pull requests! See CONTRIBUTING.md.

License

MIT License - LICENSE.md

Disclaimers

Data provided for free by IEX via their IEX Cloud API
Per their guidelines:

  • Required: If you display any delayed price data, you must display “15 minute delayed price” as a disclaimer.
  • Required: If you display latestVolume you must display “Consolidated Volume in Real-time” as a disclaimer.
  • Note on pricing data: All CTA and UTP pricing data is delayed at least 15 minutes.

This project is not related to the similarly named IEX-Sharp

Acknowledgments

IEXSharp

IEX Cloud API for C# and other .net languages. Supports SSE streaming

Prerequisites

This library currently targets netstandard20. Thus, it can be used with .net framework 4.6.1+ and .net core 2.0+

Usage

Prerelease packages are on GH Packages.

NuGet Badge Releases are on NuGet

IEX Cloud

public IEXCloudClient(string publishableToken, string secretToken, bool signRequest, bool useSandBox, APIVersion version = APIVersion.stable)

First, create an instance of IEXCloudClient

//For FREE and LAUNCH users
IEXCloudClient iexClient = new IEXCloudClient("publishableToken", "secretToken", signRequest: false, useSandBox: false); 

//For SCALE and GROW users
IEXCloudClient iexClient = new IEXCloudClient("publishableToken", "secretToken", signRequest: true, useSandBox: false); 

//Sandbox
IEXCloudClient iexClient = new IEXCloudClient("publishableToken", "secretToken", signRequest: false, useSandBox: true); 

To use SSE streaming (only included with paid IEX subscription plans)

using (var sseClient = iexClient.SSE.SubscribeStockQuoteUSSSE(symbols: new string[] { "spy", "aapl" }, 
	UTP: false, interval: StockQuoteSSEInterval.OneSecond))
{
	sseClient.Error += (s, e) =>
	{
		Console.WriteLine("Error Occurred. Details: {0}", e.Exception.Message);
	};
	sseClient.MessageReceived += m =>
	{
		Console.WriteLine(m.ToString());
	};
	await sseClient.StartAsync(); // this will block until cancelled
}

Additional usage examples are illustrated in the test project: IEXSharpTest

Legacy (V1)

IEX has deprecated most of their legacy API. However, some functions are still active and you can access them via:

IEXV1RestClient iexClient = new IEXV1RestClient();

Contributing

We welcome pull requests! See CONTRIBUTING.md.

License

MIT License - LICENSE.md

Disclaimers

Data provided for free by IEX via their IEX Cloud API
Per their guidelines:

  • Required: If you display any delayed price data, you must display “15 minute delayed price” as a disclaimer.
  • Required: If you display latestVolume you must display “Consolidated Volume in Real-time” as a disclaimer.
  • Note on pricing data: All CTA and UTP pricing data is delayed at least 15 minutes.

This project is not related to the similarly named IEX-Sharp

Acknowledgments

Release Notes

https://github.com/vslee/IEXSharp/releases

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.2.0 46 3/24/2020
1.1.0 272 11/24/2019