Dokumentasi API

Mulai

Base URL: https://api.keretaku.my.id/api/v1

Daftar, buat API key di dashboard, lalu kirim di setiap permintaan lewat header:

X-API-Key: gk_xxxxxxxxxxxxxxxx
# atau
Authorization: Bearer gk_xxxxxxxxxxxxxxxx

Semua respons berupa JSON. Tambahkan ?pretty=1 agar mudah dibaca. Hanya metode GET.

Jangan menaruh API key di kode yang terlihat pengunjung (JavaScript di halaman web publik). Panggil dari server Anda sendiri.

Batas pemakaian (gratis)

1000 permintaan per hari dan 60 per menit, per API key. Setiap respons menyertakan X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset. Kalau terlewati, API membalas 429 dengan Retry-After.

Endpoint

GET /v1/me

Info API key: batas dan sisa kuota hari ini.

GET /v1/kelas

Daftar kelas kereta (Eksekutif, Ekonomi, dst.) beserta jumlah KA.

GET /v1/ka

Daftar KA. Parameter: q (cari nama/nomor/lintas), no_ka (mis. 42, cocok juga dengan 42-43), kelas, stasiun (kode, mis. GMR), page, per_page (maks. 100).

GET /v1/ka/{id}

Detail satu KA beserta seluruh jadwalnya.

GET /v1/ka/{id}/jadwal

Hanya jadwal (daftar stasiun) satu KA.

GET /v1/stasiun

Cari stasiun. Parameter: q (nama atau kode), page, per_page.

GET /v1/stasiun/{kode}/jadwal

KA yang melewati atau berhenti di stasiun, urut jam. Parameter: dari dan sampai (format HH:MM), page, per_page.

Contoh

curl

curl -H "X-API-Key: API_KEY_KAMU" \
  "https://api.keretaku.my.id/api/v1/stasiun/GMR/jadwal?dari=06:00&sampai=09:00&per_page=10"

JavaScript (Node / sisi server)

const r = await fetch("https://api.keretaku.my.id/api/v1/ka?q=argo", {
  headers: { "X-API-Key": process.env.GAPEKA_KEY },
});
const { data, meta } = await r.json();

PHP

$ctx = stream_context_create(['http' => ['header' => "X-API-Key: API_KEY_KAMU\r\n"]]);
$json = json_decode(file_get_contents('https://api.keretaku.my.id/api/v1/ka/1', false, $ctx), true);

Contoh respons /v1/ka/1

{
  "data": {
    "id": 1, "no_ka": "1", "nama_ka": "Anggrek", "kelas": "EKSEKUTIF",
    "lintas": "SBI-GMR", "berangkat_awal": "16:20", "tiba_akhir": "04:10",
    "halaman_dokumen": 12,
    "jadwal": [
      { "no_urut": 1, "stasiun": "Surabaya Pasarturi", "kode": "SBI", "vmax": 60,
        "datang": null, "berangkat": "16:20", "datang_raw": "-", "berangkat_raw": "16:20", "keterangan": null }
    ]
  }
}

datang_raw / berangkat_raw menyimpan isi asli kolom: jam, atau kode Ls (langsung), Sb, Berh, -. Contoh di atas hanya ilustrasi bentuk data.

Kode kesalahan

HTTPcodeArti
401missing_key / invalid_keyAPI key tidak ada, salah, atau dicabut
403account_disabledAkun dinonaktifkan
404not_foundEndpoint atau data tidak ada
422invalid_paramParameter tidak valid
429rate_limited / quota_exceededMelewati batas per menit / per hari
500server_errorKesalahan di server