Extract structured financial data from Indonesia Stock Exchange (IDX) reports (XLSX, XBRL, PDF)
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.
- 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 viaslog - 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 upgradefrom GitHub Releases - Pure Go -- single static binary, no runtime dependencies
# 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# 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# 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- Getting Started -- installation and first steps
- CLI Reference -- all commands and flags
- Architecture -- pipeline design and layer details
- Contributing -- development setup and guidelines
See docs/contributing.md for development setup, code style, and PR guidelines.