{"id":20461464,"url":"https://github.com/pythonbyte/zipcode-api","last_synced_at":"2025-10-24T19:28:22.725Z","repository":{"id":181433514,"uuid":"332570200","full_name":"pythonbyte/zipcode-api","owner":"pythonbyte","description":null,"archived":false,"fork":false,"pushed_at":"2021-01-24T22:29:06.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-05T11:35:29.960Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pythonbyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-01-24T22:28:48.000Z","updated_at":"2021-01-24T22:29:10.000Z","dependencies_parsed_at":"2023-07-15T16:06:39.267Z","dependency_job_id":null,"html_url":"https://github.com/pythonbyte/zipcode-api","commit_stats":null,"previous_names":["pythonbyte/zipcode-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pythonbyte/zipcode-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Fzipcode-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Fzipcode-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Fzipcode-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Fzipcode-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pythonbyte","download_url":"https://codeload.github.com/pythonbyte/zipcode-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonbyte%2Fzipcode-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274250508,"owners_count":25249396,"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","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-15T12:25:40.403Z","updated_at":"2025-10-24T19:28:17.681Z","avatar_url":"https://github.com/pythonbyte.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Challenge\n\n# Description\n\nThis project is a Zipcode API.\n\n\n# Installing\n\nFirst step of installation is having Pipenv installed in your machine, if you doesn't have just use the below command:\n\n``` $ pip install pipenv ```\n\nNow after cloned the repository all you need to do is:\n\n```\n$ cd zipcodeapi/\n$ pipenv install\n$ python manage.py migrate\n$ python manage.py createsuperuser\n$ python manage.py runserver\n```\n\n# Testing\n\nTo test the application use:\n\n```$ python manage.py test```\n\n\n# API documentation\n\nThis API works with 1 endpoint:\n\n## Zipcode Endpoint\nThis endpoint works at the **/getzipcode/-zipcode-**. It uses a brazilian type of zipcode like this '30330-330', and returns the fields needed. And only accepts\nPOST method.\n\nPOST data:\n\n/getzipcode/30330330\n\nStatus: 200 OK\n```\n{\n    \"cep\": \"30330330\",\n    \"address\": \"Rua Campo Belo\",\n    \"neighborhood\": \"São Pedro\",\n    \"city\": \"Belo Horizonte\",\n    \"state\": \"MG\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonbyte%2Fzipcode-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpythonbyte%2Fzipcode-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonbyte%2Fzipcode-api/lists"}