edgartools: Instructions file for Claude Code

CLAUDE.md

edgartools CLAUDE.md is an instructions file for Claude Code from dgunning/edgartools. It costs 1,477 tokens per session, scanned A, original, MIT.

Repository guidance for EdgarTools, a Python library that makes United States SEC financial filings easier to analyze. SEC filings are public company reports such as annual 10-K, quarterly 10-Q, and event-based 8-K reports.

In plain words
What is it for?
Use it to navigate the codebase and work with companies, filings, financial statements, XBRL data, notes, disclosures, and SEC reports.
Why use it?
It shows agents where to find filing, company, XBRL financial-data, document, and report code, and encourages understanding existing patterns before editing them.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions AGENTS.md.

This is dgunning/edgartools's own configuration. It tells Claude Code how to work on edgartools itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything edgartools configures →

About the project

EdgarTools is a Python library that turns SEC EDGAR filings into structured, typed data, including financial statements, insider trades, fund holdings, and other filing types. It is used to analyze regulatory filings in notebooks, data pipelines, and AI systems. Its catalogue add-ons operate the library through skills, commands, instructions, and an MCP server.

dgunning/edgartools · 2,837 stars · on GitHub · edgartools.readthedocs.io

Reuse

Borrowing it

Nothing to install: this file belongs to dgunning/edgartools. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/dgunning/edgartools/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/dgunning/edgartools

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for edgartools CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/dgunning/edgartools/claude-md/github.svg)](https://agentmods.dev/instructions/dgunning/edgartools/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/dgunning/edgartools/claude-md"><img src="https://agentmods.dev/badge/instructions/dgunning/edgartools/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for edgartools CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/dgunning/edgartools/claude-md"><img src="https://agentmods.dev/badge/instructions/dgunning/edgartools/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,477 This file is loaded in full into every session.
When invoked 1,477 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01477 $0.01477
Opus 5.5 $0.00591 $0.00591
Sonnet 5.5 $0.00295 $0.00295
Haiku 4.5 $0.00148 $0.00148

Measured 22d ago against content hash b6fe4ee233ac, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

edgartools CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 22d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

CLAUDE.md · 137 lines

How it starts

The opening of the file, as written. The whole thing — 137 lines — stays where its author put it; the contents beside it link to each section on GitHub.

EdgarTools

Python library for SEC Edgar filings analysis.

Philosophy

  • Simple API, complex data: Hide SEC complexity behind intuitive Python objects
  • Progressive disclosure: Basic usage is easy; advanced features available when needed
  • Read before write: Understand existing patterns before modifying code

Quick Navigation

Need Location Key Classes
Filing access edgar/_filings.py Filing, Filings
Company data edgar/entity/core.py Company, Entity
XBRL parsing edgar/xbrl/xbrl.py XBRL
Statements edgar/xbrl/statements.py Statement, StatementLineItem
Notes & disclosures edgar/xbrl/notes.py Note, Notes
Documents edgar/documents/ Document, HTMLParser
Reports (10-K/Q/8-K) edgar/company_reports/ TenK, TenQ, EightK, AuditorInfo, SubsidiaryList
Reference data edgar/reference/ Tickers, forms

Entry Points

from edgar import Filing, Filings, Company, find, obj
  • Company("AAPL") - Get company by ticker or CIK
  • company.get_financials() - Financial statements from latest 10-K (recommended)
  • company.get_quarterly_financials() - Financial statements from latest 10-Q
  • find(form="10-K", ticker="AAPL") - Search filings
  • filing.xbrl() - Parse XBRL financials
  • filing.obj() - Get typed report object (TenK, TenQ, etc.)

Data Flow

Company → company.get_financials() → Financials → income/balance/cashflow
Filing → filing.obj() → TenK/TenQ → .notes → Notes → Note → .tables/.text/.expands
Filing → filing.obj() → TenK/TenQ/EightK → .reports → Reports
Filing → filing.xbrl() → XBRL → statements
Statement → stmt['line item'] → StatementLineItem → .note → Note (drill-down)
Company → company.get_facts() → EntityFacts → Statement
Filing → filing.document() → Document → extractors

Large Files (>30KB)

When modifying these, read in chunks:

  • _filings.py (72KB), xbrl/rendering.py (72KB), xbrl/xbrl.py (66KB)
  • entity/entity_facts.py (63KB), xbrl/facts.py (55KB), xbrl/statements.py (46KB)

Read the full file on GitHub · 137 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 22d ago Changed · +6 lines · +39 tokens per session b6fe4ee233ac
  2. 1mo ago Changed · +9 lines · +147 tokens per session e2bd4e1c8288
  3. 2mo ago First seen · 122 lines · 1,291 tokens per session scan A 2186e656fd01

Subscribe to this mod's changes

edgartools CLAUDE.md is an instructions file published in the GitHub repository dgunning/edgartools (2,837 stars, last pushed yesterday), licensed MIT. It adds 1,477 tokens to every session, about $0.0059 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

edgartools CLAUDE.md compared with instructions from other repositories

edgartools CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
edgartools CLAUDE.mddgunning/edgartoolsInstructions file2.8kyesterdayMITA1,477Claude Code
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode