@prontiq/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @prontiq/sdk API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Prontiq API: Prontiq provides authenticated APIs for Australian address search, validation, enrichment, reverse geocoding, and locality lookup. Authenticate public data requests with X-Api-Key. Successful Address API calls may include rate-limit and credit-usage headers. Errors use a stable { error: { code, message, status, request_id } } envelope; request_id is intentionally snake_case for v1 compatibility.

Table of Contents

• @prontiq/sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @prontiq/sdk

PNPM

pnpm add @prontiq/sdk

Bun

bun add @prontiq/sdk

Yarn

yarn add @prontiq/sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@prontiq/sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Prontiq } from "@prontiq/sdk";

const prontiq = new Prontiq({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await prontiq.address.autocompleteAddress(
    "9 endeavour cou",
    "NSW",
    3,
    "false",
  );

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------ | ------- | | apiKeyAuth | apiKey | API key |

To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:

import { Prontiq } from "@prontiq/sdk";

const prontiq = new Prontiq({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await prontiq.address.autocompleteAddress(
    "9 endeavour cou",
    "NSW",
    3,
    "false",
  );

  console.log(result);
}

run();

Available Resources and Operations

Address

• autocompleteAddress - Autocomplete addresses
• validateAddress - Validate an address
• enrichAddress - Enrich an address by ID
• reverseGeocodeAddress - Reverse geocode nearby addresses
• lookupPostcode - Look up localities by postcode
• lookupSuburb - Look up postcodes by suburb

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• addressAutocompleteAddress - Autocomplete addresses
• addressEnrichAddress - Enrich an address by ID
• addressLookupPostcode - Look up localities by postcode
• addressLookupSuburb - Look up postcodes by suburb
• addressReverseGeocodeAddress - Reverse geocode nearby addresses
• addressValidateAddress - Validate an address

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Prontiq } from "@prontiq/sdk";

const prontiq = new Prontiq({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await prontiq.address.autocompleteAddress(
    "9 endeavour cou",
    "NSW",
    3,
    "false",
    {
      retries: {
        strategy: "backoff",
        backoff: {
          initialInterval: 1,
          maxInterval: 50,
          exponent: 1.1,
          maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
      },
    },
  );

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Prontiq } from "@prontiq/sdk";

const prontiq = new Prontiq({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await prontiq.address.autocompleteAddress(
    "9 endeavour cou",
    "NSW",
    3,
    "false",
  );

  console.log(result);
}

run();

Error Handling

ProntiqError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Prontiq } from "@prontiq/sdk";
import * as errors from "@prontiq/sdk/models/errors";

const prontiq = new Prontiq({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  try {
    const result = await prontiq.address.autocompleteAddress(
      "9 endeavour cou",
      "NSW",
      3,
      "false",
    );

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ProntiqError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.AddressErrorResponse) {
        console.log(error.data$.error); // errors.ErrorT
      }
    }
  }
}

run();

Error Classes

Primary errors:

• ProntiqError: The base class for HTTP error responses.
  • AddressErrorResponse: Standard public Address API error envelope. The nested error.request_id field is intentionally snake_case in v1.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from ProntiqError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Prontiq } from "@prontiq/sdk";

const prontiq = new Prontiq({
  serverURL: "https://api.prontiq.dev",
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await prontiq.address.autocompleteAddress(
    "9 endeavour cou",
    "NSW",
    3,
    "false",
  );

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { Prontiq } from "@prontiq/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@prontiq/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Prontiq({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Prontiq } from "@prontiq/sdk";

const sdk = new Prontiq({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy