Expand description
SEC EDGAR client for N-PORT filings.
Used by the CLI (backfill, nightly-append) to:
- List NPORT-P filings for a given trust CIK.
- Filter those filings to a target series ID.
- Download and parse each filing’s
primary_doc.xml.
SEC requires a descriptive User-Agent on all data.sec.gov requests.
See https://www.sec.gov/developer for the policy. indexkit sets:
User-Agent: indexkit/1.0 (+https://github.com/userFRM/indexkit)
SEC rate limit is 10 req/s per IP. The fetchers in this module insert a 100 ms sleep between calls for comfortable headroom.
Structs§
- Filing
Ref - One NPORT-P filing reference (not the XML body).
- SecClient
- Client for the SEC EDGAR submissions and archives APIs.
Constants§
- INTER_
REQUEST_ DELAY - Sleep between SEC requests – 100 ms = 10 req/s = SEC’s stated rate limit.
- SEC_
USER_ AGENT_ DEFAULT - User-Agent used for all SEC requests. SEC mandates a contact email and
rejects anonymous or
noreply@addresses at the Akamai edge.
Functions§
- resolved_
sec_ user_ agent - Resolve the User-Agent to use for SEC requests, honouring
INDEXKIT_SEC_USER_AGENT.