PHPackages                             nibblelab/ibgeapiclient-php - 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. nibblelab/ibgeapiclient-php

ActiveLibrary

nibblelab/ibgeapiclient-php
===========================

client for IBGE's REST API

1.0-stable(6y ago)0521Apache-2.0PHPPHP ^7.1.0

Since Sep 5Pushed 6y ago1 watchersCompare

[ Source](https://github.com/nibblelab/ibgeapiclient-php)[ Packagist](https://packagist.org/packages/nibblelab/ibgeapiclient-php)[ RSS](/packages/nibblelab-ibgeapiclient-php/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (2)Versions (2)Used By (0)

Biblioteca de integração com a API de localidades do IBGE
=========================================================

[](#biblioteca-de-integração-com-a-api-de-localidades-do-ibge)

A especificação da API pode ser encontrada em

Sumário
=======

[](#sumário)

1. [Pré requisitos](#pr%C3%A9-requisitos)
2. [Inicialização](#inicializa%C3%A7%C3%A3o)
3. [Regiões](#regi%C3%B5es)
4. [UFs](#ufs)
5. [Mesorregiões](#mesorregi%C3%B5es)
6. [Microrregiões](#microrregi%C3%B5es)
7. [Municípios](#munic%C3%ADpios)

Pré requisitos
--------------

[](#pré-requisitos)

- PHP >= 7.1.0
- libcurl
- composer

Instalação
----------

[](#instalação)

Instale pelo composer

```
$ composer require nibblelab/ibgeapiclient-php

```

Inicialização
-------------

[](#inicialização)

Inclua o composer e o namespace.

```
include './vendor/autoload.php';

use \IBGEApiClient\IBGEApiClient;

```

Regiões
-------

[](#regiões)

### Todas as regiões

[](#todas-as-regiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarRegioes();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Região por ID

[](#região-por-id)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarRegiaoById('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Regiões por IDs

[](#regiões-por-ids)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarRegioesByIds(array('1','3'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

UFs
---

[](#ufs)

### Todas as UF's

[](#todas-as-ufs)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFs();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### UF por ID

[](#uf-por-id)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFById('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### UFs por IDs

[](#ufs-por-ids)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFsByIds(array('31','32'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### UF por região

[](#uf-por-região)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFsByRegiao('3');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### UF por regiões

[](#uf-por-regiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarUFsByRegioes(array('2','3'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

Mesorregiões
------------

[](#mesorregiões)

### Todas as Mesorregiões

[](#todas-as-mesorregiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioes();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Mesorregião por ID

[](#mesorregião-por-id)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegiaoById('1101');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Mesorregiões por IDs

[](#mesorregiões-por-ids)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByIds(array('1101','1102'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Mesorregiões por Região

[](#mesorregiões-por-região)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByRegiao('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Mesorregiões por Regiões

[](#mesorregiões-por-regiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByRegioes(array('1','2'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Mesorregiões por UF

[](#mesorregiões-por-uf)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByUF('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Mesorregiões por UFs

[](#mesorregiões-por-ufs)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMesoRegioesByUFs(array('31','27'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

Microrregiões
-------------

[](#microrregiões)

### Todas as Microrregiões

[](#todas-as-microrregiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioes();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregião por ID

[](#microrregião-por-id)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegiaoById('11001');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por IDs

[](#microrregiões-por-ids)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByIds(array('11001','11002'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por Região

[](#microrregiões-por-região)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByRegiao('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por Regiões

[](#microrregiões-por-regiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByRegioes(array('1','2'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por UF

[](#microrregiões-por-uf)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByUF('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por UFs

[](#microrregiões-por-ufs)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByUFs(array('31','27'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por Mesorregião

[](#microrregiões-por-mesorregião)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByMesoRegiao('1102');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Microrregiões por Mesorregiões

[](#microrregiões-por-mesorregiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMicroRegioesByMesoRegioes(array('1101','1102'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

Municípios
----------

[](#municípios)

### Todos os Municípios

[](#todos-os-municípios)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipios();
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Município por ID

[](#município-por-id)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipioById('3170206');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por IDs

[](#municípios-por-ids)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByIds(array('3170206','5108352'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por Região

[](#municípios-por-região)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByRegiao('1');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por Regiões

[](#municípios-por-regiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByRegioes(array('1','2'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por UF

[](#municípios-por-uf)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByUF('31');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por UFs

[](#municípios-por-ufs)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByUFs(array('31','27'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por Mesorregião

[](#municípios-por-mesorregião)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMesoRegiao('1102');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por Mesorregiões

[](#municípios-por-mesorregiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMesoRegioes(array('1101','1102'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por Microrregião

[](#municípios-por-microrregião)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMicroRegiao('11001');
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

### Municípios por Microrregiões

[](#municípios-por-microrregiões)

```
try
{
    $api = new IBGEApiClient();
    $response = $api->buscarMunicipiosByMicroRegioes(array('11001','11002'));
    foreach($response->getData() as $r) {
        echo ' nome = ' . $r->getNome() . "\n"; # printe o nome
    }
} catch (Exception $ex) {
    echo $ex->getMessage();
}

```

License
-------

[](#license)

Este projeto está licenciado com Apache - veja [LICENSE.md](LICENSE.md) pra mais detalhes

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 60% 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

2439d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/25c773b69e87f46701698d0e0296eb556a67173025d60abcd1087e2b0ba436df?d=identicon)[nibblelab](/maintainers/nibblelab)

---

Top Contributors

[![nibblelab](https://avatars.githubusercontent.com/u/6741887?v=4)](https://github.com/nibblelab "nibblelab (3 commits)")[![matheus-souza](https://avatars.githubusercontent.com/u/14989876?v=4)](https://github.com/matheus-souza "matheus-souza (2 commits)")

### Embed Badge

![Health badge](/badges/nibblelab-ibgeapiclient-php/health.svg)

```
[![Health](https://phpackages.com/badges/nibblelab-ibgeapiclient-php/health.svg)](https://phpackages.com/packages/nibblelab-ibgeapiclient-php)
```

###  Alternatives

[edamov/pushok

PHP client for Apple Push Notification Service (APNs) - Send push notifications to iOS using the new APNs HTTP/2 protocol with token-based (JWT with p8 private key) or certificate-based authentication

4093.0M16](/packages/edamov-pushok)[tinify/tinify

PHP client for the Tinify API. Tinify compresses your images intelligently. Read more at https://tinify.com.

2515.2M72](/packages/tinify-tinify)[educoder/pest

A proper REST client for PHP.

358689.2k15](/packages/educoder-pest)[corsinvest/cv4pve-api-php

Corsinvest Proxmox VE Client API PHP

801.4M](/packages/corsinvest-cv4pve-api-php)[pagseguro/pagseguro-php-sdk

Biblioteca de integração com o PagSeguro

312456.6k14](/packages/pagseguro-pagseguro-php-sdk)[chuyskywalker/rolling-curl

Rolling-Curl: A non-blocking, non-dos multi-curl library for PHP

207446.6k6](/packages/chuyskywalker-rolling-curl)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)