Skip to content
Get packs

BrasilAPI

A free public API that gathers Brazilian data (like postal codes) into one place.

GitHub Download source
Stars
11.4k
Forks
799
Licence
MIT
Language
JavaScript
Last update
4 days ago
Type
App

What it is

BrasilAPI is an open-source project that collects publicly available Brazilian information, such as postal codes (CEP), and serves it through simple web endpoints. The README says it exists because some public sources, like the Correios postal API, cannot be called directly from a browser, and it uses caching to make responses faster. It is described as an experimental, early-stage project in beta.

  • Look up a Brazilian postal code (CEP) from a web page or app
  • Query public Brazilian data through the documented OpenAPI endpoints at the project's docs site
  • Use a community client library in a language such as Python, Go, PHP or Java instead of calling the API directly

Great for

  • Developers building Brazilian websites or apps that need CEP or other public Brazilian data
  • Teams who want a single API instead of integrating several government or public sources
  • Contributors who want to help define new endpoints through the project's issues

Not ideal for

  • Anyone needing high-volume automated data extraction, since the README asks users not to crawl the API and says a bulk download option is planned later
  • Users needing guaranteed uptime or formal terms of service, because the README says the terms are still being written and the project is in beta
Step-by-step guide: how to use BrasilAPIInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    Use it in the browser (or self-host)

    Clone the repository

    git clone https://github.com/BrasilAPI/BrasilAPI.git
  2. 2

    Run it

    • Open https://brasilapi.com.br in a browser
    • Read the OpenAPI documentation at https://brasilapi.com.br/docs
    • Call an endpoint from your code, for example a CEP lookup
    • Check the community libraries list if your language has a client available
  3. 3

    Get the most out of it

    • Read the OpenAPI docs to see the full list of available endpoints and their parameters
    • Use a community client library for your language to avoid writing HTTP calls by hand
    • Keep request volume low and human-like, as the README requests
    • Follow the issues page to see which APIs are planned or being discussed

Downloads

Source code (.zip)main branch · straight from GitHubOfficial website & docsbrasilapi.com.br

Strengths

  • Addresses a real gap by making public Brazilian data reachable from browsers
  • Uses caching across multiple regions to reduce latency, according to the README
  • Provides OpenAPI documentation and a list of community client libraries

Trade-offs

  • The README describes the project as experimental and early-stage, so endpoints may change
  • Usage terms are still being drafted, and automated high-volume use is discouraged
  • The README does not describe installation for running your own copy, so self-hosting details are unclear

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.