Moedim.Edgar 1.1.0

Moedim.Edgar

C# .NET library for accessing the Security Exchange Commission's EDGAR database with modern async/await patterns and dependency injection support.

"Moedim" is a Hebrew word that translates to "feast" or "appointed time." "Appointed times" refers to HaShem's festivals in Vayikra/Leviticus 23rd. The feasts are "signals and signs" to help us know what is on the heart of HaShem.

Features

• Modern HTTP Client - Uses IHttpClientFactory for efficient and reliable HTTP communication
• Dependency Injection - First-class support for Microsoft.Extensions.DependencyInjection
• Type-Safe Models - Strongly-typed models for SEC EDGAR data structures
• Async/Await - Fully asynchronous API throughout
• Retry Logic - Built-in retry mechanism for handling rate limiting and transient failures
• Configurable - Flexible options pattern for customizing behavior
• Well-Documented - Comprehensive XML documentation on all public APIs
• Multi-Framework Support - Targets .NET 8.0
• 📄 Document Retrieval - Download complete SEC filings as clean Markdown or HTML
• ✂️ Intelligent Section Extraction - Parse and extract specific sections from filings (Risk Factors, MD&A, etc.)
• 🔍 Section Preview - Browse filing sections before downloading full content
• 💾 Built-in Caching - Automatic caching to reduce API calls and improve performance
• 🤖 MCP Server - Model Context Protocol server for LLM integration (included in Moedim.Edgar.Mcp package)

Hire me

Please send email if you consider to hire me.

Give a Star! ⭐

If you like or are using this project to learn or start your solution, please give it a star. Thanks!

Installation

dotnet add package Moedim.Edgar

MCP Server for AI Integration

For AI assistant integration via Model Context Protocol (MCP), install the companion MCP server package:

# Install via dnx (recommended)
dnx Moedim.Edgar.Mcp --version 1.0.0 --yes

The MCP server provides:

• 17 tools for accessing SEC EDGAR data (company facts, filing search, document retrieval, section extraction)
• 6 guided prompts for structured analysis workflows (company assessment, peer comparison, change tracking, and more)

See src/Moedim.Edgar.Mcp/README.md for full documentation.

Quick Start

1. Configure Services

using Moedim.Edgar.Extensions;

services.AddSecEdgar(options =>
{
    options.AppName = "YourCompany";
    options.AppVersion = "1.0.0";
    options.Email = "your@email.com";
    options.RequestDelay = TimeSpan.FromMilliseconds(100);
    options.MaxRetryCount = 3;
});

2. Use the Services

using Moedim.Edgar.Models;

public class FinancialDataService
{
    private readonly ICompanyFactsService _companyFactsService;
    private readonly ICompanyConceptService _companyConceptService;

    public FinancialDataService(
        ICompanyFactsService companyFactsService,
        ICompanyConceptService companyConceptService)
    {
        _companyFactsService = companyFactsService;
        _companyConceptService = companyConceptService;
    }

    public async Task<CompanyFactsQuery> GetCompanyFactsAsync(int cik)
    {
        return await _companyFactsService.QueryAsync(cik);
    }

    public async Task<CompanyConceptQuery> GetRevenueDataAsync(int cik)
    {
        return await _companyConceptService.QueryAsync(cik, "Revenues");
    }
}

Usage Examples

Retrieve Company Facts

// Get all facts for a company (e.g., Apple Inc. - CIK: 320193)
var facts = await companyFactsService.QueryAsync(320193);

// Access company information
Console.WriteLine($"Company: {facts.EntityName}");
Console.WriteLine($"CIK: {facts.Cik}");

// Iterate through facts
foreach (var fact in facts.Facts)
{
    Console.WriteLine($"Concept: {fact.Label}");
    Console.WriteLine($"Value: {fact.Value}");
}

Query Specific Concepts

// Get specific financial concept (e.g., Revenues)
var revenues = await companyConceptService.QueryAsync(320193, "Revenues");

// Access data points
foreach (var dataPoint in revenues.DataPoints)
{
    Console.WriteLine($"Period: {dataPoint.FiscalPeriod}");
    Console.WriteLine($"Value: {dataPoint.Value:C}");
    Console.WriteLine($"Filed: {dataPoint.Filed:d}");
}

Download Filing Documents (NEW)

// Get complete filing as clean Markdown
var markdown = await filingDetailsService.GetFilingDocumentAsync(
    accessionNumber: "0000320193-23-000077",
    tickerOrCik: "AAPL",
    format: "markdown"
);

// Or get as HTML
var html = await filingDetailsService.GetFilingDocumentAsync(
    accessionNumber: "0000320193-23-000077",
    format: "html"
);

Extract Specific Sections (NEW)

// First, preview available sections
var previewRequest = new FilingSectionsRequest { PreviewOnly = true };
var preview = await filingDetailsService.GetFilingSectionsAsync(
    accessionNumber: "0000320193-23-000077",
    request: previewRequest
);

// Display available sections
foreach (var section in preview.Preview)
{
    Console.WriteLine($"{section.AnchorTargetId}: {section.Label}");
}

// Then, get specific sections
var sectionsRequest = new FilingSectionsRequest
{
    PreviewOnly = false,
    AnchorIds = new[] { "item_1a_risk_factors", "item_7_managements_discussion_analysis" },
    Merge = true, // Combine sections into single content
    Format = "markdown"
};

var result = await filingDetailsService.GetFilingSectionsAsync(
    accessionNumber: "0000320193-23-000077",
    request: sectionsRequest
);

Console.WriteLine(result.MergedContent); // Clean markdown of selected sections

Configuration Options

services.AddSecEdgar(options =>
{
    // Required: SEC requires identification
    options.AppName = "YourCompany";
    options.AppVersion = "1.0.0";
    options.Email = "your@email.com";

    // Optional: Delay between requests (default: 250ms)
    options.RequestDelay = TimeSpan.FromMilliseconds(100);

    // Optional: Delay after rate limit hit (default: 2 seconds)
    options.TimeoutDelay = TimeSpan.FromSeconds(1);

    // Optional: Maximum retry attempts (default: 10)
    options.MaxRetryCount = 3;

    // Optional: Override retry behavior (defaults shown)
    options.RetryCountOverride = 5; // total attempts including the initial call
    options.RetryDelay = TimeSpan.FromSeconds(1); // fallback when no Retry-After header is returned
    options.UseExponentialBackoff = true; // multiply delay after each retry
    options.RetryBackoffMultiplier = 1.5; // growth factor for exponential strategy
});

Requirements

• .NET 8.0 or later
• C# 11 or later (for consuming projects)
• Visual Studio 2022 or Rider (for best IDE support)

Project Structure

• Moedim.Edgar - Core library with services, models, and extensions
  • Services/ - SEC EDGAR client and service implementations
  • Models/ - Data models and query types
  • Extensions/ - Dependency injection extensions
• Moedim.Edgar.Mcp - Model Context Protocol server for AI assistant integration
  • Tools/ - MCP tool implementations (17 tools)
  • Prompts/ - Guided analysis workflows (6 prompts)
  • See src/Moedim.Edgar.Mcp/README.md for details

API Documentation

Core Services

• ISecEdgarClient - Low-level HTTP client for SEC EDGAR API
• ICompanyFactsService - Service for retrieving all company facts
• ICompanyConceptService - Service for querying specific financial concepts
• ICompanyLookupService - Service for looking up company CIK from ticker symbol
• IEdgarSearchService - Service for searching company filings
• IEdgarLatestFilingsService - Service for retrieving latest filings
• IFilingDetailsService - Service for retrieving filing details, documents, and sections
• ICacheService - Service for caching SEC EDGAR data (implemented as LocalFileCache)

New Features (v1.1.0)

Document Retrieval

The IFilingDetailsService now supports downloading complete filing documents in Markdown or HTML format:

Task<string?> GetFilingDocumentAsync(
    string accessionNumber,
    string? tickerOrCik = null,
    string? format = null,
    CancellationToken cancellationToken = default);

• accessionNumber: The SEC accession number (e.g., "0000320193-23-000077")
• tickerOrCik: Optional ticker symbol or CIK to help locate the filing
• format: "markdown" (default) or "html"
• Returns: Complete filing content in the requested format

Section Extraction

Extract specific sections from filings using a two-step workflow:

Step 1: Preview Sections

Task<FilingSectionsResult?> GetFilingSectionsAsync(
    string accessionNumber,
    FilingSectionsRequest request,
    string? tickerOrCik = null,
    CancellationToken cancellationToken = default);

With request.PreviewOnly = true, returns section IDs and titles without full content.

Step 2: Get Full Sections With request.PreviewOnly = false and specific request.AnchorIds, returns full content of selected sections.

FilingSectionsRequest Properties:

• PreviewOnly - Return only section metadata
• AnchorIds - List of section IDs to retrieve
• Format - "markdown" (default) or "html"
• Merge - Combine all sections into single content block

Caching

Built-in caching reduces API calls and improves performance:

• Automatic caching of filing documents (24 hours)
• Cached section parsing results
• Local file-based cache by default
• Cache directory: .edgar_cache in temp folder

Data Models

• CompanyFactsQuery - Container for all company facts
• CompanyConceptQuery - Container for specific concept data
• Fact - Individual fact with label, value, and metadata
• FactDataPoint - Time-series data point for a fact
• FiscalPeriod - Enumeration of fiscal periods (Q1, Q2, Q3, Q4, FY)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with:

• IHttpClientFactory
• Microsoft.Extensions.DependencyInjection
• Newtonsoft.Json

Version History

See CHANGELOG.md for version history and release notes.

Resources

• SEC EDGAR API Documentation
• SEC Company Search