SecuritiesExchangeCommission.Edgar
6.3.2
dotnet add package SecuritiesExchangeCommission.Edgar --version 6.3.2
NuGet\Install-Package SecuritiesExchangeCommission.Edgar -Version 6.3.2
<PackageReference Include="SecuritiesExchangeCommission.Edgar" Version="6.3.2" />
paket add SecuritiesExchangeCommission.Edgar --version 6.3.2
#r "nuget: SecuritiesExchangeCommission.Edgar, 6.3.2"
// Install SecuritiesExchangeCommission.Edgar as a Cake Addin #addin nuget:?package=SecuritiesExchangeCommission.Edgar&version=6.3.2 // Install SecuritiesExchangeCommission.Edgar as a Cake Tool #tool nuget:?package=SecuritiesExchangeCommission.Edgar&version=6.3.2
SecuritiesExchangeCommission.Edgar
.NET class library for accessing the Security Exchange Commission's EDGAR database. This library allows you to access over twenty years worth of financial data that has been reported to the SEC, mostly by publicly traded companies.
Delcare a User-Agent!
The SEC requires all automated tools to declare their traffic by specifying a user agent in each HTTP request header. This library is designed to do that and will pass the User-Agent that you provide. To set your User-Agent:
SecuritiesExchangeCommission.Edgar.SecRequestManager.Instance.UserAgent = "MyCompany/4.1.0";
In the above example, MyCompany
is the name of your company/service (declaring who you are) and the 4.1.0
declares the version of the service. The name and version must be separated by the forward slash. More on User-Agents an be read here.
Be sure to follow this step before doing anything with this library! If you do not, it will likely fail to return any data!
Querying the SEC EDGAR Database
Use the EdgarSearch
class to query the database for filings for any publicly traded company.
For example, requesting Microsoft's ($MSFT) latest 10-K filings:
EdgarSearch msft10ks = await EdgarSearch.CreateAsync("MSFT", "10-K");
The first parameter in the CreateAsync
static method, stock_symbol
, can be specified as either the company's public trading symbol (MSFT in this case) or the company's SEC-assigned CIK, or "Central Index Key". For example, Microsoft's CIK is 789019.
The EdgarSearch
instance is going to place the results of your query into its Results
property. The Results
property contains the most recent results that suite your query, but is limited of the number of results it can fit in one return. To get the next page of results, you can do something like this:
EdgarSearch msft10ks = await EdgarSearch.CreateAsync("MSFT", "10-K");
if (msft10ks.NextPageAvailable())
{
EdgarSearch next_page = await msft10ks.NextPageAsync();
}
Extracting Data from Filings
The Results
property of the EdgarSearch
instance we used to query the database will contain an array of EdgarSearchResult
instances. These instances will contain some basic details about the filing and provide you with a method to access additional details about that particular filing.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- No dependencies.
NuGet packages (6)
Showing the top 5 NuGet packages that depend on SecuritiesExchangeCommission.Edgar:
Package | Downloads |
---|---|
Aletheia
Package Description |
|
Luca
Financial statements simplified. Receive a financial statement for any publically traded company with one line of code. |
|
TimHanewich.Investing
Investing toolkit creating by Tim Hanewich |
|
EarningsAlley
Engine behind the Earnings Alley twitter account, @EarningsAlley. |
|
EdgarCacheFramework
Minimizes external requests to Yahoo and SEC EDGAR XBRL filings by caching searched results in a code first, run-time generated SQLite database. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
6.3.2 | 11,805 | 8/20/2022 |
6.3.1 | 16,325 | 7/3/2021 |
6.3.0 | 351 | 6/8/2021 |
6.2.3 | 5,770 | 5/21/2021 |
6.2.2 | 2,831 | 4/11/2021 |
6.2.1 | 326 | 4/11/2021 |
6.2.0 | 338 | 3/17/2021 |
6.1.0 | 358 | 3/16/2021 |
6.0.0 | 2,925 | 3/6/2021 |
5.1.1 | 1,663 | 2/17/2021 |
5.1.0 | 325 | 2/17/2021 |
5.0.0 | 419 | 2/17/2021 |
4.0.1 | 505 | 2/16/2021 |
4.0.0 | 1,675 | 2/5/2021 |
3.3.0 | 559 | 1/15/2021 |
3.2.0 | 2,527 | 1/7/2021 |
3.1.0 | 373 | 1/5/2021 |
3.0.0 | 393 | 1/5/2021 |
2.2.0 | 419 | 1/4/2021 |
2.1.0 | 386 | 1/3/2021 |
2.0.3 | 1,468 | 6/12/2020 |
2.0.2 | 468 | 6/12/2020 |
2.0.1 | 481 | 6/12/2020 |
2.0.0 | 1,571 | 5/7/2020 |
1.0.0 | 783 | 5/2/2020 |