moz-flag

Documentação da API

Integre os dados de localização de Moçambique nas suas aplicações usando nossa API REST. Todos os endpoints retornam respostas JSON no seguinte formato:

{
  "message": "string",
  "data": T // onde T é o tipo de resposta
}
EndpointDescriçãoTipo de Resposta
GET
/v1/provinces
Obter todas as províncias
{
  code: string
  designation: string
}[]
GET
/v1/provinces/{provinceCode}
Obter detalhes de uma província específica
{
  code: string
  designation: string
  districtsAndMunicipalities: {
    code: string
    designation: string
    type: string
  }[]
}
GET
/v1/districts/{districtCode}
Obter detalhes de um distrito específico (tipo: CM_DISTRICT, que pode ser encontrado na API de detalhes da provincia)
{
  code: string
  designation: string
  administrativePosts: {
    code: string
    designation: string
  }[]
}
GET
/v1/municipalities/{municipalityCode}
Obter detalhes de um município específico (tipo: CM_MUNICIPALITY, que pode ser encontrado na API de detalhes da provincia)
{
  code: string
  designation: string
  townships: {
    code: string
    designation: string
  }[]
}
GET
/v1/localities?administrativePostOrTownshipCode=$code
Obter localidades por código de posto administrativo ou bairro
Parâmetros de consulta:
administrativePostOrTownshipCode: string, que pode ser encontrado nas APIs de muncipio ou distrito.
{
  code: string
  designation: string
}[]
GET
/v1/neighborhoods?localityCode=$code
Obter bairros por código de localidade
Parâmetros de consulta:
localityCode: string, que pode ser encontrado na API de localidades.
{
  code: string
  designation: string
}[]
GET
/v1/villages?neighborhoodCode=$code
Obter aldeias por código de bairro
Parâmetros de consulta:
neighborhoodCode: string, que pode ser encontrado na API de bairros.
{
  code: string
  designation: string
}[]

Exemplo de Uso

// Buscar todas as províncias
const response = await fetch('https://api.moz.melvinnunes.com/v1/provinces');
const { data: provinces } = await response.json();

// Obter detalhes de uma província específica
const provinceResponse = await fetch(`https://api.moz.melvinnunes.com/v1/provinces/${provinceCode}`);
const { data: province } = await provinceResponse.json();