Socket
Socket
Sign inDemoInstall

edgar-parser

Package Overview
Dependencies
7
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    edgar-parser

A high-performance Rust-based library for parsing XBRL and XML filings from EDGAR.


Version published
Weekly downloads
1
decreased by-93.75%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

edgar-parser

edgar-parser is a high-performance Rust-based library for parsing XBRL and XML filings from EDGAR.

Performance

Based on testing on M2 Macbook, edgar-parser can parse a large XBRL filing in under 100ms from local disk. This is about 4-5x faster than the same code running in Python using PyO3.

Features

  • Fast parsing of EDGAR XBRL and XML filings.
  • Cross-platform support with pre-built binaries for multiple architectures.
  • Easy integration with Node.js projects.

Installation

You can install edgar-parser using your favorite package manager.

Usage

const { parseXbrl, parseOwnershipForm, parseForm13F, parseForm13FTable } = require('edgar-parser')

// Example: Parsing an XBRL document
const xbrlData = '<xbrl>...</xbrl>' // Your XBRL data here
const parsedXbrl = parseXbrl(xbrlData)
console.log(parsedXbrl)

// Example: Parsing an Ownership Form (Form 3, 4 ect.)
const ownershipFormData = '<xml>...</xml>' // Your Ownership Form data here
const parsedOwnershipForm = parseOwnershipForm(ownershipFormData)
console.log(parsedOwnershipForm)

// Example: Parsing a Form 13F
const form13FData = '<xml>...</xml>' // Your Form 13F data here
const parsedForm13F = parseForm13F(form13FData)
console.log(parsedForm13F)

// Example: Parsing a Form 13F Table
const form13FTableData = '<xml>...</xml>' // Your Form 13F Table data here
const parsedForm13FTable = parseForm13FTable(form13FTableData)
console.log(parsedForm13FTable)

Supported Platforms

edgar-parser provides pre-built binaries for the following platforms:

  • Linux (x64, arm64, musl)
  • macOS (x64, arm64)
  • Windows (x64-msvc)
  • Android (arm64)

Feel free to open an issue if you need support for a different platform.

Keywords

FAQs

Last updated on 15 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc