Parsing addresses can be a complex and time-consuming task.

Different address formats and variations can make it challenging to extract accurate information from address strings.

Fortunately, Address Parser Go REST provides a simple solution to this problem.

This REST API allows you to parse addresses into their individual components quickly and easily.

What is Address Parser Go REST?

Address Parser Go REST is a REST API that uses the libpostal library to parse addresses into their individual components.

By submitting a request to the API with an address, you will receive a JSON response with the parsed components.

This API removes the need to include the libpostal library as a dependency in your project and allows you to parse addresses with ease.

How does Address Parser Go REST work?

Address Parser Go REST uses the libpostal library to parse addresses.

The library is a powerful natural language processing library for addresses that can handle different address formats, variations, and misspellings, ensuring accurate parsing results.

The API is built with Go, a fast and efficient programming language, which allows for speedy processing of requests.

Getting started with Address Parser Go REST

docker run -p 8080:8080 gosom/address-parser-go-rest:v1.0.1

This command will run the Address Parser Go REST API container and map port 8080 of the container to port 8080 of your machine.

Now you can start parsing addresses! Here's an example of how to parse an address using the API:

curl --location --request POST 'http://localhost:8080/parse' --header 'Content-Type: application/json' --data-raw '{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA 94043",
    "title_case": true
}'

This command sends a POST request to the /parse endpoint of the API with a JSON payload containing an address string. The API will parse the address and return a JSON response with the individual components of the address:

{
  "house_number": "1600",
  "road": "Amphitheatre Parkway",
  "postcode": "94043",
  "city": "Mountain View",
  "state": "Ca"
}

The title_case parameter is optional. Default behavior of libpostal is to return all addresses in lower case and if you omit that then you will have the same behavior.

That's it! You've successfully parsed an address using Address Parser Go REST.

You can see the available options and the responses in swagger documentation.

Access it by visiting localhost:8080/docs .

Acknowledgements

We would like to acknowledge the contributors of the libpostal library and the Go bindings used in this project.

We appreciate their hard work and dedication to creating these useful tools.

Conclusion

Address Parser Go REST is a simple solution for parsing addresses that can save you time and effort.

With its powerful parsing capabilities and efficient processing, this REST API is a useful tool for any project that requires address parsing.

If you encounter any issues or have feedback to provide, please create a new issue on the GitHub repository.