Dokumentasi API
COEkaki REST API v1 — akses data COE Singapura secara pemprograman.
Pengesahan
Semua titik akhir menyokong kedua-dua akses yang disahkan dan awam. Permintaan yang disahkan menerima had kadar yang lebih tinggi.
Lulus kunci API anda melalui X-API-Key pengepala. Jangan sekali-kali menghantar kunci sebagai parameter pertanyaan.
curl -H "X-API-Key: your_api_key_here" \
https://coekaki.com/api/v1/results/latest
Had permintaan
| Tahap Akses | Had permintaan |
|---|---|
| Awam (tiada kunci API) | Permintaan 100/minit |
| Disahkan (dengan kunci API) | 1,000 permintaan/minit |
Status had kadar dikembalikan melalui X-RateLimit-* pengepala respons.
Format Respons
Semua respons mengembalikan JSON dengan struktur yang konsisten:
{
"data": [ ... ],
"meta": {
"total": 50,
"page": 1,
"per_page": 50,
"last_page": 1
}
}
Setiap respons termasuk X-API-Version: v1 pengepala.
Kod Ralat
| Status HTTP | Kod | Penerangan |
|---|---|---|
| 401 | INVALID_API_KEY | Kunci API yang disediakan tidak sah. |
| 404 | NOT_FOUND | Sumber yang diminta tidak wujud. |
| 422 | VALIDATION_ERROR | Permintaan parameter gagal pengesahan. |
| 429 | RATE_LIMITED | Terlalu banyak permintaan. Perlahan dan cuba semula. |
Keputusan COE
/api/v1/results
Senaraikan hasil pembidaan COE dengan penomboran dan penapis pilihan.
Parameter
| Parameter | Jenis | Penerangan |
|---|---|---|
| category | string | Tapis mengikut kategori: A, B, C, D atau E |
| from | date | Tarikh mula (TTTT-MM-DD) |
| kepada | date | Tarikh tamat (TTTT-MM-DD) |
| page | integer | Nombor halaman (lalai: 1) |
| per_page | integer | Keputusan setiap halaman (maks: 200, lalai: 50) |
GET /api/v1/results?category=A&from=2025-01-01&to=2025-12-31
/api/v1/results/latest
Dapatkan keputusan pusingan pembidaan terbaharu untuk semua kategori.
{
"data": [
{
"id": 1,
"bidding_date": "2026-04-09",
"bidding_round": 1,
"category": "A",
"quota_premium": 98000,
"pqp": 95000,
"bids_submitted": 2100,
"bids_successful": 1850
}
],
"meta": { "total": 5, "bidding_date": "2026-04-09" }
}
/api/v1/results/{id}
Dapatkan satu hasil COE dengan ID berangkanya. Mengembalikan 404 jika tidak dijumpai.
Trend
/api/v1/trends
Trend premium COE sejarah dikumpulkan mengikut kategori. Mengembalikan data sedia carta.
Parameter
| Parameter | Jenis | Penerangan |
|---|---|---|
| months | integer | Bilangan bulan untuk melihat ke belakang (1-120, lalai: 12) |
| category | string | Tapis kepada satu kategori: A, B, C, D atau E |
| from | date | Tarikh mula (TTTT-MM-DD) |
| kepada | date | Tarikh tamat (TTTT-MM-DD) |
/api/v1/trends/pqp
Aliran PQP (Premium Kuota Lazim) mengikut kategori, termasuk penyebaran premium-vs-PQP.
PQP dan beza premiumnya bernilai null apabila data sejarah tidak mencukupi atau kategorinya E. Kenderaan Kategori E memperbaharui COE di bawah kategori kenderaan A–D yang sepadan.
Menerima parameter yang sama seperti /trends.
Jadual bidaan
/api/v1/schedule
Senaraikan semua jadual pembidaan, dipesan mengikut terbaharu dahulu.
/api/v1/schedule/upcoming
Pusingan bidaan akan datang yang belum bermula.
/api/v1/schedule/current
Pusingan bidaan langsung semasa, jika ada. Pulangan data: null apabila tiada senaman secara langsung.
{
"data": null,
"meta": {
"is_live": false,
"message": "No bidding exercise is currently live."
}
}
Pembatalan pendaftaran
/api/v1/deregistrations
Senaraikan data penyahdaftaran kenderaan dengan penapis dan penomboran.
Parameter
| Parameter | Jenis | Penerangan |
|---|---|---|
| category | string | Tapis mengikut kategori: A, B, C, D atau E |
| from | date | Tarikh mula (TTTT-MM-DD) |
| kepada | date | Tarikh tamat (TTTT-MM-DD) |
| per_page | integer | Keputusan setiap halaman (maks: 200, lalai: 50) |
/api/v1/deregistrations/latest
Data pembatalan pendaftaran bulan terkini untuk semua kategori (atau tapis mengikut category).
Kuota COE
/api/v1/quotas
Senaraikan peruntukan kuota COE suku tahunan dengan penomboran dan penapis.
Parameter
| Parameter | Jenis | Penerangan |
|---|---|---|
| category | string | Tapis mengikut kategori: A, B, C, D atau E |
| from | date | Tarikh mula untuk suku_mula (YYYY-MM-DD) |
| kepada | date | Tarikh tamat untuk suku_mula (YYYY-MM-DD) |
| per_page | integer | Keputusan setiap halaman (maks: 200, lalai: 50) |
/api/v1/quotas/latest
Peruntukan kuota COE suku semasa. Kembali ke suku terbaharu jika data semasa belum tersedia.
Sejarah PQP
/api/v1/pqp
Sejarah PQP (Premium Kuota Lazim) dengan spread premium-vs-PQP untuk setiap hasil.
PQP dan beza premiumnya bernilai null apabila data sejarah tidak mencukupi atau kategorinya E. Kenderaan Kategori E memperbaharui COE di bawah kategori kenderaan A–D yang sepadan.
Parameter
| Parameter | Jenis | Penerangan |
|---|---|---|
| category | string | Tapis mengikut kategori: A, B, C, D atau E |
| from | date | Tarikh mula (TTTT-MM-DD) |
| kepada | date | Tarikh tamat (TTTT-MM-DD) |
| per_page | integer | Keputusan setiap halaman (maks: 200, lalai: 50) |
{
"data": [
{
"id": 1,
"bidding_date": "2026-04-09",
"bidding_round": 1,
"category": "A",
"pqp": 95000,
"quota_premium": 98000,
"premium_vs_pqp": 3000
}
],
"meta": { "total": 50, "page": 1, "per_page": 50, "last_page": 1 }
}