pviotti/finnhub-dotnet

A .NET client for Finnhub API

Finnhub API .NET Client

A .NET client for Finnhub API. It's written in F# and only supports .NET 5+ since it uses System.Text.JSON and the JSON HTTP extension from its standard library.

👷 At the moment only some APIs are supported (mainly the non-Premium ones, see here). There isn't any technical reason preventing the implementation of the other APIs, and I welcome contributions.

ℹ️ As an alternative to this library, you can also use a .NET client automatically generated from the Finnhub OpenAPI specification using the Microsoft.dotnet-openapi tool -- see the generated folder.

Install

dotnet add package Finnhub

See nuget.org.

Usage

open Finnhub
let client = Client "your-api-key"
client.Quote "AAPL"
    |> Async.RunSynchronously
    |> printfn "%A"

[TODO: add C# example]

Related projects

There are a few other Finnhub API clients for .NET, such as ThreeFourteen.FinnhubClient and FinnHub.NET. However, the existing clients have some issues (e.g. lack of API coverage, lack of documentation). Also, I'd rather have a simpler API wrapper without any external dependencies, so I decided to write this.

finnhub-dotnet's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency newtonsoft.json to v13.0.3
• chore(deps): update dependency nswag.apidescription.client to v13.20.0
• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-dotnet action to v4
• chore(deps): update dependency nswag.apidescription.client to v14
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/dotnet.yml

• actions/checkout v3
• actions/setup-dotnet v2

nuget

generated/finnuhub-openapi.csproj

• NSwag.ApiDescription.Client 13.16.1
• Newtonsoft.Json 13.0.1

---

• Check this box to trigger a request for Renovate to run again on this repository

Improve nuget package

• add source linking
• deterministic compilation
• automate nuget push upon tagging
• add readme on nuget.org

Add examples

Add examples that can be run with dotnet example - see https://github.com/patriksvensson/dotnet-example

Add code documentation

https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/xml-documentation

Implement missing APIs

API docs: https://finnhub.io/docs/api

Web socket

• Trades
• News (Premium)

Stock Fundamentals

• Symbol Lookup
• Stock Symbols
• Company Profile (Premium)
• Company Profile 2
• Company Executive (Premium)
• Market News
• Company News
• Press Releases (Premium)
• News Sentiment
• Peers
• Basic Financials
• Ownership (Premium)
• Fund Ownership (Premium)
• Financials (Premium)
• Financials As Reported
• SEC Filings
• International Filings (Premium)
• SEC Sentiment Analysis (Premium)
• Similarity Index (Premium)
• IPO Calendar
• Dividends (Premium)

Stock Estimates

• Recommendation Trends
• Price Target (Premium)
• Upgrade Downgrade (Premium)
• Revenue Estimates (Premium)
• EPS Estimates (Premium)
• EPS Surprises
• Earnings Calendar

Stock Price

• Quote
• Candles
• Tick Data (Premium)
• Last Bid-Ask (Premium)
• Splits (Premium)
• Dividends 2 (Premium)

ETFs & Indices

• Indices Constituents
• Historical Constituents (Premium)
• ETFs Profile (Premium)
• ETFs Holdings (Premium)
• ETFs Industry
• ETFs Country

Forex

• Exchanges
• Symbols
• Candles
• All Rates

Crypto

• Exchanges
• Symbols
• Candles

Technical Analysis

• Pattern Recognition
• Support/Resistance
• Aggregate Indicators
• Technical Indicators

Alternative Data

• Transcripts List (Premium)
• Transcripts (Premium)
• Social Sentiment
• COVID-19
• FDA Calendar

Economic

• Country List
• Economic Calendar
• Economic Codes (Premium)
• Economic (Premium)

Enterprise Data

• Short Interest (Premium)
• Global Fixed Income (Premium)
• Derivatives (Premium)