# BrasilAPI/cep-promise

Busca por CEP integrado diretamente aos serviços dos Correios, ViaCEP e outros (Node.js e Browser)

Repository: https://github.com/BrasilAPI/cep-promise
Canonical: https://ross.abutalabs.com/products/cep-promise
Language: JavaScript
License: MIT
License Family: permissive
Topics: correios, cep, promise-support, nodejs, browser, javascript, zipcode, hacktoberfest, viacep, cep-promise
Last push: 2024-03-28T22:32:41+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 3929, "days_push": 888, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2968, forks 317 (observed 2026-08-28T04:07:32.629807+00:00)

## What it is
A JavaScript library for looking up Brazilian postal codes (CEP) that queries multiple providers (Correios, ViaCEP, WideNet) concurrently and returns the fastest response. It works in both Node.js and the browser and exposes a simple Promise-based API.

## Use cases
- look up a Brazilian address from a CEP postal code
- validate and normalize user-entered CEP numbers in a form
- get city, state, street, and neighborhood from a zipcode
- handle CEPs stored as integers with missing leading zeros
- add resilient zipcode lookup with multiple provider fallbacks
- fetch address data in a Node.js backend or browser app

## When to choose
- you need Brazilian CEP lookup with high availability via multiple providers
- you want the fastest response by querying services concurrently
- you need a library that works in both Node.js and the browser
- your CEP data may be stored as integers without leading zeros

## When to avoid
- you need postal code lookup for countries other than Brazil
- you need offline zipcode data without calling external services
- you require guaranteed rate limits or SLAs from providers
- you need a non-Promise (callback or async-iterator) API

## Facets
- artifact type: library
- maturity: stable
- function: http-client, search-engine
- domain: web-development, apis, developer-tools
- platform: browser
- tags: cep, zipcode, brazil, correios, viacep, promise-based, fallback-providers, nodejs, javascript

## Member repositories
- BrasilAPI/cep-promise (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:32.629807+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T07:31:51.834943+00:00, confidence not recorded.
  - readme: https://github.com/BrasilAPI/cep-promise (fetched 2026-08-28T04:07:32.629807+00:00, sha f565ea128808)
  - registry_npm: https://registry.npmjs.org/cep-promise (fetched 2026-08-29T09:47:18.452694+00:00, sha c01fd165e7fc)
- Data as of 2026-08-30T08:39:29.467469+00:00.