Skip to content

grqphical/postal-code-lookup

Repository files navigation

Canadian Postal Code API

Go Tests

This is an API that allows you to submit a Canadian postal code and recieve information about such as which province in belongs too, which city its in, etc.

Installation

Clone the repo, make sure you have Golang installed, then run:

$ make run

Docs

Swagger API Docs are available at /docs

Endpoints

/

A simple status endpoint that returns OK if the API is up

/v1/postal-code/:postalCode

This is the main endpoint of the API. When given a valid Canadian postal code, it will return all relevant information about it.

If the postal code is invalid it will return an HTTP Status Code of 400

All data returned from this endpoint will be in JSON format

License

This project is licensed under the GPL V3 License

About

🍁 A simple API to validate and extract information about Canadian postal codes

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •