API Dokumentasi

Akses langsung ke seluruh dataset terbuka Kabupaten Tulang Bawang melalui REST API. Integrasikan data kami ke aplikasi, dashboard, atau sistem analisis Anda dengan mudah.

Versi: v1 Status: Aktif
Pengantar Aturan & Limit Endpoints 1. List Datasets 2. Detail Dataset 3. Data (Isi) Dataset 4. Tahun Tersedia

Pengantar

API Portal Data Tulang Bawang adalah antarmuka Read-Only yang memungkinkan instansi/lembaga (seperti BPS) dan masyarakat umum untuk mengambil data yang telah di-publikasi (verified) ke dalam sistem mereka dengan format JSON.

Base URL:
https://portaldata.tulangbawangkab.go.id/api/v1

Aturan & Rate Limit

Rate Limiting

Untuk menjaga kestabilan server, setiap IP dibatasi maksimal 60 request per menit dan 1000 request per jam. Jika melebihi limit, API akan mengembalikan status 429 Too Many Requests.

Data Bersih

Semua data yang dikembalikan diformat ulang. Kolom ID internal seperti kecamatan_id otomatis dikonversi menjadi nama sebenarnya (misal: "Kecamatan": "Banjar Agung"), dan kolom sistem disembunyikan.

Header Response Terkait Limit:
Header HTTP Deskripsi
X-RateLimit-Limit Batas request maksimal (60).
X-RateLimit-Remaining Sisa request yang dapat dilakukan pada menit/jam ini.
Retry-After Lama waktu (dalam detik) untuk menunggu jika Anda terkena blokir 429.

Daftar Endpoint

Dokumentasi referensi untuk setiap endpoint yang tersedia di API v1.

GET /datasets

Mengambil daftar semua dataset publik yang tersedia beserta metadatanya.

Query Parameters:
ParameterTipeOpsionalDeskripsi
searchStringYaMencari dataset berdasarkan nama/deskripsi.
opdStringYaFilter berdasarkan nama dinas (OPD).
pageIntegerYaHalaman paginasi (default: 1).
per_pageIntegerYaTotal data per halaman (maks: 100).
Example HTTP Request:
GET https://portaldata.tulangbawangkab.go.id/api/v1/datasets?search=penduduk&per_page=10
GET /datasets/{slug}

Mengambil detail metadata dari satu dataset tanpa memuat isinya.

Path Parameters:
ParameterTipeOpsionalDeskripsi
slugStringTidakSlug unik dari dataset.
GET /datasets/{slug}/data

Mengambil data/isi aktual dari sebuah dataset. Data ini merupakan data raw yang sudah dibersihkan.

Query Parameters:
ParameterTipeOpsionalDeskripsi
tahunIntegerYaFilter data berdasarkan tahun spesifik. Jika kosong, mengembalikan versi terbaru (latest).
Example Response:
{ "success": true, "data": { "dataset": "Nama Dataset", "versi": "2", "tahun": 2025, "kolom": ["Kecamatan", "Laki-laki", "Perempuan"], "jumlah_baris": 15, "rows": [ { "Kecamatan": "Banjar Agung", "Laki-laki": 1024, "Perempuan": 1100 } ] } }
GET /datasets/{slug}/years

Mengambil daftar tahun dan versi yang tersedia serta valid untuk dataset terkait.