Configurable index demo

NZ address autocomplete for developers

StreetKit adds fast, privacy-first New Zealand address search to forms, checkouts, and web apps with a lightweight JavaScript widget and a static JSON index.

Read the docs Try the demo

Runtime: Browser-side search over static index files.
Data: Fixture sample shaped like the future LINZ-backed index.
Scope: Autocomplete demo only. No billing, accounts, or certification.

Demo address input

Search the active index

This demo reads the configured indexBaseUrl and defaults to /index/v1.

Widget status

Loading configured index...

Debug

Fetching configured index metadata...

indexBaseUrl: /index/v1

{
  "status": "loading"
}

Documentation

Public docs for the first StreetKit build

Start with the copy-paste install, then review configuration, selected address data, privacy, source data, local demo limits, and common questions.

Overview What StreetKit is and is not. Quick start Add the hosted widget to an input. Widget configuration Index URLs, limits, callbacks, and fields. Address object format Structured data returned on selection. Privacy What the autocomplete flow uses. Data sources Official/open address data and attribution. Local/demo limitations Fixture data and local development scope. FAQ Short answers to common integration questions.

Widget usage

Add StreetKit to an address input

The production widget will attach to a normal input, fetch index metadata, rank suggestions in the browser, and return structured NZ address data when a user selects a result.

<input id="address" name="address" autocomplete="off">

<script src="/widget/streetkit.js" defer></script>
<script>
  window.addEventListener("DOMContentLoaded", () => {
    StreetKit.init({
      input: "#address",
      indexBaseUrl: "/index/v1",
      onSelect(address) {
        console.log(address.display.label);
      }
    });
  });
</script>

Data notes

Fixture data for local development

This page intentionally uses a small fixture index so the demo can run from the Git-backed Pages app. It is not the full LINZ NZ Addresses dataset and it is not postal-delivery certification.

Attribution placeholder

Production StreetKit pages will show LINZ / open address data attribution, source dataset version, build date, source links, and known limitations.

Index source: StreetKit fixture data.