GEOPT API REST · JSON

Um código postal.
As moradas que procura.

Consulte moradas em Portugal a partir de um código postal. Integre a pesquisa nos seus formulários, na sua loja ou na sua aplicação.

Pesquisar um código postal Ver documentação

Experimente a pesquisa no site ou crie uma conta para integrar a API.

POST /api/v1/search

Envie o código postal

X-API-Key: YOUR_API_KEY
Content-Type: application/json

{
    "pc4": "2530",
    "pc3": "073"
}
Exemplo de morada devolvida

Beco da Palmeira

2530-073 · Lourinhã

GPS: 39.202397,-9.329441
Ver exemplo da resposta JSON 
{
    "code": 200,
    "status": "OK",
    "message": "Data retrieved successfully",
    "data": {
        "pc": "2530-073",
        "locality": "Lourinhã",
        "city": "Lisboa",
        "district": "Lisboa",
        "extra": "Lourinhã, Lisboa",
        "addresses": [
            {
                "street": "Beco da Palmeira",
                "gps": "39.202397,-9.329441"
            }
        ]
    }
}

Exemplo ilustrativo. Os resultados variam com o código postal e a informação disponível.

Da pesquisa à sua aplicação

Menos campos para preencher. Mais contexto para escolher.

Use as moradas encontradas para ajudar os seus utilizadores a selecionar a informação certa.

01 / Formulários

Facilite o preenchimento

Apresente sugestões de morada a partir do código postal e permita ao utilizador confirmar os dados.

02 / Comércio online

Simplifique a entrega

Ajude os clientes a escolher a rua e a localidade ao preencher a morada de entrega.

03 / Integrações

Trabalhe com JSON

Consulte o código postal por HTTP e utilize as moradas e as coordenadas disponíveis nos seus sistemas.

Começar é simples

Do primeiro teste à integração

  1. Experimente

    Pesquise um código postal no site para conhecer os dados devolvidos.

    Abrir a pesquisa

  2. Obtenha a sua chave

    Crie uma conta e conclua o registo. A chave inicial da API é válida durante 15 dias.

    Criar conta

  3. Integre

    Siga os exemplos de autenticação, pedidos e tratamento de erros na documentação.

    Consultar os exemplos

Pronto para fazer o primeiro pedido?

Crie a sua conta e comece a testar a API com os seus códigos postais.

Começar a integrar