# Endpoint index

> Documentation index for AI agents: [/llms.txt](https://docs.apiindonesia.id/llms.txt). Every page is also available as markdown: add `.md` to the URL.

Every API Indonesia endpoint (170 operations) on one short page.

All 170 operations from the [OpenAPI spec](https://apiindonesia.id/openapi.json), grouped by product guide. Base URL: `https://use.apiindonesia.id`.

## [Regions, postal codes and boundaries](https://docs.apiindonesia.id/products/wilayah-kodepos.md)

- `GET /api/v1/wilayah/provinsi`: List provinces
- `GET /api/v1/wilayah/provinsi/{id}`: Retrieve a province
- `GET /api/v1/wilayah/provinsi/{id}/kabupaten`: List regencies/cities in a province
- `GET /api/v1/wilayah/kabupaten`: List regencies/cities
- `GET /api/v1/wilayah/kabupaten/{id}`: Retrieve a regency/city
- `GET /api/v1/wilayah/kabupaten/{id}/kecamatan`: List districts in a regency/city
- `GET /api/v1/wilayah/kecamatan`: List districts
- `GET /api/v1/wilayah/kecamatan/{id}`: Retrieve a district
- `GET /api/v1/wilayah/kecamatan/{id}/kelurahan`: List villages in a district
- `GET /api/v1/wilayah/kelurahan`: List villages
- `GET /api/v1/wilayah/kelurahan/{id}`: Retrieve a village
- `GET /api/v1/wilayah/search`: Search regions
- `GET /api/v1/kodepos`: List postal codes
- `GET /api/v1/kodepos/lookup`: Cross-system code lookup
- `GET /api/v1/kodepos/search`: Search postal codes
- `GET /api/v1/kodepos/{id}`: Retrieve a postal code
- `GET /api/v1/wilayah-boundary`: List boundaries
- `GET /api/v1/wilayah-boundary/{code}/metadata`: Boundary metadata
- `GET /api/v1/wilayah-boundary/{code}`: Boundary GeoJSON

## [Public holidays and Hijri calendar](https://docs.apiindonesia.id/products/libur-hijriah.md)

- `GET /api/v1/libur`: List public holidays
- `GET /api/v1/libur/upcoming`: Upcoming holidays
- `GET /api/v1/libur/{id}`: Retrieve a holiday
- `GET /api/v1/hijriah/konversi`: Convert date
- `GET /api/v1/hijriah/kalender`: Year calendar

## [Prayer times](https://docs.apiindonesia.id/products/sholat.md)

- `GET /api/v1/sholat/list-kota`: List available cities
- `GET /api/v1/sholat`: Daily prayer times
- `GET /api/v1/sholat/monthly`: Monthly prayer times

## [BMKG: earthquakes, weather, warnings and air quality](https://docs.apiindonesia.id/products/bmkg.md)

- `GET /api/v1/gempa/terkini`: Latest earthquakes
- `GET /api/v1/gempa/dirasakan`: Felt earthquakes
- `GET /api/v1/gempa/history`: Earthquake history
- `GET /api/v1/cuaca`: Village weather forecast
- `GET /api/v1/cuaca/search`: Search forecast location
- `GET /api/v1/peringatan-dini`: List weather warnings
- `GET /api/v1/kualitas-udara`: Today cached readings
- `GET /api/v1/kualitas-udara/{city}`: Latest city reading

## [Schools, universities and hospitals](https://docs.apiindonesia.id/products/pendidikan-kesehatan.md)

- `GET /api/v1/sekolah`: List schools
- `GET /api/v1/sekolah/search`: Search schools
- `GET /api/v1/sekolah/{npsn}`: Retrieve a school
- `GET /api/v1/kampus`: List universities
- `GET /api/v1/kampus/search`: Search universities
- `GET /api/v1/kampus/{id}`: Retrieve a university
- `GET /api/v1/rumah-sakit`: List hospitals
- `GET /api/v1/rumah-sakit/search`: Search hospitals
- `GET /api/v1/rumah-sakit/{id}`: Retrieve a hospital

## [Finance: exchange rates, minimum wage, QRIS and rupiah](https://docs.apiindonesia.id/products/keuangan.md)

- `GET /api/v1/kurs/latest`: Latest exchange rate
- `GET /api/v1/kurs/history`: Historical exchange rates
- `GET /api/v1/ump`: List UMP (latest first)
- `GET /api/v1/ump/{province_code}`: UMP per province (all years)
- `GET /api/v1/ump/{province_code}/{year}`: UMP province × year
- `POST /api/v1/util/rupiah/format`: Format Rupiah
- `POST /api/v1/util/qris/parse`: Parse QRIS
- `POST /api/v1/util/rupiah/parse`: Parse Rupiah
- `POST /api/v1/util/rupiah/terbilang`: Spell out Rupiah
- `POST /api/v1/util/qris/to-dynamic`: Convert to dynamic QRIS
- `GET /api/v1/kurs-bi/latest`: Latest rates
- `GET /api/v1/kurs-bi/history`: Rate history

## [Validation and test data](https://docs.apiindonesia.id/products/validasi.md)

- `GET /api/v1/validasi/bank`: List banks
- `POST /api/v1/validasi/nik`: Validate NIK
- `POST /api/v1/validasi/npwp`: Validate NPWP
- `POST /api/v1/util/dummy/nik`: Generate dummy NIK
- `POST /api/v1/util/dummy/npwp`: Generate dummy NPWP
- `POST /api/v1/util/dummy/telepon`: Generate dummy TELEPON

## [Halal, BPOM, trademarks and OJK](https://docs.apiindonesia.id/products/regulasi.md)

- `GET /api/v1/halal`: Search halal
- `GET /api/v1/halal/{id}`: Supervisor detail
- `GET /api/v1/bpom`: Search products
- `GET /api/v1/bpom/{nie}`: NIE detail
- `GET /api/v1/ojk/products`: List legal investment products
- `GET /api/v1/ojk/products/{id}`: Investment product detail
- `GET /api/v1/ojk/apps`: List legal investment apps
- `GET /api/v1/ojk/apps/{id}`: Investment app detail
- `GET /api/v1/ojk/illegals`: List illegal investments
- `GET /api/v1/ojk/illegals/{id}`: Illegal investment detail
- `GET /api/v1/merek/search`: Search registered trademarks
- `GET /api/v1/merek/{appNumber}`: Trademark detail
- `GET /api/v1/merek/journal`: Search the trademark journal

## [Other data: Al-Quran, Alkitab, KBBI, plates, astronomy, food prices](https://docs.apiindonesia.id/products/referensi.md)

- `GET /api/v1/meta/datasets`: List dataset metadata
- `GET /api/v1/meta/datasets/{dataset}`: Retrieve dataset metadata
- `GET /api/v1/quran/list-surah`: List surah
- `GET /api/v1/quran/surah/{id}`: Retrieve a surah
- `GET /api/v1/alkitab/books`: List books
- `GET /api/v1/alkitab/books/{testament}`: List books by testament
- `GET /api/v1/alkitab/passage/{bookAbbr}/{chapter}`: Read a chapter
- `GET /api/v1/alkitab/verse/{bookAbbr}/{chapter}/{verse}`: Read a single verse
- `GET /api/v1/alkitab/search`: Search verses
- `GET /api/v1/kbbi/search`: Search words
- `GET /api/v1/kbbi/word/{word}`: Look up a word
- `GET /api/v1/kbbi/random`: Random words
- `GET /api/v1/plates`: List vehicle plates
- `GET /api/v1/plates/{code}`: Retrieve a plate code
- `GET /api/v1/astronomi/sun`: Sunrise & sunset
- `GET /api/v1/astronomi/twilight`: Twilight times
- `GET /api/v1/astronomi/moon`: Moon phase
- `GET /api/v1/astronomi/moon/next`: Upcoming moon phases
- `GET /api/v1/astronomi/gerhana`: Eclipse predictions
- `GET /api/v1/harga-pangan`: Food-price series overview
- `GET /api/v1/harga-pangan/harga`: Monthly food prices
- `GET /api/v1/harga-pangan/anomali`: Food-price anomaly index

## [Other data: Transjakarta and points of interest](https://docs.apiindonesia.id/products/transport-poi.md)

- `GET /api/v1/transjakarta/rute`: List routes
- `GET /api/v1/transjakarta/rute/{id}`: Retrieve a route
- `GET /api/v1/transjakarta/halte`: List halte
- `GET /api/v1/transjakarta/halte/nearby`: Nearest halte
- `GET /api/v1/transjakarta/halte/{id}`: Retrieve a halte
- `GET /api/v1/transjakarta/tarif`: List fares
- `GET /api/v1/transjakarta/jadwal`: Departure headways
- `GET /api/v1/poi`: Search & list POI
- `GET /api/v1/poi/nearby`: Nearest POI
- `GET /api/v1/poi/categories`: List categories
- `GET /api/v1/poi/{id}`: Retrieve a POI

## [Toll roads: toll gates, roads and tariffs](https://docs.apiindonesia.id/products/jalan-tol.md)

- `GET /api/v1/tol/ruas`: List toll roads
- `GET /api/v1/tol/ruas/{id}`: Retrieve a toll road
- `GET /api/v1/tol/gerbang`: List toll gates
- `GET /api/v1/tol/gerbang/nearby`: Nearest toll gates
- `GET /api/v1/tol/gerbang/{id}`: Retrieve a toll gate
- `GET /api/v1/tol/tarif`: Toll tariffs

## [Airports and ports](https://docs.apiindonesia.id/products/bandara-pelabuhan.md)

- `GET /api/v1/bandara`: List airports
- `GET /api/v1/bandara/nearby`: Nearest airports
- `GET /api/v1/bandara/{kode}`: Retrieve an airport
- `GET /api/v1/pelabuhan`: List ports
- `GET /api/v1/pelabuhan/nearby`: Nearest ports
- `GET /api/v1/pelabuhan/{id}`: Retrieve a port

## [Bus terminals and railway stations](https://docs.apiindonesia.id/products/terminal-stasiun.md)

- `GET /api/v1/terminal`: List bus terminals
- `GET /api/v1/terminal/nearby`: Nearest terminals
- `GET /api/v1/terminal/{id}`: Retrieve a terminal
- `GET /api/v1/stasiun`: List stations
- `GET /api/v1/stasiun/nearby`: Nearest stations
- `GET /api/v1/stasiun/{kode}`: Retrieve a station

## [Wages, customs and energy regulation](https://docs.apiindonesia.id/products/regulasi-ekonomi.md)

- `GET /api/v1/umk`: List UMK by regency/city
- `GET /api/v1/umk/{kode}`: Retrieve one regency/city UMK
- `GET /api/v1/hs/bab`: List BTKI chapters
- `GET /api/v1/hs`: List HS codes
- `GET /api/v1/hs/{kode}`: Retrieve one HS code
- `GET /api/v1/energi/tarif-listrik`: Electricity tariffs in force
- `GET /api/v1/energi/tarif-listrik/riwayat`: Electricity tariff history for one class
- `GET /api/v1/energi/bbm`: Subsidised fuel prices in force
- `GET /api/v1/energi/bbm/riwayat`: Fuel price history

## [Public facilities](https://docs.apiindonesia.id/products/fasilitas-publik.md)

- `GET /api/v1/fasilitas/kategori`: Categories and facility counts
- `GET /api/v1/fasilitas`: List facilities
- `GET /api/v1/fasilitas/nearby`: Nearest facilities
- `GET /api/v1/fasilitas/{id}`: Retrieve one facility

## [Other data: world geo, IP geolocation and LEI](https://docs.apiindonesia.id/products/geo-ip-lei.md)

- `GET /api/v1/ip/{ip}`: Look up an IP address
- `GET /api/v1/ip/me`: Look up the caller's IP
- `POST /api/v1/ip/batch`: Look up many IP addresses
- `GET /api/v1/lei`: Search legal entities
- `GET /api/v1/lei/{lei}`: Retrieve an LEI
- `GET /api/v1/lei/{lei}/children`: List children
- `GET /api/v1/geo/negara`: List countries
- `GET /api/v1/geo/negara/{code}`: Retrieve a country
- `GET /api/v1/geo/kota`: Search cities
- `GET /api/v1/geo/kota/nearby`: Nearest cities
- `GET /api/v1/geo/kota/{geonameid}`: Retrieve a city
- `GET /api/v1/geo/zona-waktu`: List time zones
- `GET /api/v1/geo/zona-waktu/{tz}`: Time zone with local time

## [Image upscale](https://docs.apiindonesia.id/products/image-upscale.md)

- `POST /api/v1/image/upscale/2x`: Upscale 2x (up to 4 MP output)
- `POST /api/v1/image/upscale/4x`: Upscale 4x (up to 16 MP output)
- `POST /api/v1/image/upscale/8x`: Upscale 8x (up to 64 MP output)
- `GET /api/v1/image/jobs/{id}`: Job status
- `GET /api/v1/image/jobs/{id}/file`: Download the result

## [Account and billing](https://docs.apiindonesia.id/authentication.md#account-endpoints)

- `POST /auth/register`: Register
- `POST /auth/login`: Log in
- `GET /auth/me`: Get current user
- `GET /user/keys`: List API keys
- `POST /user/keys`: Create an API key
- `DELETE /user/keys/{id}`: Revoke an API key
- `GET /user/usage`: Usage statistics
- `GET /billing/plans`: Plan list
- `POST /billing/subscribe`: Start checkout
- `GET /billing/status`: Subscription status
- `POST /billing/webhook`: Sumopod webhook
- `POST /billing/topup`: Buy credits (pay as you go)
- `GET /billing/credits`: Credit balance

The interactive reference with code samples in several languages is the docs home page (`/` in Indonesian, `/en/` in English).