PHPackages paulofelipem/brazilian-regions - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. paulofelipem/brazilian-regions ActiveLibrary[Utility & Helpers](/categories/utility) paulofelipem/brazilian-regions ============================== Pacote com informações de todos os paises, estados e cidades (Estados e cidades brasileiras). v1.0.20(3y ago)2470MITPHPPHP >=8.1 Since Nov 21Pushed 4mo ago1 watchersCompare [ Source](https://github.com/PauloFelipeM/brazilian-regions)[ Packagist](https://packagist.org/packages/paulofelipem/brazilian-regions)[ Docs](https://github.com/PauloFelipeM/brazilian-regions)[ RSS](/packages/paulofelipem-brazilian-regions/feed)WikiDiscussions master Synced today READMEChangelogDependencies (2)Versions (3)Used By (0) Brazilian Regions for Laravel ============================= [](#brazilian-regions-for-laravel) [![Latest Version on Packagist](https://camo.githubusercontent.com/d10757978e07241994254f6d32ff7623b4e5891ed1bac801d204e4bdc8faad9a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7061636b61676973742d312e302e32302d626c7565)](https://packagist.org/packages/paulofelipem/brazilian-regions)[![Total Downloads](https://camo.githubusercontent.com/1178c64a1dc1397fce31f1049b3b31a37dbc0d2941b1d0d2cb380494077d3841/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f5061756c6f46656c6970654d2f6272617a696c69616e2d726567696f6e73)](https://packagist.org/packages/paulofelipem/brazilian-regions)[![License: MIT](https://camo.githubusercontent.com/784362b26e4b3546254f1893e778ba64616e362bd6ac791991d2c9e880a3a64e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e2e737667)](LICENSE.md) A Laravel package that provides migrations, seeders, and Eloquent models for **countries**, **states**, and **cities** — with full data for all Brazilian states and municipalities. Data sourced from the [IBGE Localities API](https://servicodados.ibge.gov.br/api/docs/localidades). Features -------- [](#features) - All world countries with M49 codes and region classification - All 27 Brazilian states with regional data - All Brazilian municipalities (5,000+) - Ready-to-use Eloquent models with relationships - Fully configurable table names, column names, and models - Auto-discovery support for Laravel 9+ Requirements ------------ [](#requirements) - PHP 8.1+ - Laravel 9.0+ Installation ------------ [](#installation) Install the package via Composer: ``` composer require paulofelipem/brazilian-regions ``` The service provider is registered automatically. If needed, you can register it manually in `config/app.php`: ``` 'providers' => [ // ... PauloFelipeM\BrazilianRegions\BrazilianRegionsServiceProvider::class, ], ``` Publish the configuration and migration files: ``` php artisan vendor:publish --provider="PauloFelipeM\BrazilianRegions\BrazilianRegionsServiceProvider" ``` > **Note:** This publishes a `config/brazilianregions.php` file. If you already have a file with that name, rename or remove it before publishing. Usage ----- [](#usage) Run the migrations and seeders to create and populate the tables: ``` php artisan migrate php artisan db:seed --class="PauloFelipeM\\BrazilianRegions\\Database\\Seeds\\DatabaseSeeder" ``` Then use the provided Eloquent models in your application: ``` use PauloFelipeM\BrazilianRegions\Models\Country; use PauloFelipeM\BrazilianRegions\Models\State; use PauloFelipeM\BrazilianRegions\Models\City; // Get all Brazilian states $brazil = Country::where('acronym', 'BRA')->first(); $states = $brazil->states; // Get all cities in a state $state = State::where('acronym', 'SP')->first(); $cities = $state->cities; // Navigate from city to country $city = City::where('name', 'São Paulo')->first(); $state = $city->state; $country = $city->state->country; ``` Database Schema --------------- [](#database-schema) ### `countries` [](#countries) ColumnDescription`id`Auto-increment primary key`m_49`UN M49 numeric code`acronym`ISO Alpha-3 country code`name`Country name`region`Geographic region### `states` [](#states) ColumnDescription`id`Auto-increment primary key`acronym`State abbreviation (e.g. SP, RJ)`name`State name`region`Region name (e.g. Sudeste)`region_acronym`Region abbreviation`country_id`Foreign key to `countries`### `cities` [](#cities) ColumnDescription`id`Auto-increment primary key`name`City name`state_id`Foreign key to `states`All foreign keys use `CASCADE` on delete. Configuration ------------- [](#configuration) The published `config/brazilianregions.php` file allows you to customize: ``` return [ // Override the default Eloquent models 'models' => [ 'country' => PauloFelipeM\BrazilianRegions\Models\Country::class, 'state' => PauloFelipeM\BrazilianRegions\Models\State::class, 'city' => PauloFelipeM\BrazilianRegions\Models\City::class, ], // Customize table names 'tables' => [ 'countries' => 'countries', 'states' => 'states', 'cities' => 'cities', ], // Customize foreign key column names 'columns' => [ 'country_id' => 'country_id', 'state_id' => 'state_id', 'city_id' => 'city_id', ], ]; ``` This is useful when you need to integrate with an existing database schema or extend the default models. Changelog --------- [](#changelog) See [CHANGELOG](CHANGELOG.md) for release history. Bugs ---- [](#bugs) If you find any issues, please [open an issue on GitHub](https://github.com/PauloFelipeM/brazilian-regions/issues). Credits ------- [](#credits) - [Paulo Felipe Martins](https://github.com/PauloFelipeM) License ------- [](#license) The MIT License (MIT). See [LICENSE](LICENSE.md) for more information. ### Health Score 36 — LowBetter than 79% of packages Maintenance52 Moderate activity, may be stable Popularity15 Limited adoption so far Community9 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 92.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 1321d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/13707387?v=4)[Paulo Felipe Martins](/maintainers/PauloFelipeM)[@PauloFelipeM](https://github.com/PauloFelipeM) --- Top Contributors [![PauloFelipeM](https://avatars.githubusercontent.com/u/13707387?v=4)](https://github.com/PauloFelipeM "PauloFelipeM (12 commits)")[![paulfmartins-stl](https://avatars.githubusercontent.com/u/266836112?v=4)](https://github.com/paulfmartins-stl "paulfmartins-stl (1 commits)") --- Tags cidadesestadosPauloFelipeMlaravel-brazilian-regionslaravel-migrations-seeders-paises-estados-cidades-BRlaravel-migrations-seeders-paises-estados-cidades-brasilbrazilian regionsregiões do brasilregiõespaisesseeder paises. Estados e cidades brasileiras ### Embed Badge ![Health badge](/badges/paulofelipem-brazilian-regions/health.svg) ``` [![Health](https://phpackages.com/badges/paulofelipem-brazilian-regions/health.svg)](https://phpackages.com/packages/paulofelipem-brazilian-regions) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3355.3M346](/packages/psalm-plugin-laravel)[api-platform/laravel API Platform support for Laravel 58171.6k14](/packages/api-platform-laravel)[wearepixel/laravel-cart A cart implementation for Laravel 1374.8k](/packages/wearepixel-laravel-cart)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)