### GET /regioes-imediatas/{regiao-imediata}

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves immediate regions by their identifiers.

```APIDOC
## GET /regioes-imediatas/{regiao-imediata}

### Description
Obtém o conjunto de regiões imediatas do Brasil a partir dos respectivos identificadores.

### Method
GET

### Endpoint
/regioes-imediatas/{regiao-imediata}

### Parameters
#### Path Parameters
- **regiao-imediata** (string) - Required - Um ou mais identificadores de regiões imediatas delimitados pelo caracter '|' (pipe).

#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, as regiões imediatas são ordenadas pela propriedade 'id'. Use 'nome' para ordenar alfabeticamente.
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta reflete a hierarquia. Use 'nivelado' para renderizar localidades no mesmo nível.

### Response
#### Success Response (200)
- Um objeto (caso apenas um identificador seja informado) ou um array de regiões imediatas.
  * Schema:
    [
      {
        "id": number,
        "nome": string,
        "regiao-intermediara": {
          "id": number,
          "nome": string,
          "UF": {}
        }
      }
    ]
```

--------------------------------

### Get All Districts

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves all districts in Brazil.

```APIDOC
## GET /api/v1/localidades/distritos

### Description
Obtém o conjunto de distritos do Brasil.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/distritos

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, os distritos são ordenados pelo nome do município ao qual pertencem. Se desejar ordenar alfabeticamente pelo nome do distrito, use o parâmetro **orderBy** com o valor **nome**. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?orderBy=nome
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta JSON é configurada para refletir a hierarquia à qual pertencem as localidades. A outra opção é configurar o parâmetro **view** com o valor **nivelado**. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?view=nivelado

### Response
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number)
  - **nome** (string)
  - **microrregiao** (object)
  - **regiao-imediata** (object)

### Response Example
[
  {
    "id": "number",
    "nome": "string",
    "municipio": {
      "id": "number",
      "nome": "string",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```

--------------------------------

### GET /api/v1/localidades/microrregioes/{microrregiao}/distritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of districts within specified Microregions.

```APIDOC
## GET /api/v1/localidades/microrregioes/{microrregiao}/distritos

### Description
Obtém o conjunto de distritos do Brasil a partir dos identificadores das microrregiões.

### Method
GET

### Endpoint
/api/v1/localidades/microrregioes/{microrregiao}/distritos

### Parameters
#### Path Parameters
- **microrregiao** (string) - Required - Um ou mais identificadores de microrregiões delimitados pelo caracter | (pipe). Exemplos: 16003 (Macapá/AP), 16003|43032 (Macapá/AP e Serras de Sudeste/RS).

#### Query Parameters
- **orderBy** (string) - Optional - Define a ordenação dos distritos. Padrão: nome do município. Use "nome" para ordenar alfabeticamente pelo nome do distrito.
- **view** (string) - Optional - Define o modo de visualização da resposta. Padrão: hierárquico. Use "nivelado" para renderizar as localidades no mesmo nível.

### Response
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number)
  - **nome** (string)
  - **microrregiao** (object)
  - **regiao-imediata** (object)

#### Response Example
[
  {
    "id": 1234,
    "nome": "Distrito Exemplo",
    "municipio": {
      "id": 5678,
      "nome": "Município Exemplo",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```

--------------------------------

### GET /api/v1/localidades/municipios/{municipio}/subdistritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of subdistricts within a specified municipality.

```APIDOC
## GET /api/v1/localidades/municipios/{municipio}/subdistritos

### Description
Obtém o conjunto de subdistritos do Brasil a partir dos identificadores dos municípios.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/municipios/{municipio}/subdistritos

### Parameters
#### Path Parameters
- **municipio** (string) - Required - Identificador do município.

### Response
#### Success Response (200)
- **id** (number) - Identificador do subdistrito
- **nome** (string) - Nome do subdistrito
- **distrito** (object) - Contém id e nome do distrito
- **municipio** (object) - Contém id e nome do município

#### Response Example
```json
[
  {
    "id": 1100001,
    "nome": "Aparecida",
    "distrito": {
      "id": 1100001,
      "nome": "Aparecida"
    },
    "municipio": {
      "id": 1100001,
      "nome": "Aparecida"
    }
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/mesorregioes/{mesorregiao}/distritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of districts within specified Mesoregions.

```APIDOC
## GET /api/v1/localidades/mesorregioes/{mesorregiao}/distritos

### Description
Obtém o conjunto de distritos do Brasil a partir dos identificadores das mesorregiões.

### Method
GET

### Endpoint
/api/v1/localidades/mesorregioes/{mesorregiao}/distritos

### Parameters
#### Path Parameters
- **mesorregiao** (string) - Required - Um ou mais identificadores de mesorregiões delimitados pelo caracter | (pipe). Exemplos: 1602 (Sul do Amapá/AP), 1602|4307 (Sul do Amapá/AP e Sudeste Rio-grandense/RS).

#### Query Parameters
- **orderBy** (string) - Optional - Define a ordenação dos distritos. Padrão: nome do município. Use "nome" para ordenar alfabeticamente pelo nome do distrito.
- **view** (string) - Optional - Define o modo de visualização da resposta. Padrão: hierárquico. Use "nivelado" para renderizar as localidades no mesmo nível.

### Response
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number)
  - **nome** (string)
  - **microrregiao** (object)
  - **regiao-imediata** (object)

#### Response Example
[
  {
    "id": 1234,
    "nome": "Distrito Exemplo",
    "municipio": {
      "id": 5678,
      "nome": "Município Exemplo",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```

--------------------------------

### GET /api/v1/localidades/municipios/{municipio}/distritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of districts for a given municipality or a list of municipalities.

```APIDOC
## GET /api/v1/localidades/municipios/{municipio}/distritos

### Description
Obtém o conjunto de distritos do Brasil a partir dos identificadores dos municípios.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/municipios/{municipio}/distritos

### Parameters
#### Path Parameters
- **municipio** (string) - Required - Um ou mais identificadores de municipios delimitados pelo caracter | (pipe). Exemplos: https://servicodados.ibge.gov.br/api/v1/localidades/municipios/3550308/distritos Obtém os dados referentes aos distritos do município de São Paulo/SP (3550308) https://servicodados.ibge.gov.br/api/v1/localidades/municipios/3550308|1501402/distritos Obtém os dados referentes aos distritos dos municípios de São Paulo/SP (3550308) e Belém/PA (1501402)

#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, os distritos são ordenados pelo nome do município ao qual pertencem. Se desejar ordenar alfabeticamente pelo nome do distrito, use o parâmetro orderBy com o valor nome. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?orderBy=nome Obtém os distritos ordenados alfabeticamente pelo nome.
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta JSON é configurada para refletir a hierarquia à qual pertencem as localidades. A outra opção é configurar o parâmetro view com o valor nivelado, que faz com que as localidades sejam renderizadas no mesmo nível. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?view=nivelado

### Responses
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number) - Identificador do município
  - **nome** (string) - Nome do município
  - **microrregiao** (object) - Informações da microrregião
  - **regiao-imediata** (object) - Informações da região imediata

#### Response Example
```json
[
  {
    "id": 1,
    "nome": "Distrito Exemplo",
    "municipio": {
      "id": 3550308,
      "nome": "São Paulo",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/microrregioes/{microrregiao}

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a specific microregion by its identifier.

```APIDOC
## GET /api/v1/localidades/microrregioes/{microrregiao}

### Description
Obtém o conjunto de microrregiões do Brasil a partir dos respectivos identificadores.

### Method
GET

### Endpoint
/api/v1/localidades/microrregioes/{microrregiao}

### Parameters
#### Path Parameters
- **microrregiao** (string) - Required - O identificador da microrregião a ser consultada.

### Response
#### Success Response (200)
- **id** (number) - Identificador da microrregião.
- **nome** (string) - Nome da microrregião.
- **mesorregiao** (object) - Informações sobre a mesorregião à qual a microrregião pertence.
  - **id** (number) - Identificador da mesorregião.
  - **nome** (string) - Nome da mesorregião.
  - **UF** (object) - Informações sobre a Unidade da Federação da mesorregião.

#### Response Example
```json
{
  "id": 3303,
  "nome": "Centro Fluminense/RJ",
  "mesorregiao": {
    "id": 33,
    "nome": "Centro Fluminense",
    "UF": {}
  }
}
```
```

--------------------------------

### GET /api/v1/localidades/municipios

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a comprehensive list of all municipalities in Brazil.

```APIDOC
## GET /api/v1/localidades/municipios

### Description
Obtém o conjunto de municípios do Brasil.

### Method
GET

### Endpoint
/api/v1/localidades/municipios

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Define a ordem dos municípios. Padrão: 'id'. Use 'nome' para ordenação alfabética.
- **view** (string) - Optional - Define o modo de visualização da resposta. Padrão: hierárquico. Use 'nivelado' para uma visualização em um único nível.

### Response
#### Success Response (200)
- **Array of municipalities** (object) - Contém os dados dos municípios, incluindo id, nome, microrregiao, regiao-imediata, e regiao-intermediara.

#### Response Example
```json
[
  {
    "id": number,
    "nome": string,
    "microrregiao": {
      "id": number,
      "nome": string,
      "mesorregiao": {}
    },
    "regiao-imediata": {
      "id": number,
      "nome": string,
      "regiao-intermediara": {}
    }
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/microrregioes

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of all microregions in Brazil.

```APIDOC
## GET /api/v1/localidades/microrregioes

### Description
Obtém o conjunto de microrregiões do Brasil.

### Method
GET

### Endpoint
/api/v1/localidades/microrregioes

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Define a ordem dos resultados. Pode ser 'id' (padrão) ou 'nome' para ordenação alfabética.
- **view** (string) - Optional - Define o modo de visualização. Pode ser 'hierarquico' (padrão) ou 'nivelado'.

### Response
#### Success Response (200)
- **id** (number) - Identificador da microrregião.
- **nome** (string) - Nome da microrregião.
- **mesorregiao** (object) - Informações sobre a mesorregião à qual a microrregião pertence.
  - **id** (number) - Identificador da mesorregião.
  - **nome** (string) - Nome da mesorregião.
  - **UF** (object) - Informações sobre a Unidade da Federação da mesorregião.

#### Response Example
```json
[
  {
    "id": 3303,
    "nome": "Centro Fluminense/RJ",
    "mesorregiao": {
      "id": 33,
      "nome": "Centro Fluminense",
      "UF": {}
    }
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/regioes-imediatas/{regiao-imediata}/distritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of districts for a given immediate region or a list of immediate regions.

```APIDOC
## GET /api/v1/localidades/regioes-imediatas/{regiao-imediata}/distritos

### Description
Obtém o conjunto de distritos do Brasil a partir dos identificadores das regiões imediatas.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/regioes-imediatas/{regiao-imediata}/distritos

### Parameters
#### Path Parameters
- **regiao-imediata** (string) - Required - Um ou mais identificadores de regiões imediatas delimitados pelo caracter | (pipe). Exemplos: https://servicodados.ibge.gov.br/api/v1/localidades/regioes-imediatas/310037/distritos Obtém os dados referentes aos distritos da região imediata Barbacena/MG (310037) https://servicodados.ibge.gov.br/api/v1/localidades/regioes-imediatas/330002|330005/distritos Obtém os dados referentes aos distritos das regiões imediatas Angra dos Reis/RJ (330002) e Resende/RJ (330005)

#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, os distritos são ordenados pelo nome do município ao qual pertencem. Se desejar ordenar alfabeticamente pelo nome do distrito, use o parâmetro orderBy com o valor nome. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?orderBy=nome Obtém os distritos ordenados alfabeticamente pelo nome.
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta JSON é configurada para refletir a hierarquia à qual pertencem as localidades. A outra opção é configurar o parâmetro view com o valor nivelado, que faz com que as localidades sejam renderizadas no mesmo nível. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?view=nivelado

### Responses
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number) - Identificador do município
  - **nome** (string) - Nome do município
  - **microrregiao** (object) - Informações da microrregião
  - **regiao-imediata** (object) - Informações da região imediata

#### Response Example
```json
[
  {
    "id": 1,
    "nome": "Distrito Exemplo",
    "municipio": {
      "id": 3550308,
      "nome": "São Paulo",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/regioes/{macrorregiao}/regioes-metropolitanas

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves metropolitan regions for specified macro-regions.

```APIDOC
## GET /api/v1/localidades/regioes/{macrorregiao}/regioes-metropolitanas

### Description
Obtém o conjunto de regiões metropolitanas do Brasil a partir dos identificadores das regiões (macrorregiões).

### Method
GET

### Endpoint
/api/v1/localidades/regioes/{macrorregiao}/regioes-metropolitanas

### Parameters
#### Path Parameters
- **macrorregiao** (string) - Required - Um ou mais identificadores de regiões delimitados pelo caractere '|' (pipe).

#### Query Parameters
- **orderBy** (string) - Optional - Define a ordem dos resultados. Padrão: 'id'. Use 'nome' para ordenar alfabeticamente pelo nome da região metropolitana.

### Response
#### Success Response (200)
- **id** (string) - Identificador da região metropolitana
- **nome** (string) - Nome da região metropolitana
- **UF** (object) - Informações da Unidade da Federação
  - **id** (number)
  - **nome** (string)
  - **sigla** (string)
  - **regiao** (object)
  - **sub-regioes-metropolitanas** (array) - Sub-regiões metropolitanas, se houver
  - **municipios** (array) - Array de municípios pertencentes à região metropolitana

### Response Example
```json
[
  {
    "id": "string",
    "nome": "string",
    "UF": {
      "id": 0,
      "nome": "string",
      "sigla": "string",
      "regiao": {},
      "sub-regioes-metropolitanas": [],
      "municipios": []
    }
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/estados/{UF}/distritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of districts within specified Federative Units (UF).

```APIDOC
## GET /api/v1/localidades/estados/{UF}/distritos

### Description
Obtém o conjunto de distritos do Brasil a partir dos identificadores das Unidades da Federação.

### Method
GET

### Endpoint
/api/v1/localidades/estados/{UF}/distritos

### Parameters
#### Path Parameters
- **UF** (string) - Required - Um ou mais identificadores de Unidades da Federação delimitados pelo caracter | (pipe). Exemplos: 33 (Rio de Janeiro), 33|35 (Rio de Janeiro e São Paulo).

#### Query Parameters
- **orderBy** (string) - Optional - Define a ordenação dos distritos. Padrão: nome do município. Use "nome" para ordenar alfabeticamente pelo nome do distrito.
- **view** (string) - Optional - Define o modo de visualização da resposta. Padrão: hierárquico. Use "nivelado" para renderizar as localidades no mesmo nível.

### Response
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number)
  - **nome** (string)
  - **microrregiao** (object)
  - **regiao-imediata** (object)

#### Response Example
[
  {
    "id": 1234,
    "nome": "Distrito Exemplo",
    "municipio": {
      "id": 5678,
      "nome": "Município Exemplo",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```

--------------------------------

### Get Districts by Identifier

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves specific districts using their identifiers.

```APIDOC
## GET /api/v1/localidades/distritos/{id}

### Description
Obtém o conjunto de distritos do Brasil a partir dos respectivos identificadores.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/distritos/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Um ou mais identificadores de distrito delimitados pelo caracter '|' (pipe). Exemplos: https://servicodados.ibge.gov.br/api/v1/localidades/distritos/160030312 Obtém os dados referentes ao distrito de Fazendinha/AP (**160030312**)

#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, os distritos são ordenados pelo nome do município ao qual pertencem. Se desejar ordenar alfabeticamente pelo nome do distrito, use o parâmetro **orderBy** com o valor **nome**. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?orderBy=nome
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta JSON é configurada para refletir a hierarquia à qual pertencem as localidades. A outra opção é configurar o parâmetro **view** com o valor **nivelado**. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?view=nivelado

### Response
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number)
  - **nome** (string)
  - **microrregiao** (object)
  - **regiao-imediata** (object)

### Response Example
[
  {
    "id": "number",
    "nome": "string",
    "municipio": {
      "id": "number",
      "nome": "string",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```

--------------------------------

### GET /api/v1/localidades/mesorregioes/{mesorregiao}

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves specific mesorregiões by their identifiers. Supports fetching multiple mesorregiões using a pipe-separated list.

```APIDOC
## GET /api/v1/localidades/mesorregioes/{mesorregiao}

### Description
Retrieves mesorregiões by their identifiers. You can specify one or more identifiers separated by a pipe (|).

### Method
GET

### Endpoint
/api/v1/localidades/mesorregioes/{mesorregiao}

### Path Parameters
- **mesorregiao** (string) - Required - One or more mesorregião identifiers separated by '|'.

### Query Parameters
- **orderBy** (string) - Optional - Sorts the mesorregiões alphabetically by name when set to 'nome'. Defaults to sorting by 'id'.
- **view** (string) - Optional - Sets the response format. 'nivelado' renders localities at the same level. Defaults to hierarchical structure.

### Response
#### Success Response (200)
- **id** (number) - Identifier of the mesorregião.
- **nome** (string) - Name of the mesorregião.
- **UF** (object) - Information about the state (Unidade da Federação).
  - **id** (number) - Identifier of the UF.
  - **nome** (string) - Name of the UF.
  - **sigla** (string) - Acronym of the UF.
  - **regiao** (object) - Information about the region.

### Response Example
```json
{
  "id": 3301,
  "nome": "Noroeste Fluminense",
  "UF": {
    "id": 33,
    "nome": "Rio de Janeiro",
    "sigla": "RJ",
    "regiao": {
      "id": 3,
      "nome": "Sudeste"
    }
  }
}
```
```

--------------------------------

### Get Municipalities by State

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves municipalities within specified states.

```APIDOC
## GET /api/v1/localidades/estados/{UF}/municipios

### Description
Retrieves the set of municipalities within specified states (Unidades da Federação).

### Method
GET

### Endpoint
/api/v1/localidades/estados/{UF}/municipios

### Parameters
#### Path Parameters
- **UF** (string) - Required - One or more state identifiers separated by the pipe character '|'.

#### Query Parameters
- **orderBy** (string) - Optional - Specifies the sorting order. Use 'nome' for alphabetical order by name, or omit for sorting by ID.
- **view** (string) - Optional - Specifies the response format. Use 'nivelado' for a flattened structure, or omit for hierarchical structure.

### Response
#### Success Response (200)
- Returns an array of municipalities.
  - **id** (number) - Municipality identifier.
  - **nome** (string) - Municipality name.
  - **microrregiao** (object) - Microregion details.
    - **id** (number) - Microregion identifier.
    - **nome** (string) - Microregion name.
    - **mesorregiao** (object) - Mesoregion details.
      - **id** (number) - Mesoregion identifier.
      - **nome** (string) - Mesoregion name.
  - **regiao-imediata** (object) - Immediate region details.
    - **id** (number) - Immediate region identifier.
    - **nome** (string) - Immediate region name.
    - **regiao-intermediara** (object) - Intermediate region details.
      - **id** (number) - Intermediate region identifier.
      - **nome** (string) - Intermediate region name.

### Request Example
```json
{
  "example": "GET /api/v1/localidades/estados/33/municipios"
}
```
### Response Example
```json
{
  "example": "[
    {
      "id": 3304557,
      "nome": "Rio de Janeiro",
      "microrregiao": {
        "id": 33007,
        "nome": "Nova Friburgo",
        "mesorregiao": {
          "id": 3303,
          "nome": "Metropolitana do Rio de Janeiro"
        }
      },
      "regiao-imediata": {
        "id": 330001,
        "nome": "Rio de Janeiro",
        "regiao-intermediara": {
          "id": 33,
          "nome": "Rio de Janeiro"
        }
      }
    }
  ]"
}
```
```

--------------------------------

### GET /api/v1/localidades/paises

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of countries. You can specify the language for the country names and the view mode.

```APIDOC
## GET /api/v1/localidades/paises

### Description
Obtém o conjunto de países.

### Method
GET

### Endpoint
`/api/v1/localidades/paises`

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Define a ordem dos resultados. Padrão: `id` (M49). Use `nome` para ordenar alfabeticamente.
- **view** (string) - Optional - Define o modo de visualização. Padrão: hierárquico. Use `nivelado` para renderizar as localidades no mesmo nível.
- **lang** (string) - Optional - Define o idioma dos nomes. Use `EN` para inglês ou `ES` para espanhol. Padrão: `PT` (Português).

### Response
#### Success Response (200)
Array de países.

#### Response Example
```json
[
  {
    "id": {
      "M49": number,
      "ISO-ALPHA-2": string,
      "ISO-ALPHA-3": string
    },
    "nome": string,
    "regiao-intermediaria": {
      "id": {},
      "nome": string
    },
    "sub-regiao": {
      "id": {},
      "nome": string
    },
    "regiao": {}
  }
]
```
```

--------------------------------

### GET /api/v1/localidades/regioes-intermediarias/{regiao-intermediaria}/distritos

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves a list of districts for a given intermediate region or a list of intermediate regions.

```APIDOC
## GET /api/v1/localidades/regioes-intermediarias/{regiao-intermediaria}/distritos

### Description
Obtém o conjunto de distritos do Brasil a partir dos identificadores das regiões intermediárias.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/regioes-intermediarias/{regiao-intermediaria}/distritos

### Parameters
#### Path Parameters
- **regiao-intermediaria** (string) - Required - Um ou mais identificadores de regiões intermediárias delimitados pelo caracter | (pipe).

#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, os distritos são ordenados pelo nome do município ao qual pertencem. Se desejar ordenar alfabeticamente pelo nome do distrito, use o parâmetro orderBy com o valor nome. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?orderBy=nome Obtém os distritos ordenados alfabeticamente pelo nome.
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta JSON é configurada para refletir a hierarquia à qual pertencem as localidades. A outra opção é configurar o parâmetro view com o valor nivelado, que faz com que as localidades sejam renderizadas no mesmo nível. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/distritos?view=nivelado

### Responses
#### Success Response (200)
- **id** (number) - Identificador do distrito
- **nome** (string) - Nome do distrito
- **municipio** (object) - Informações do município ao qual o distrito pertence
  - **id** (number) - Identificador do município
  - **nome** (string) - Nome do município
  - **microrregiao** (object) - Informações da microrregião
  - **regiao-imediata** (object) - Informações da região imediata

#### Response Example
```json
[
  {
    "id": 1,
    "nome": "Distrito Exemplo",
    "municipio": {
      "id": 3550308,
      "nome": "São Paulo",
      "microrregiao": {},
      "regiao-imediata": {}
    }
  }
]
```
```

--------------------------------

### GET /regioes-integradas-de-desenvolvimento

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves integrated development regions by their identifiers. Supports filtering by ID and ordering by name.

```APIDOC
## GET /regioes-integradas-de-desenvolvimento

### Description
Retrieves a list of integrated development regions based on their identifiers. You can specify one or more identifiers separated by a pipe (|).

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/regioes-integradas-de-desenvolvimento/{regiao-integrada-de-desenvolvimento}

### Parameters
#### Path Parameters
- **regiao-integrada-de-desenvolvimento** (string) - Required - One or more identifiers of integrated development regions delimited by the pipe character (|).

#### Query Parameters
- **orderBy** (string) - Optional - Orders the results. Use 'nome' to sort alphabetically by name. Defaults to sorting by 'id'.

### Response
#### Success Response (200)
- **id** (string) - Identifier of the integrated development region.
- **nome** (string) - Name of the integrated development region.
- **municipios** (array) - Array of municipalities belonging to the integrated development region.

### Response Example
```json
[
  {
    "id": "string",
    "nome": "string",
    "municipios": [
      {}
    ]
  }
]
```
```

--------------------------------

### GET /estados/{UF}/regioes-imediatas

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves immediate regions for specified Brazilian states (Unidades da Federação).

```APIDOC
## GET /estados/{UF}/regioes-imediatas

### Description
Obtém o conjunto de regiões imediatas do Brasil a partir dos identificadores das Unidades da Federação.

### Method
GET

### Endpoint
/estados/{UF}/regioes-imediatas

### Parameters
#### Path Parameters
- **UF** (string) - Required - Um ou mais identificadores de Unidades da Federação delimitados pelo caracter '|' (pipe).

#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, as regiões imediatas são ordenadas pela propriedade 'id'. Use 'nome' para ordenar alfabeticamente.
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta reflete a hierarquia. Use 'nivelado' para renderizar localidades no mesmo nível.

### Response
#### Success Response (200)
- Um array de regiões imediatas.
  * Schema:
    [
      {
        "id": number,
        "nome": string,
        "regiao-intermediara": {
          "id": number,
          "nome": string,
          "UF": {}
        }
      }
    ]
```

--------------------------------

### Get Districts by Mesoregion

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieve districts within specified mesorregiões. Multiple mesorregiões can be queried by separating their identifiers with a pipe (|).

```http
https://servicodados.ibge.gov.br/api/v1/localidades/mesorregioes/{mesorregiao}/distritos
```

```http
https://servicodados.ibge.gov.br/api/v1/localidades/mesorregioes/1602/distritos
```

```http
https://servicodados.ibge.gov.br/api/v1/localidades/mesorregioes/1602|4307/distritos
```

--------------------------------

### View Options for Immediate Regions

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Demonstrates how to change the view of the immediate regions data. The default view reflects the hierarchy, while `view=nivelado` renders localities on the same level.

```http
https://servicodados.ibge.gov.br/api/v1/localidades/regioes-imediatas?view=nivelado
```

--------------------------------

### Query Municipalities with Ordering and View Options

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Fetch municipalities with options to order results alphabetically by name or to change the view mode. The default order is by ID.

```HTTP
https://servicodados.ibge.gov.br/api/v1/localidades/municipios?orderBy=nome
```

```HTTP
https://servicodados.ibge.gov.br/api/v1/localidades/municipios?view=nivelado
```

--------------------------------

### GET /regioes-imediatas

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves all immediate regions in Brazil.

```APIDOC
## GET /regioes-imediatas

### Description
Obtém o conjunto de regiões imediatas do Brasil.

### Method
GET

### Endpoint
/regioes-imediatas

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Por padrão, as regiões imediatas são ordenadas pela propriedade 'id'. Use 'nome' para ordenar alfabeticamente.
- **view** (string) - Optional - Modo de visualização. Por padrão, a resposta reflete a hierarquia. Use 'nivelado' para renderizar localidades no mesmo nível.

### Response
#### Success Response (200)
- Um array de regiões imediatas.
  * Schema:
    [
      {
        "id": number,
        "nome": string,
        "regiao-intermediara": {
          "id": number,
          "nome": string,
          "UF": {}
        }
      }
    ]
```

--------------------------------

### Get All Urban Agglomerations

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves all urban agglomerations in Brazil.

```APIDOC
## GET /api/v1/localidades/aglomeracoes-urbanas

### Description
Obtém o conjunto de aglomerações urbanas do Brasil.

### Method
GET

### Endpoint
https://servicodados.ibge.gov.br/api/v1/localidades/aglomeracoes-urbanas

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Se desejar ordenar alfabeticamente pelo nome da aglomeração urbana, use o parâmetro **orderBy** com o valor **nome**. Exemplo: https://servicodados.ibge.gov.br/api/v1/localidades/aglomeracoes-urbanas?orderBy=nome
- **municipio** (string) - Optional - Se desejar saber à qual aglomeração urbana um determinado município pertence, informe o parâmetro municipio com o respectivo identificador. Exemplos: https://servicodados.ibge.gov.br/api/v1/localidades/aglomeracoes-urbanas?municipio=2611101

### Response
#### Success Response (200)
- **id** (string) - Identificador da aglomeração urbana
- **nome** (string) - Nome da aglomeração urbana
- **municipios** (array) - Array de municípios pertencentes à aglomeração urbana

### Response Example
[
  {
    "id": "string",
    "nome": "string",
    "municipios": [
      {}
    ]
  }
]
```

--------------------------------

### Order Municipalities by Name

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Fetch municipalities ordered alphabetically by their name. This uses the `orderBy` query parameter.

```http
https://servicodados.ibge.gov.br/api/v1/localidades/municipios?orderBy=nome
```

--------------------------------

### GET /api/v1/localidades/regioes-metropolitanas

Source: https://servicodados.ibge.gov.br/api/docs/localidades

Retrieves all metropolitan regions or filters by municipality.

```APIDOC
## GET /api/v1/localidades/regioes-metropolitanas

### Description
Obtém o conjunto de regiões metropolitanas do Brasil. Pode ser filtrado por município.

### Method
GET

### Endpoint
/api/v1/localidades/regioes-metropolitanas

### Parameters
#### Query Parameters
- **orderBy** (string) - Optional - Define a ordem dos resultados. Padrão: 'id'. Use 'nome' para ordenar alfabeticamente pelo nome da região metropolitana.
- **municipio** (string) - Optional - Identificador do município para filtrar a região metropolitana à qual pertence.

### Response
#### Success Response (200)
- **id** (string) - Identificador da região metropolitana
- **nome** (string) - Nome da região metropolitana
- **UF** (object) - Informações da Unidade da Federação
  - **id** (number)
  - **nome** (string)
  - **sigla** (string)
  - **regiao** (object)
  - **sub-regioes-metropolitanas** (array) - Sub-regiões metropolitanas, se houver
  - **municipios** (array) - Array de municípios pertencentes à região metropolitana

### Response Example
```json
[
  {
    "id": "string",
    "nome": "string",
    "UF": {
      "id": 0,
      "nome": "string",
      "sigla": "string",
      "regiao": {},
      "sub-regioes-metropolitanas": [],
      "municipios": []
    }
  }
]
```
```