Skip to main content

SEC Edgar connector for the parsimony framework

Project description

parsimony-sec_edgar

SEC EDGAR connector plugin for parsimony — public-company filings, financial statements (XBRL), filing documents, and insider trades for U.S. issuers.

Part of the parsimony-connectors monorepo. Distributed standalone on PyPI as parsimony-sec_edgar.

Connectors

Name Kind Description
sec_edgar_find_company connector Search EDGAR by name, ticker, or CIK. Returns CIK, name, ticker.
sec_edgar_company_profile connector Profile for one company: name, CIK, ticker, industry, SIC, fiscal year end.
sec_edgar_income_statement connector Income statement from 10-K/10-Q XBRL — multi-period summary or single-filing detailed view.
sec_edgar_balance_sheet connector Balance sheet from 10-K/10-Q XBRL — multi-period summary or detailed view.
sec_edgar_cashflow_statement connector Cash flow statement from 10-K/10-Q XBRL — multi-period summary or detailed view.
sec_edgar_search_filings connector Full-text search across all EDGAR filings, optionally scoped by form and date.
sec_edgar_filings connector List filings for a company or across all companies, filtered by form and date.
sec_edgar_company_facts connector All XBRL company facts for a company (custom time-series base).
sec_edgar_filing_document connector Filing content as markdown by accession number.
sec_edgar_filing_metadata connector Form-specific metadata summary for a filing.
sec_edgar_filing_sections connector Table of contents (item identifiers + titles) for a filing.
sec_edgar_filing_item connector Specific section/item of a filing as text.
sec_edgar_filing_tables connector List tables in a filing with caption, type, and shape.
sec_edgar_filing_table connector Specific table from a filing as a DataFrame.
sec_edgar_insider_trades connector Structured insider transactions (Form 4) for a company.

Install

pip install parsimony-sec_edgar

Pulls in parsimony-core>=0.4,<0.5 automatically. Verify discovery:

python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"

Quick start

import asyncio
from parsimony_sec_edgar import CONNECTORS

async def main():
    connectors = CONNECTORS.bind_env()
    result = await connectors["sec_edgar_find_company"](identifier="AAPL")
    print(result.data.head())

asyncio.run(main())

For multi-plugin composition:

from parsimony import discover
connectors = discover.load_all().bind_env()

EDGAR requires a user-agent identity per SEC fair-access policy. Set EDGAR_IDENTITY (or SEC_EDGAR_USER_AGENT) to a string of the form "YourApp your-email@example.com" before issuing requests.

Provider

License

See LICENSE.

Project details


Download files

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

Source Distribution

parsimony_sec_edgar-0.5.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

parsimony_sec_edgar-0.5.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file parsimony_sec_edgar-0.5.0.tar.gz.

File metadata

  • Download URL: parsimony_sec_edgar-0.5.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for parsimony_sec_edgar-0.5.0.tar.gz
Algorithm Hash digest
SHA256 733751eb5c5f7a91cec4f53631c62780505354ec7f2b4f4d6233bca42b3102ff
MD5 741c17a4daf667f0864c7094028d7ebc
BLAKE2b-256 0fe66bdb6f907c6ee9173d956ea6fd0a4d09684838af90ea449df696475ef0eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for parsimony_sec_edgar-0.5.0.tar.gz:

Publisher: release.yml on ockham-sh/parsimony-connectors

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file parsimony_sec_edgar-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for parsimony_sec_edgar-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee6e333092180a91e7564f47191530ef305c372f3aa80663fc09e66c2b96cf93
MD5 f648c19b274ea7122fba9f5e8bfd0179
BLAKE2b-256 36af4d10a24226a04b120cd25b0c92a35a90dba6ad56ffbdbb214b32335261e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for parsimony_sec_edgar-0.5.0-py3-none-any.whl:

Publisher: release.yml on ockham-sh/parsimony-connectors

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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