Skip to main content

Making it easier to use SEC filings.

Project description

datamule

PyPI - Downloads Hits GitHub

A Python package for working with SEC filings at scale. Includes Mulebot, an open-source chatbot for SEC data with no storage requirements.

📚 Full Documentation | 🌐 Website | 📝 Article: Deploy a Financial Chatbot in 5 Minutes

Key Features

  • 📥 Download SEC filings quickly and efficiently
  • 🔍 Monitor EDGAR for new filings in real-time
  • 📊 Parse textual filings into simplified HTML, interactive HTML, or structured JSON
  • 💾 Access comprehensive datasets (10-Ks, SIC codes, etc.)
  • 🤖 Interact with SEC data using MuleBot

Quick Start

# Basic installation
pip install datamule

# Install with all features
pip install datamule[all]
import datamule as dm

# Download filings
downloader = dm.Downloader()
downloader.download(form='10-K', ticker='AAPL')

# Download filing attachments such as information tables
downloader.download(form='13F-HR',file_types=['INFORMATION TABLE'],date=('2024-09-14','2024-09-16'))

# Download every 10Q from 2023. Should take 2 minutes
downloader.download_dataset(dataset='10q_2023')

Available Extras

  • filing_viewer: Filing viewer module
  • mulebot: SEC data interaction chatbot
  • mulebot_server: Flask server for MuleBot
  • all: All available features

Resources

Datasets

Access comprehensive SEC datasets including:

  • Historical FTD data (since 2004)
  • 10-K and 10-Q filings (since 2001)
  • 13F-HR Information Tables (since 2013)
  • MD&A collection (100,000+ since 2001, requires free API key)

Contributing

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

License

MIT License


For detailed usage examples, API reference, and advanced features, please visit our documentation.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datamule-0.356.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datamule-0.356-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file datamule-0.356.tar.gz.

File metadata

  • Download URL: datamule-0.356.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.5

File hashes

Hashes for datamule-0.356.tar.gz
Algorithm Hash digest
SHA256 64c45b479442dd80422d572fe9d497545a7c755cf47feb72741e67e23e77e445
MD5 45fd993732c0752bb2dc4864eff888c4
BLAKE2b-256 ff45c8fb6b2b1a487bd558544ac1225ebc6c2b519927a75c30081725febe07a8

See more details on using hashes here.

File details

Details for the file datamule-0.356-py3-none-any.whl.

File metadata

  • Download URL: datamule-0.356-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.5

File hashes

Hashes for datamule-0.356-py3-none-any.whl
Algorithm Hash digest
SHA256 ea71ba4f95954a8e70b83dc2dc48de204f5c4f0db654aad5b87b9cedc83d8bd7
MD5 6e2682aca645ad98c8de182953aa9ed1
BLAKE2b-256 f02af23c38f1a0170645ffa24e2f6048289815b4e770795bd3c3753ef13fe47f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page