All updates

TypeScript SDK

@addresszen/sdk is our TypeScript SDK for the AddressZen API. It runs in browsers and Node.js 22 or later, has no runtime dependencies and covers every API operation with generated types.

Details

  • Native fetch: Requests use the runtime's own fetch, so there is no HTTP client to install
  • No runtime dependencies: Installing the SDK adds nothing else to your dependency tree
  • Tree-shakeable: Each operation is a named export, so bundlers keep only what you import. A client and findAddress come to about 4.4 kB minified and gzipped
  • Every operation: Address autocomplete and retrieval, US address verification, place search, email and phone validation, plus key, licensee and configuration management
  • Types from the OpenAPI spec: Every request and response is typed, including USPS CASS fields and each country's native dataset record
  • Autocomplete helper: createAutocomplete debounces keystrokes and drops stale requests, ready to wire to your own search box. Switch country by passing a context from the countries your key can search
  • React and Preact: Optional TanStack Query adapters provide query options for every operation
  • Typed errors: HTTP failures throw an ApiError with the status, API error code and message
  • Agent skill: npx skills add addresszen/skills gives coding agents setup guides and a reference for each operation

Start with the TypeScript SDK documentation.