https://github.com/lugassawan/idxlens
Extract structured financial data from Indonesia Stock Exchange (IDX) PDF reports into JSON/CSV
https://github.com/lugassawan/idxlens
bursa-efek-indonesia cli data-extraction financial-data financial-statements golang idx indonesia-stock-exchange pdf-extraction pdf-parser
Last synced: 26 days ago
JSON representation
Extract structured financial data from Indonesia Stock Exchange (IDX) PDF reports into JSON/CSV
- Host: GitHub
- URL: https://github.com/lugassawan/idxlens
- Owner: lugassawan
- License: apache-2.0
- Created: 2026-03-17T17:55:55.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-03-18T13:08:45.000Z (about 1 month ago)
- Last Synced: 2026-03-18T20:52:07.359Z (about 1 month ago)
- Topics: bursa-efek-indonesia, cli, data-extraction, financial-data, financial-statements, golang, idx, indonesia-stock-exchange, pdf-extraction, pdf-parser
- Language: Go
- Size: 280 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# IDXLens
**Extract structured financial data from Indonesia Stock Exchange (IDX) reports (XLSX, XBRL, PDF)**
[](https://go.dev)
[](https://github.com/lugassawan/idxlens/actions/workflows/ci.yml)
[](https://github.com/lugassawan/idxlens/actions/workflows/ci.yml)
[](LICENSE)
[](https://github.com/lugassawan/idxlens/releases)
IDXLens is a CLI tool that fetches and extracts structured financial data from IDX reports. Supports XLSX, XBRL, and PDF formats with automated downloading from the IDX portal.
## Features
- **Authenticate** with IDX portal via headless Chrome (with cookie expiry detection)
- **List and fetch** available financial reports for any ticker
- **Dry-run mode** (`fetch --dry-run`): preview files before downloading
- **Extract financial data** from XLSX (excelize), XBRL (ZIP archives), and PDF presentations
- **Full pipeline** (`analyze`): fetch if needed, then extract from the best available format (XBRL > XLSX > PDF)
- **Presentation KV extraction** for corporate presentations (key-value pair detection from PDF layout)
- **Automatic retry** with exponential backoff for transient API failures (429, 5xx)
- **Verbose logging** (`--verbose`): structured debug output via `slog`
- **ETag caching** for registry: conditional fetches skip re-downloading unchanged data
- **Local caching** via `IDXLENS_HOME` (default: `~/.idxlens`)
- **JSON output** with optional pretty-print
- **Self-update** via `idxlens upgrade` from GitHub Releases
- **Pure Go** -- single static binary, no runtime dependencies
## Quick Install
```sh
# One-line install (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/lugassawan/idxlens/main/scripts/install.sh | bash
# Using go install
go install github.com/lugassawan/idxlens/cmd/idxlens@latest
# Or download a prebuilt binary from GitHub Releases
```
## Docker
```sh
# Pull from GitHub Container Registry
docker pull ghcr.io/lugassawan/idxlens:latest
# Run extraction
docker run --rm -v $(pwd):/data ghcr.io/lugassawan/idxlens extract /data/report.xlsx
# Authenticate (requires display forwarding for headless Chrome)
docker run --rm -v ~/.idxlens:/root/.idxlens ghcr.io/lugassawan/idxlens auth
```
## Usage
```sh
# Authenticate with IDX portal
idxlens auth
# List available reports for a ticker
idxlens list BBCA -y 2024
# Fetch reports to local cache
idxlens fetch BBCA -y 2024 -p Q3
# Preview files without downloading
idxlens fetch BBCA -y 2024 --dry-run
# Extract financial data from a local file
idxlens extract path/to/report.xlsx --pretty
idxlens extract path/to/report.zip # XBRL ZIP
idxlens extract path/to/presentation.pdf --mode presentation
# Full pipeline: fetch (if needed) + extract
idxlens analyze BBCA -y 2024 -p Q3
# Verbose output for debugging
idxlens analyze BBCA -y 2024 --verbose
# Self-update to latest version
idxlens upgrade
```
## Documentation
- [Getting Started](docs/getting-started.md) -- installation and first steps
- [CLI Reference](docs/cli-reference.md) -- all commands and flags
- [Architecture](docs/architecture.md) -- pipeline design and layer details
- [Contributing](docs/contributing.md) -- development setup and guidelines
## Contributing
See [docs/contributing.md](docs/contributing.md) for development setup, code style, and PR guidelines.
## License
[Apache License 2.0](LICENSE)