API DE CÓDIGOS POSTAIS · V2

Consultar código postal

Retorna um array com informação associada ao código postal indicado.

GET/ptcp/v2/{AppID}/{CodigoPostal}

Parâmetros

AppIDstring · obrigatório

Identificador de acesso atribuído ao utilizador.

CodigoPostalstring · obrigatório

Código postal a consultar, sem hífen, com 7 dígitos. Exemplo: 2590432.

Exemplo de pedido

GET https://api.ptapi.net/ptcp/v2/SEU_APPID/2590432

Exemplo de resposta

[
  {
    "ID": 1,
    "CodigoPostal": "2590-432",
    "Morada": "Quinta da Bica",
    "NumeroPorta": "",
    "Localidade": "Sapataria, Sobral de Monte Agraço, LisboaSizandros",
    "Freguesia": "Sapataria ",
    "Concelho": "Sobral de Monte Agraço",
    "CodigoDistrito": 11,
    "Distrito": "Lisboa",
    "Latitude": "38.997235",
    "Longitude": "-9.161673"
  },
  {
    "ID": 2,
    "CodigoPostal": "2590-432",
    "Morada": "Rua Santa Maria dos Sizandros",
    "NumeroPorta": "",
    "Localidade": "Sapataria, Sobral de Monte Agraço, LisboaSizandros",
    "Freguesia": "Sapataria ",
    "Concelho": "Sobral de Monte Agraço",
    "CodigoDistrito": 11,
    "Distrito": "Lisboa",
    "Latitude": "38.964303",
    "Longitude": "-9.192121"
  }
]

Campos devolvidos

IDIdentificador do registo.

CodigoPostalCódigo postal formatado.

MoradaDesignação da morada.

NumeroPortaNúmero de porta, quando disponível.

LocalidadeLocalidade associada.

FreguesiaFreguesia associada.

ConcelhoConcelho associado.

CodigoDistritoCódigo numérico do distrito.

DistritoNome do distrito.

LatitudeLatitude disponível para o registo.

LongitudeLongitude disponível para o registo.

Nota sobre compatibilidade

A v2 mantém os nomes de campos existentes para preservar compatibilidade com integrações atuais. Uma futura versão poderá adotar um contrato diferente sem alterar esta versão.