{"id":25421667,"url":"https://github.com/tiesdekok/fast_xbrl_parser","last_synced_at":"2025-10-31T12:30:35.117Z","repository":{"id":102154463,"uuid":"437742578","full_name":"TiesdeKok/fast_xbrl_parser","owner":"TiesdeKok","description":"An XBRL parser built in Rust that provides a fast, easy, and lightweight way to convert XBRL XML files into JSON or CSV.","archived":false,"fork":false,"pushed_at":"2023-09-28T17:25:47.000Z","size":9762,"stargazers_count":19,"open_issues_count":2,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2023-09-28T20:37:42.686Z","etag":null,"topics":["csv","json","rust","xbrl","xml"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TiesdeKok.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-12-13T05:05:27.000Z","updated_at":"2023-09-26T20:24:23.000Z","dependencies_parsed_at":"2023-07-11T16:01:06.368Z","dependency_job_id":null,"html_url":"https://github.com/TiesdeKok/fast_xbrl_parser","commit_stats":null,"previous_names":[],"tags_count":1,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiesdeKok%2Ffast_xbrl_parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiesdeKok%2Ffast_xbrl_parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiesdeKok%2Ffast_xbrl_parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiesdeKok%2Ffast_xbrl_parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TiesdeKok","download_url":"https://codeload.github.com/TiesdeKok/fast_xbrl_parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239195483,"owners_count":19598037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csv","json","rust","xbrl","xml"],"created_at":"2025-02-16T20:49:12.829Z","updated_at":"2025-10-31T12:30:35.046Z","avatar_url":"https://github.com/TiesdeKok.png","language":"Rust","readme":"\u003ch1 align=\"center\"\u003e\n    Fast XBRL Parser\u003cbr\u003e\n    \n   \u003cimg src=\"https://i.imgur.com/2KcunUN.png\" alt=\"Fast XBRL Parser\" title=\"Fast XBRL Parser\" /\u003e\n   \n\u003c/h1\u003e\n\u003cp align=\"center\"\u003e  \n \u003ca href=\"https://mybinder.org/v2/gh/TiesdeKok/fast_xbrl_parser/HEAD?labpath=examples%2Fexample.ipynb\"\u003e\u003cimg src=\"https://mybinder.org/badge_logo.svg\"\u003e\u003c/a\u003e\n \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/last%20updated-January%202022-3d62d1\"\u003e\n \n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cb\u003e:warning:Unfortunately, I am unable to maintain this repository in my new role. Issues are not monitored.\u003c/b\u003e\n    \nAn XBRL parser built in Rust that provides a fast, easy, and lightweight way to convert XBRL XML files into JSON or CSV. Available as a Python library or a standalone command line utility. \u003cbr\u003e\u003cbr\u003e\n\u003cbr\u003e\u003cbr\u003e\n  \u003cspan style='font-size: 15pt'\u003e\u003cstrong\u003eAuthor:\u003c/strong\u003e Ties de Kok (\u003ca href=\"https://www.TiesdeKok.com\"\u003ePersonal Page\u003c/a\u003e)\u003c/span\u003e\n\u003c/p\u003e\n\n## Table of contents\n\n  * [Introduction](#introduction)\n  \t* [Design philosophy](#philosophy)\n  \t* [Caveats](#caveats)\n  * [Installation](#installation)\n      * [Python](#python-install)\n      * [Command Line Tool](#cli-install) \n  * [How to use](#howtouse)\n      * [Python](#python)\n      * [Command line](#commandline)\n  * [Questions?](#questions)\n  * [License](#license)\n\n\u003ch2 id=\"introduction\"\u003eIntroduction\u003c/h2\u003e\n  \n\u003ch3 id=\"philosophy\"\u003eDesign philosophy\u003c/h3\u003e\n\nThe objective of `fast-xbrl-parser` is to provide a fast, easy, and lightweight way to parse XBRL XML files into JSON or CSV. \nIt is built with the following objectives in mind:\n\n- An easy to use interface   \n- Very fast      \n- Lightweight and easy to install    \n- Cross-platform support (Windows, Linux, and Mac OS are supported)    \n\n\u003ch3 id=\"caveats\"\u003eCaveats\u003c/h3\u003e\n\n- Only tested on US XBRL files from SEC EDGAR   \n- Opinionated conversion to CSV     \n- Not validated against the XBRL specification    \n\nUse at your own discretetion and always verify the results yourself. \n\n\u003ch2 id=\"installation\"\u003eInstallation\u003c/h2\u003e\n\n\u003ch3 id=\"python-install\"\u003ePython package\u003c/h3\u003e\n\n**Note:** `fast-xbrl-parser` requires Python 3.6+\n\n```bash\npip install fast-xbrl-parser\n```\n\u003ch3 id=\"cli-install\"\u003eCLI tool\u003c/h3\u003e\n\nDownload the executable file from:\n\nhttps://github.com/TiesdeKok/fast_xbrl_parser/releases/\n\n\u003ch2 id=\"howtouse\"\u003eBasic use\u003c/h2\u003e\n\nFor full examples and documentation see: [notebook](https://github.com/TiesdeKok/fast_xbrl_parser/blob/master/examples/example.ipynb)\n\n\u003ch3 id=\"python\"\u003eAs a Python package\u003c/h3\u003e\n\n```python\nimport fast_xbrl_parser as fxp\n\ninput = \"https://www.sec.gov/Archives/edgar/data/1326380/000132638021000129/gme-20211030_htm.xml\" ## Edgar URL\n#input = \"gme-20211030_htm.xml\" ## Local XML file\n\n\nxbrl_dict = fxp.parse(\n    input, \n    output=['json', 'facts', 'dimensions'],   ### You can adjust this to only return certain outputs. \n    email = \"demo@fast-xbrl-parser.com\"       ### Adjust this to reflect your email address. This is required by the SEC Edgar system when passing a URL.  \n) \n\njson_valid_dict = xbrl_dict['json']\nfacts_list = xbrl_dict['facts']\nfacts_df = pd.DataFrame(facts_list)\n```\n\n\u003ch3 id=\"commandline\"\u003eStandalone using the command line\u003c/h3\u003e\n\n```bash\nfast_xbrl_parser.exe\n--input \"https://www.sec.gov/Archives/edgar/data/1589526/000158952621000140/blbd-20211002_htm.xml\" \n--json --facts --dimensions \n--save-dir \"D:\\xbrl_storage\" --email \"demo@fast-xbrl-parser.com\"\n\n## This will save the JSON / CSV files in the `save-dir`\n```\n\n\u003ch2 id=\"questions\"\u003eQuestions?\u003c/h2\u003e\n\nIf you have questions or experience problems please use the `issues` tab of this repository.\n\n\u003ch2 id=\"license\"\u003eLicense\u003c/h2\u003e\n\n[MIT](LICENSE) - Ties de Kok - 2022\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiesdekok%2Ffast_xbrl_parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiesdekok%2Ffast_xbrl_parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiesdekok%2Ffast_xbrl_parser/lists"}