{"id":23537357,"url":"https://github.com/grqphical/postal-code-lookup","last_synced_at":"2025-05-15T00:19:37.031Z","repository":{"id":263065736,"uuid":"824700664","full_name":"grqphical/postal-code-lookup","owner":"grqphical","description":"🍁 A simple API to validate and extract information about Canadian postal codes","archived":false,"fork":false,"pushed_at":"2024-12-18T01:17:28.000Z","size":131,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-26T03:14:58.413Z","etag":null,"topics":["api","canada","echo","go","golang","postal-code"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grqphical.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-05T18:13:04.000Z","updated_at":"2024-12-18T01:17:30.000Z","dependencies_parsed_at":"2024-11-16T04:30:58.829Z","dependency_job_id":"767937e3-03c7-451f-898b-84c75fb86c36","html_url":"https://github.com/grqphical/postal-code-lookup","commit_stats":null,"previous_names":["grqphical/postal-code-lookup"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grqphical%2Fpostal-code-lookup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grqphical%2Fpostal-code-lookup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grqphical%2Fpostal-code-lookup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grqphical%2Fpostal-code-lookup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grqphical","download_url":"https://codeload.github.com/grqphical/postal-code-lookup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239250083,"owners_count":19607382,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","canada","echo","go","golang","postal-code"],"created_at":"2024-12-26T03:15:05.853Z","updated_at":"2025-02-17T07:24:57.063Z","avatar_url":"https://github.com/grqphical.png","language":"Go","readme":"# Canadian Postal Code API\n\n[![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)\n\nThis 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.\n\n## Installation\n\nClone the repo, make sure you have Golang installed, then run:\n\n```bash\n$ make run\n```\n\n## Docs\n\nSwagger API Docs are available at `/docs`\n\n## Endpoints\n\n### `/`\n\nA simple status endpoint that returns `OK` if the API is up\n\n### `/v1/postal-code/:postalCode`\n\nThis is the main endpoint of the API. When given a valid Canadian postal code, it will return all relevant information about it.\n\nIf the postal code is invalid it will return an HTTP Status Code of `400`\n\nAll data returned from this endpoint will be in JSON format\n\n## License\n\nThis project is licensed under the GPL V3 License\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrqphical%2Fpostal-code-lookup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrqphical%2Fpostal-code-lookup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrqphical%2Fpostal-code-lookup/lists"}