Skip to main content

Introduction

Welcome to the documentation for address-service, a complementary service provided by HoppySearch that allows you to retrieve addresses effortlessly. The address-service is currently designed to be a address index for USA, and in the future, we plan to include addresses from around the world. It operates as a standard HoppySearch index, providing users w

Accessing the Address Index​

To access the address index, you can log in to your HoppySearch account and navigate directly to https://hoppysearch.com/addressService.

Usage​

1. Using the Swagger UI:​

The address-service comes with a Swagger UI, making it easy to explore and execute the available APIs. You can find the Swagger UI at https://hoppysearch.com/addressService.

  • Search Page

2. API Endpoints:​

The address-service provides the following API endpoints:

  • /search (GET and POST): Retrieve addresses based on search parameters.
  • /stats: Obtain statistics related to the address index.

3. Language Packages​

For seamless integration into your projects, we have published packages in below languages:

  • React
  • Angular
  • Javascript/Node

Now, you can utilize the address-service packages in your applications to seamlessly retrieve and integrate address information. Feel free to explore, integrate, and enhance your applications using the address-service provided by HoppySearch.