Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
- improved code example
- codified some strings
- link to Test project
  • Loading branch information
vslee authored Nov 23, 2019
1 parent dbd8d2b commit db42687
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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+
This library currently targets `netstandard20`. Thus, it can be used with `.net framework 4.6.1`+ and `.net core 2.0`+

## Usage
![](https://github.com/vslee/iexsharp/workflows/prerelease%20NuGet/badge.svg) Prerelease packages are on [GH Packages](https://github.com/vslee/IEXSharp/packages).
Expand All @@ -24,8 +24,8 @@ IEXCloudClient iexClient = new IEXCloudClient("publishToken", "secretToken", fal
```
To use SSE streaming (only included with paid IEX subscription plans)
```c#
using (var sseClient = iexClient.SSE.SubscribeStockQuoteUSSSE(
symbols.Cast<string>(), UTP: false, interval: StockQuoteSSEInterval.OneSecond))
using (var sseClient = iexClient.SSE.SubscribeStockQuoteUSSSE(symbols: new string[] { "spy", "aapl" },
UTP: false, interval: StockQuoteSSEInterval.OneSecond))
{
sseClient.Error += (s, e) =>
{
Expand All @@ -35,11 +35,11 @@ using (var sseClient = iexClient.SSE.SubscribeStockQuoteUSSSE(
{
Console.WriteLine(m.ToString());
};
await sseClient.StartAsync(); // this will block unless cancelled
await sseClient.StartAsync(); // this will block until cancelled
}

```
Additional usage examples are illustrated in the test project: `IEXSharpTest`
Additional usage examples are illustrated in the test project: [`IEXSharpTest`](https://github.com/vslee/IEXSharp/tree/master/IEXSharpTest/Cloud(V2))

### Legacy (V1)

Expand All @@ -60,11 +60,11 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md

Data provided for free by [IEX](https://iextrading.com/developer/) via their [IEX Cloud API](https://iexcloud.io/docs/api/)
Per their [guidelines](https://iexcloud.io/docs/api/#disclaimers):
- 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.
- 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](https://iexsharp.pythonanywhere.com/)

## Acknowledgments

* Thanks to [Zhirong Huang (ZHCode)](https://zh-code.com/) for his great foundational work on this library
* Thanks to [Zhirong Huang (ZHCode)](https://zh-code.com/) for his great foundational work on this library

0 comments on commit db42687

Please sign in to comment.