# Swiftcomplete Address Autocomplete API (v1)

The **Address Autocomplete API** provides fast, accurate postal address autocomplete and validation. It supports searching for traditional addresses, what3words addresses, postcodes, and more—returning precise and structured address suggestions in real time.

---

## 📚 API Documentation

- [API Overview](https://www.docs.swiftcomplete.com/openapi.yaml)
- [LLMs Text](https://www.docs.swiftcomplete.com/llms.txt)
- [LLMs Full Text](https://www.docs.swiftcomplete.com/llms-full.txt)
- [Postman collection](https://www.docs.swiftcomplete.com/swiftcomplete.postman_collection.json)

### Plugins
Add address autocomplete to e-commerce platforms.

- [Swiftcomplete Address Autocomplete - Shopify](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-shopify) – Implement address autocomplete in Shopify stores
  _Not yet live on developer.what3words.com.
- [Swiftcomplete Address Autocomplete - WooCommerce](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-woocommerce) – Implement address autocomplete in WooCommerce stores  
  _See also [current documentation](https://swiftcomplete.notion.site/WooCommerce-plugin-for-Swiftcomplete-1a466db17f3b8018bc4ce65f85f6c852)_
- [Swiftcomplete Address Autocomplete - BigCommerce](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-bigcommerce) – Implement address autocomplete in BigCommerce stores  
  _See also [current documentation](https://swiftcomplete.notion.site/BigCommerce-Integration-for-Swiftcomplete-1d666db17f3b80e9bfceef1d64bea34d)_
- [Adding Swiftcomplete Address Autocomplete to E-commerce Checkout](https://developer.what3words.com/tutorial/adding-swiftcomplete-address-autocomplete-to-ecommerce-checkout/) – General guide for adding address autocomplete to e-commerce platforms  
  _Not yet live on developer.what3words.com. See [current documentation](https://swiftcomplete.notion.site/Swiftcomplete-Integration-Docs-1a466db17f3b80a18a63dced29d4cfb5)_
- [Swiftcomplete Address Autocomplete - Ecwid](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-ecwid) – Implement address autocomplete in Ecwid stores  
  _See also [current documentation](https://swiftcomplete.notion.site/Ecwid-Integration-for-Swiftcomplete-1f466db17f3b800a95ffef566d22b0f4)_

### Web and Mobile Components
Implement address autocomplete in custom applications.

- [Swiftcomplete Address Autocomplete - JavaScript Component](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-javascript-component) – Add address autocomplete to websites and web applications  
  _See also [current documentation](https://www.notion.so/Swiftcomplete-Swiftcomplete-API-JavaScript-1a066db17f3b8076bc67f00c1ca24742?pvs=4)_
- [Swiftcomplete Address Autocomplete - iOS Component](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-ios-component) – Add address autocomplete to iOS applications
  _Not yet live on developer.what3words.com.  
- [Swiftcomplete Address Autocomplete - Android Component](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-android) – Add address autocomplete to Android applications
  _Not yet live on developer.what3words.com.

### API
Direct API access for address autocomplete.

- [Swiftcomplete Address Autocomplete API](https://developer.what3words.com/tutorial/swiftcomplete-address-autocomplete-api) – Integrate address autocomplete via direct API calls  
---

## 🔑 API Key

- **Required for all endpoints**: Append as a query parameter `key=xxx`.
- **Manage your API keys**: [API Dashboard](https://www.swiftcomplete.com/account/api).

---

## 🌐 API Endpoint

- **Base URL**: `https://api.swiftcomplete.com/v1`
- **Endpoint**: `GET /swiftlookup/`
  - Provides real-time address, postcode, and what3words suggestions.

---

## 🛠 Common Parameters

- **`key`**: Your API key (required).
- **`text`**: Search term (e.g., postcode, street, city, or what3words address).
- **`biasTowards`**: Prioritize results near a specific location (e.g., coordinates or what3words).
- **`searchFor`**: Filter results by type (e.g., "address", "what3words").
- **`countries`**: Restrict search to specific countries (ISO alpha-2 codes).
- **`maxResults`**: Limit the number of results returned.
- **`populateLineCount`**: Number of address lines to return (max: 7).
- **`distanceUnits`**: Units for distance display (e.g., "metric", "imperial").
- **`groupResults`**: Group results when no query is provided.

---

## 🔐 Authentication

- **API Key**: Passed as a query parameter (`key=xxx`).

---

## ❌ Errors

- **400**: Invalid parameters (e.g., `Invalid Bias`).
- **401**: Unauthorized (`Missing Key`).
- **403**: Free trial expired (`Free Trial Expired`).
- **429**: Rate limit exceeded.

---

## 📖 Tools & Guides

- [Integration Guide](https://swiftcomplete.notion.site/Swiftcomplete-Integration-Docs-1a466db17f3b80a18a63dced29d4cfb5)
- [Support](mailto:support@swiftcomplete.com)

---

## 💡 Additional Notes

- **Quota and Usage Limits**:
  - Free trials are limited and return a 403 when expired.
  - Rate limits and quotas vary by plan; exceeding them results in a 429 error.
- **Optimizations**:
  - Use `populateIndex` to resolve full addresses only after user selection.
  - Delay input triggers to minimize repeated API calls.
  - Bias results toward known coordinates or what3words addresses for relevance.

---

## 🌟 Demo and Pricing

- A live demo of the Address Autocomplete API is available at:  
  👉 **[www.swiftcomplete.com](https://www.swiftcomplete.com)**

- For pricing details, visit:  
  👉 **[Pricing Page](https://www.swiftcomplete.com/#pricing)**

---

## 🗂 More Resources

Find all Swiftcomplete public repositories on GitHub:  
👉 **[https://github.com/swiftcomplete-public](https://github.com/swiftcomplete-public)**

---

For more detailed information, refer to the [LLMs Full Text](https://www.docs.swiftcomplete.com/llms-full.txt).