{"_id":"@br-geo-kit/provider-awesomeapi","name":"@br-geo-kit/provider-awesomeapi","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@br-geo-kit/provider-awesomeapi","version":"1.0.0","description":"AwesomeAPI provider for br-geo-kit, with area code and coordinates","license":"MIT","engines":{"node":">=20"},"type":"module","sideEffects":false,"main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"dependencies":{"@br-geo-kit/core":"1.0.0"},"publishConfig":{"access":"public"},"keywords":["awesomeapi","cep","endereco","brasil","br-geo-kit"],"repository":{"type":"git","url":"git+https://github.com/arielff3/br-geo-kit.git","directory":"providers/awesomeapi"},"homepage":"https://github.com/arielff3/br-geo-kit/tree/main/providers/awesomeapi#readme","bugs":{"url":"https://github.com/arielff3/br-geo-kit/issues"},"scripts":{"build":"tsup","clean":"node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\""},"_id":"@br-geo-kit/provider-awesomeapi@1.0.0","_integrity":"sha512-NzRWfqfyoONZ0ZaPaKxKECDbLecZl5ZJF2yjeWpcL8YmaWqyrmDc6QGSdyVpX3waz66EDX3Qc8tiyUrcAxYyHg==","_resolved":"C:\\Users\\ariel\\AppData\\Local\\Temp\\b4d3de90d7a8c7d1393005d9d23e9239\\br-geo-kit-provider-awesomeapi-1.0.0.tgz","_from":"file:br-geo-kit-provider-awesomeapi-1.0.0.tgz","_nodeVersion":"22.17.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-NzRWfqfyoONZ0ZaPaKxKECDbLecZl5ZJF2yjeWpcL8YmaWqyrmDc6QGSdyVpX3waz66EDX3Qc8tiyUrcAxYyHg==","shasum":"639c8d6db2d4de6c8efed4065cab229b89188f3c","tarball":"https://registry.npmjs.org/@br-geo-kit/provider-awesomeapi/-/provider-awesomeapi-1.0.0.tgz","fileCount":10,"unpackedSize":28120,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEgTnvRg4w8vTFAyGPJbigUOu/j5WoDcJTketGWUYlJkAiA0EJp4u1Tm+w9s5f7Q6SyPSLncuHZ/uei0c1J6M1AssQ=="}]},"_npmUser":{"name":"arielff03","email":"arielfrancoferreira5@gmail.com"},"directories":{},"maintainers":[{"name":"arielff03","email":"arielfrancoferreira5@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/provider-awesomeapi_1.0.0_1789134620521_0.36684444670273586"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-11T13:50:20.358Z","1.0.0":"2026-09-11T13:50:20.669Z","modified":"2026-09-11T13:50:20.903Z"},"maintainers":[{"name":"arielff03","email":"arielfrancoferreira5@gmail.com"}],"description":"AwesomeAPI provider for br-geo-kit, with area code and coordinates","homepage":"https://github.com/arielff3/br-geo-kit/tree/main/providers/awesomeapi#readme","keywords":["awesomeapi","cep","endereco","brasil","br-geo-kit"],"repository":{"type":"git","url":"git+https://github.com/arielff3/br-geo-kit.git","directory":"providers/awesomeapi"},"bugs":{"url":"https://github.com/arielff3/br-geo-kit/issues"},"license":"MIT","readme":"# @br-geo-kit/provider-awesomeapi\n\n> AwesomeAPI for br-geo-kit. The fullest single response of the free\n> services.\n\n```bash\npnpm add @br-geo-kit/cep @br-geo-kit/provider-awesomeapi\n```\n\n```ts\nimport { createCep } from '@br-geo-kit/cep'\nimport { awesomeapi } from '@br-geo-kit/provider-awesomeapi'\n\nconst cep = createCep({ providers: [awesomeapi()] })\n```\n\n---\n\n## What it returns\n\n| | |\n| --- | --- |\n| Street, neighbourhood, city, state | yes |\n| Correios side-of-street note | no |\n| IBGE code | yes |\n| Area code | **yes** |\n| Coordinates | **yes** |\n| Reverse lookup | no |\n\nIt is the only free service that returns an area code *and* coordinates\n*and* an IBGE code in one call, which makes it a good chain leader when\nyou want a complete record without the offline dataset.\n\nIt also splits the street into its type and its name. The kit uses the\njoined form and falls back to rebuilding it from the halves.\n\n---\n\n## Its failure modes are the ordinary ones\n\nAwesomeAPI is the only one of the four that answers a missing CEP with a\nreal **404** and a JSON error body, rather than a 200 with a flag buried\nin it. That is worth something: the things that can go wrong are the\nthings you already know how to handle.\n\nIt answers 400 for a CEP outside the allocated space, which the adapter\nalso reads as an absence — the kit normalizes the format before calling,\nso the format is not what is in question.\n\nCoordinates arrive as strings and are parsed rather than cast, because\n`Number('')` is `0` and a silent `(0, 0)` is worse than no location at\nall.\n\n---\n\n## Options\n\n```ts\nawesomeapi({ baseUrl: 'https://cep.awesomeapi.com.br/json' })\n```\n\n## Rate limits\n\nAwesomeAPI publishes no documented rate limit on this endpoint and no\nSLA. Use a cache, and put a second provider behind it. See\n[caching](https://github.com/arielff3/br-geo-kit/blob/main/docs/caching.md)\nand [providers](https://github.com/arielff3/br-geo-kit/blob/main/docs/providers.md).\n\n## Licence\n\nMIT.\n\nThis package is an API client and redistributes no data. It is not\naffiliated with, endorsed by, or sponsored by AwesomeAPI; the name\nidentifies the service it connects to. AwesomeAPI has its own terms of\nuse, and calling it is your relationship with them.\n","readmeFilename":"README.md","_rev":"1-4b9dbe746709c0776e8187ac99202a01"}