https://github.com/grqphical/postal-code-lookup

🍁 A simple API to validate and extract information about Canadian postal codes
https://github.com/grqphical/postal-code-lookup

api canada echo go golang postal-code

Last synced: 9 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/grqphical/postal-code-lookup
• Owner: grqphical
• License: gpl-3.0
• Created: 2024-07-05T18:13:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-18T01:17:28.000Z (about 1 year ago)
• Last Synced: 2024-12-26T03:14:58.413Z (about 1 year ago)
• Topics: api, canada, echo, go, golang, postal-code
• Language: Go
• Homepage:
• Size: 128 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Canadian Postal Code API

[![Go Tests](https://github.com/grqphical/postal-code-lookup/actions/workflows/go.yml/badge.svg)](https://github.com/grqphical/postal-code-lookup/actions/workflows/go.yml)

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:

```bash

$ 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