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","properties":{"country":"United States","country_code":"us","state":"Maryland","county":"Prince George's County","postcode":"20772","street":"Furlong Court","datasource":{"sourcename":"openstreetmap","attribution":"Β© OpenStreetMap contributors","license":"Open Database License","url":"https://www.openstreetmap.org/copyright"},"state_code":"MD","lon":-76.8148443,"lat":38.8253609,"housenumber":"6","result_type":"building","city":"Upper Marlboro","formatted":"6 Furlong Court, Upper Marlboro, MD 20772, United States of America","address_line1":"6 Furlong Court","address_line2":"Upper Marlboro, MD 20772, 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"},"plus_code":"87C5R5GP+43","plus_code_short":"R5GP+43 Upper Marlboro, Prince George's County, United States","rank":{"confidence":0.5,"confidence_street_level":1,"confidence_building_level":0,"match_type":"full_match"},"place_id":"5140f5b468263453c059d5720c6da5694340f00102f9019390be2500000000c00203"},"geometry":{"type":"Point","coordinates":[-76.8148443,38.8253609]},"bbox":[-76.8148443,38.8253609,-76.8135279,38.8254062]}],"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 commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

πŸš€ Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Specialized Customer Support
  • Real-Time API Monitoring

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

Address Autocompletion API FAQs

The Address Autocomplete API returns suggestions for matching addresses based on user input. The data includes details such as country, state, city, street, postal code, and formatted address, all structured in a JSON format.

Key fields in the response include "formatted" (full address), "country" (country name), "state" (state name), "city" (city name), "postcode" (postal code), and "coordinates" (latitude and longitude).

The response data is organized in a JSON structure under "FeatureCollection," containing an array of "features." Each feature represents a suggested address with properties detailing its components and geographical information.

The API provides information on addresses, including street names, city and state details, postal codes, and geographical coordinates. It also supports international addresses and multiple languages.

The Address Autocomplete API sources its data from OpenStreetMap and other reliable databases. This ensures a broad coverage of addresses and points of interest globally.

Users can customize their requests by providing partial address strings as input. The API will return suggestions based on the input, allowing for tailored autocomplete functionality.

Typical use cases include autocompleting address fields in online forms, enhancing user experience in location-based services, verifying addresses for shipping, and searching for points of interest.

Data accuracy is maintained through regular updates from reliable sources like OpenStreetMap, along with quality checks to ensure that the address suggestions are current and relevant.

General FAQs

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, refer to the β€˜X-Zyla-API-Calls-Monthly-Remaining’ field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.

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 3,600, it means 3,600 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 give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.

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 free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.

Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.


Related APIs


You might also like