@anhquoc96/fastxml-financial

Financial XML profile helpers for Node.js and Deno, including XBRL instance support.

Installation

npm install @anhquoc96/fastxml-financial @anhquoc96/fastxml-schema

Read XBRL facts

import { parseFinancial } from "@anhquoc96/fastxml-financial";

const instance = parseFinancial(xbrlXml);

for (const fact of instance.facts) {
  console.log(fact.conceptLocalName, fact.value, fact.contextRef);
}

Bind an application-provided schema with createXbrlInstanceProfile(schema). For streamed input, use parseFinancialStream().

Scope

• XBRL instance namespace and root profile.
• Basic fact extraction with concept namespace, context reference, unit reference, decimals, and value.
• Optional schema validation.

Taxonomy compilation, linkbases, dimensions, formulas, Inline XBRL, tuple processing, calculation consistency, and filing-specific rules are not bundled. Use the exact XBRL taxonomy and reporting specification required by the target regulator or exchange.

Development

npm run build --workspace @anhquoc96/fastxml-financial
npm run typecheck --workspace @anhquoc96/fastxml-financial

License

MIT License. See the package LICENSE file.