{"id":25190,"library":"edgar","title":"edgar","description":"The 'edgar' package (v0.0.0) provides a JavaScript/TypeScript API for accessing the SEC EDGAR database, enabling retrieval of company filings, financial statements, and metadata. It is an early-stage release with no stable release yet, and the API may change frequently. Key differentiators include a promise-based interface and minimal dependencies. No release cadence established.","status":"active","version":"0.0.0","language":"javascript","source_language":"en","source_url":null,"tags":["javascript"],"install":[{"cmd":"npm install edgar","lang":"bash","label":"npm"},{"cmd":"yarn add edgar","lang":"bash","label":"yarn"},{"cmd":"pnpm add edgar","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Default import is preferred; CommonJS is not officially supported.","wrong":"const edgar = require('edgar')","symbol":"edgar","correct":"import edgar from 'edgar'"},{"note":"Named export from the package root.","wrong":"import { getFilings } from 'edgar/getFilings'","symbol":"getFilings","correct":"import { getFilings } from 'edgar'"},{"note":"Named export for the client class.","wrong":"import EdgarClient from 'edgar'","symbol":"EdgarClient","correct":"import { EdgarClient } from 'edgar'"}],"quickstart":{"code":"import edgar from 'edgar';\n\nasync function main() {\n  try {\n    const filings = await edgar.getFilings({\n      company: 'AAPL',\n      form: '10-K',\n      count: 1\n    });\n    console.log(filings);\n  } catch (error) {\n    console.error('Error:', error);\n  }\n}\n\nmain();","lang":"typescript","description":"Fetches the most recent 10-K filing for Apple (AAPL) using the default export."},"warnings":[{"fix":"Use import { getFilings } from 'edgar' instead of default import.","message":"The default export may change in future releases; use named exports for stability.","severity":"breaking","affected_versions":">=0.0.0"},{"fix":"Pin to a specific version and expect breaking changes.","message":"The package is in early development (v0.0.0); no breaking changes policy.","severity":"gotcha","affected_versions":"0.0.0"},{"message":"No deprecation notices yet as the package is new.","severity":"deprecated"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'npm install edgar' and ensure import path is correct.","cause":"Package not installed or typo in import.","error":"Error: Cannot find module 'edgar'"},{"fix":"Use 'import { getFilings } from 'edgar'' instead of require.","cause":"Wrong import style (CommonJS vs ESM) or older version.","error":"TypeError: edgar.getFilings is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}