Address Autocompletion API

Address Autocompletion API

The Address Autocomplete API allows developers to build location-based services by providing suggestions for matching addresses as users type in a search box. This can be used to autocomplete address fields in forms, improve the user experience and reduce errors. The API supports international addresses and returns data in JSON format.

About the API:

The Address Autocomplete API is a powerful tool for developers who need to build location-based services such as address autocomplete fields. The API allows users to enter a part of an address in a search box and provides suggestions for matching locations in real time. This can improve the user experience by reducing errors and speeding up the process of entering an address. The API supports international addresses, and this feature makes it a versatile tool for global applications.

The API is easy to use and requires only the address or part of the address as a parameter. The API returns the suggestions in JSON format, which makes it easy to integrate into a wide variety of applications and systems.

The Address Autocomplete API can be used for a variety of purposes such as:

  • Autocompleting address fields in forms
  • Improving user experience
  • Reducing errors
  • Geolocation
  • Point of interest search
  • Addressing verification
  • International address support

With its powerful capabilities and easy-to-use interface, the Address Autocomplete API is an essential tool for any developer working with location-based services, geolocation and addressing verification.

 

What this API receives and what your API provides (input/output)?

Pass the address to this API, and receive the suggestion based on that query. 

 

What are the most common uses cases of this API?

  1. Autocompleting address fields in forms: The Address Autocomplete API can be used to autocomplete address fields in forms, making it easier and faster for users to enter their address information.

  2. Improving user experience: The API can be used to provide real-time suggestions for matching locations as users type in a search box, which can help to improve the user experience and reduce errors.

  3. Geolocation: The API can be used to provide suggestions for matching locations based on geolocation data, making it useful for location-based services and applications.

  4. Point of interest search: The API can be used to search for points of interest, such as shops, restaurants, and more, based on a user's location or address.

  5. Addressing verification: The API can be used to verify address information and detect errors, which can help to improve data quality and reduce mailing and shipping errors.

  6. International address support: The API supports international addresses, which makes it a versatile tool for global applications, it also supports multiple languages.

 

Are there any limitations to your plans?

Besides API call limitations per month, there are no other limitations.

API Documentation

Endpoints


The Address Autocomplete API allows developers to build location-based services like autocomplete fields. When a user enters a part of an address in the search box, the API provides suggestions for matching locations.



                                                                            
GET https://zylalabs.com/api/957/address+autocompletion+api/782/autocomplete
                                                                            
                                                                        

Autocomplete - Endpoint Features
Object Description
text [Required] Free-form address, place, region or area name
lang [Optional] Preferable results language code (en, de, it, fr)
countrycodes [Optional] Limit search to a comma-separated list of countries (ISO country codes)
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Point","coordinates":[-88.07111,42.309594]},"properties":{"country_code":"us","housenumber":"6","street":"Furlong Court","country":"United States","county":"Lake County","datasource":{"sourcename":"openaddresses","attribution":"© OpenAddresses contributors","license":"BSD-3-Clause License"},"postcode":"60030","state":"Illinois","district":"Avon Township","city":"Grayslake","lon":-88.07111,"lat":42.309594,"state_code":"IL","formatted":"6 Furlong Court, Grayslake, IL 60030, United States of America","address_line1":"6 Furlong Court","address_line2":"Grayslake, IL 60030, United States of America","timezone":{"name":"America/Chicago","offset_STD":"-06:00","offset_STD_seconds":-21600,"offset_DST":"-05:00","offset_DST_seconds":-18000,"abbreviation_STD":"CST","abbreviation_DST":"CDT"},"result_type":"building","rank":{"confidence":1,"match_type":"full_match"},"place_id":"51ca1af5108d0456c059d784b4c6a0274540c00203e203426f70656e6164647265737365733a616464726573733a75732f696c2f6c616b652d6164647265737365732d636f756e74793a66653937666131656166376137303561"}},{"type":"Feature","geometry":{"type":"Point","coordinates":[-82.256654,34.761693]},"properties":{"country_code":"us","housenumber":"6","street":"Furlong Court","country":"United States","county":"Greenville County","datasource":{"sourcename":"openaddresses","attribution":"© OpenAddresses contributors","license":"BSD-3-Clause License"},"postcode":"29681","state":"South Carolina","city":"Simpsonville","lon":-82.256654,"lat":34.761693,"state_code":"SC","formatted":"6 Furlong Court, Simpsonville, SC 29681, United States of America","address_line1":"6 Furlong Court","address_line2":"Simpsonville, SC 29681, United States of America","timezone":{"name":"America/New_York","offset_STD":"-05:00","offset_STD_seconds":-18000,"offset_DST":"-04:00","offset_DST_seconds":-14400,"abbreviation_STD":"EST","abbreviation_DST":"EDT"},"result_type":"building","rank":{"confidence":1,"match_type":"full_match"},"place_id":"51ce18e6046d9054c059cb4bfe277f614140c00203e203486f70656e6164647265737365733a616464726573733a75732f73632f677265656e76696c6c652d6164647265737365732d636f756e74793a39623733656533366630386435633030"}},{"type":"Feature","properties":{"datasource":{"sourcename":"openstreetmap","attribution":"© OpenStreetMap contributors","license":"Open Database License","url":"https://www.openstreetmap.org/copyright"},"country":"Canada","country_code":"ca","state":"Ontario","county":"Golden Horseshoe","city":"Toronto","postcode":"M1J 1J0","suburb":"Scarborough","quarter":"Scarborough Centre","street":"Furlong Court","housenumber":"6","lon":-79.24499205618424,"lat":43.75197261514236,"state_code":"ON","formatted":"6 Furlong Court, Toronto, ON M1J 1J0, Canada","address_line1":"6 Furlong Court","address_line2":"Toronto, ON M1J 1J0, Canada","timezone":{"name":"America/Toronto","offset_STD":"-05:00","offset_STD_seconds":-18000,"offset_DST":"-04:00","offset_DST_seconds":-14400,"abbreviation_STD":"EST","abbreviation_DST":"EDT"},"result_type":"building","rank":{"importance":0.21000000000000005,"confidence":1,"match_type":"full_match"},"place_id":"51d54529f3adcf53c05913c37ea340e04540f00102f901e1ec860400000000c00203"},"geometry":{"type":"Point","coordinates":[-79.24499205618424,43.75197261514236]},"bbox":[-79.245042056184,43.751922615142,-79.244942056184,43.752022615142]},{"type":"Feature","properties":{"datasource":{"sourcename":"openstreetmap","attribution":"© OpenStreetMap contributors","license":"Open Database License","url":"https://www.openstreetmap.org/copyright"},"country":"United States","country_code":"us","state":"Pennsylvania","county":"Bucks County","city":"Northampton Township","hamlet":"Saint Leonard","postcode":"18966","street":"Furlong Court","housenumber":"6","lon":-74.95064243448398,"lat":40.20137986088271,"state_code":"PA","formatted":"6 Furlong Court, Northampton Township, PA 18966, United States of America","address_line1":"6 Furlong Court","address_line2":"Northampton Township, PA 18966, United States of America","timezone":{"name":"America/New_York","offset_STD":"-05:00","offset_STD_seconds":-18000,"offset_DST":"-04:00","offset_DST_seconds":-14400,"abbreviation_STD":"EST","abbreviation_DST":"EDT"},"result_type":"building","rank":{"importance":-0.8399999999999999,"confidence":1,"match_type":"full_match"},"place_id":"511b935d53d7bc52c0593a48b6d0c6194440f00102f901b7edba0000000000c00203"},"geometry":{"type":"Point","coordinates":[-74.95064243448398,40.20137986088271]},"bbox":[-74.950692434484,40.201329860883,-74.950592434484,40.201429860883]}],"query":{"text":"Furlong Court 6","parsed":{"housenumber":"6","street":"furlong court","expected_type":"building"}}}
                                                                                                                                                                                                                    
                                                                                                    

Autocomplete - CODE SNIPPETS


curl --location --request GET 'https://zylalabs.com/api/957/address+autocompletion+api/782/autocomplete?text=Furlong Court, 6&lang=en&countrycodes=gb' --header 'Authorization: Bearer YOUR_API_KEY' 

    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Address Autocompletion API REST API, simply include your bearer token in the Authorization header.

Headers

Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

🚀 Enterprise
Starts at
$ 10,000/Year

  • Custom Volume
  • Dedicated account manager
  • Service-level agreement (SLA)

Customer favorite features

  • ✔︎ Only Pay for Successful Requests
  • ✔︎ Free 7-Day Trial
  • ✔︎ Multi-Language Support
  • ✔︎ One API Key, All APIs.
  • ✔︎ Intuitive Dashboard
  • ✔︎ Comprehensive Error Handling
  • ✔︎ Developer-Friendly Docs
  • ✔︎ Postman Integration
  • ✔︎ Secure HTTPS Connections
  • ✔︎ Reliable Uptime

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, look at the ‘X-Zyla-API-Calls-Monthly-Remaining’ header. For example, if your plan allows 1000 requests per month and you've used 100, this header will show 900.

To see the maximum number of API requests your plan allows, check the ‘X-Zyla-RateLimit-Limit’ header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

The ‘X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3600, it means 3600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

To let you experience our APIs without any commitment, we offer a 7-day free trial that allows you to make API calls at no cost during this period. Please note that you can only use this trial once, so make sure to use it with the API that interests you the most. Most of our APIs provide a free trial, but some may not support it.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API trial, you can make only 25% of the calls allowed by that plan. For example, if the API plan offers 1000 calls, you can make only 250 during the trial. To access the full number of calls offered by the plan, you will need to subscribe to the full plan.

 Service Level
100%
 Response Time
410ms

Category:


Related APIs