The Swiftcomplete API provides realtime address suggestions as you type, eliminating typos and mistakes and reducing the time it takes to find accurate postal addresses.

If you need any help integrating our Swiftcomplete API into your website or application, get in touch, and one of our product experts will help get you started.

Authentication

Each request must be authenticated with a Swiftcomplete API key, which you can create in your Swiftcomplete account:

1. Sign in if you're already registered, or create a Swiftcomplete account if you're new to the service.

2. Go to the API section and create a Swiftcomplete API Key.

Integration options

Once you've created a Swiftcomplete API Key, you can either:

1. Integrate the address lookup onto your website or checkout with the JavaScript Swiftcomplete Integration.
2. Use our WooCommerce Plugin

JavaScript integration

The JavaScript Swiftcomplete integration is a code snippet that can be included on your website or in your checkout to provide address search with real-time suggestions as you type.

Step 1: Add the script to load the Swiftcomplete JS file

Step 2: Add Swiftcomplete functionality to a text field

Step 3: Test your integration

Step 4: Migration Guide: Transitioning to Swiftcomplete

Attributes

These are the configuration options passed into the Swiftcomplete component when initialising the autocomplete. Each parameter customises how the component behaves, from API keys and input fields to how results are displayed and filtered. Use these to tailor the experience to your platform.