Mulai Cepat

Kode Pos API menyediakan data kode pos Indonesia melalui MCP Server, REST API, dan GraphQL API. Dokumentasi ini akan membantu Anda mulai menggunakan API dalam beberapa menit.

Prasyarat

Autentikasi

Semua request memerlukan header Authorization: Bearer untuk autentikasi.

curl -H "Authorization: Bearer kp_live_xxxxxxxxxxxxxxxx" \
  https://api.kodepos.dev/kodepos/api/provinces

MCP Server

Cara tercepat untuk menggunakan Kode Pos API adalah melalui MCP (Model Context Protocol) Server. Hubungkan platform automasi dan AI agent Anda — tanpa kode integrasi HTTP.

REST API

Untuk integrasi langsung via HTTP, gunakan REST API. Endpoint /search mencari kelurahan/desa berdasarkan kata kunci:

curl -H "Authorization: Bearer kp_live_xxxxxxxxxxxxxxxx" \
  "https://api.kodepos.dev/kodepos/api/search?q=menteng&first=5"

GraphQL API

Untuk fleksibilitas maksimal, gunakan GraphQL API — ambil hanya field yang Anda butuhkan dalam satu permintaan. Satu endpoint untuk semua data kode pos Indonesia.

curl -X POST "https://api.kodepos.dev/kodepos/graphql" \
  -H "Authorization: Bearer kp_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ provinces(first: 5) { items { code name } pagination { hasNextPage endCursor } } }"}'

Lihat referensi lengkap schema, query, dan contoh nested hierarchy di halaman GraphQL API.

Contoh Response

Response menggunakan format envelope success + data, dengan data berisi array kelurahan/desa beserta hierarki lengkap.

{
  "success": true,
  "data": [
    {
      "code": "31.73.06.1003",
      "name": "Menteng",
      "postalCode": "10310",
      "district": {
        "code": "31.73.06",
        "name": "Menteng"
      },
      "city": {
        "code": "31.73",
        "name": "Kota Jakarta Pusat"
      },
      "province": {
        "code": "31",
        "name": "DKI Jakarta"
      }
    }
  ],
  "pagination": {
    "hasNextPage": true,
    "endCursor": "eyJjb2RlIjoiMzEuNzMuMDYuMTAwMyJ9"
  }
}

Langkah Selanjutnya