edgar

library0.0.0jsnpmunverified

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.

http-networking data

npm install edgar

package ↗

INSTALL

IMPORT

SIG · EDGAR

edgar

http-networkingjavascriptv0.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

edgar

✓ import edgar from 'edgar'

✗ const edgar = require('edgar')

Default import is preferred; CommonJS is not officially supported.

getFilings

✓ import { getFilings } from 'edgar'

✗ import { getFilings } from 'edgar/getFilings'

Named export from the package root.

EdgarClient

✓ import { EdgarClient } from 'edgar'

✗ import EdgarClient from 'edgar'

Named export for the client class.

Fetches the most recent 10-K filing for Apple (AAPL) using the default export.

import edgar from 'edgar'; async function main() { try { const filings = await edgar.getFilings({ company: 'AAPL', form: '10-K', count: 1 }); console.log(filings); } catch (error) { console.error('Error:', error); } } main();

Debug

Known issues

breakingThe default export may change in future releases; use named exports for stability.

fix

Use import { getFilings } from 'edgar' instead of default import.

affects: >=0.0.0

gotchaThe package is in early development (v0.0.0); no breaking changes policy.

fix

Pin to a specific version and expect breaking changes.

affects: 0.0.0

deprecatedNo deprecation notices yet as the package is new.

Errors

Common errors & fixes

Error: Cannot find module 'edgar'

Package not installed or typo in import.

fix

Run 'npm install edgar' and ensure import path is correct.

TypeError: edgar.getFilings is not a function

Wrong import style (CommonJS vs ESM) or older version.

fix

Use 'import { getFilings } from 'edgar'' instead of require.

Upgrade

Version history

0.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/edgar ↗