Habitação.NET - API do Website (1.0.0)

Download OpenAPI specification:Download

Documentação da API do website Habitação.NET. Permite obter informação agregada sobre o preço da habitação em Portugal recolhida de anúncios preservados no Arquivo.pt.

Default

Preços de Venda de Imóveis

Lista o histórico de preços de venda para todos os distritos, municípios ou freguesias da região selecionada.

path Parameters
region
string

A região (portugal, concelho ou distrito)

id
string

O id da região no openstreetmap

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Preços de Arrendamento de Imóveis

Lista o histórico de preços de arrendamento para todos os distritos, municípios ou freguesias da região selecionada.

path Parameters
region
string

A região (portugal, concelho ou distrito)

id
string

O id da região no openstreetmap

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Áreas da Habitação na região

path Parameters
region
required
string

A região (portugal, concelho ou distrito)

id
required
string

o id da região no openstreetmap

Responses

Response samples

Content type
application/json
{
  • "areas": {
    }
}

Mapas

Obtem o mapa de Portugal, do distrito ou do municipio selecionado.

path Parameters
region
required
string

A região do mapa (portugal, concelho ou distrito)

id
string

o id da região no openstreetmap

Responses

Response samples

Content type
application/json
{
  • "map": {
    },
  • "projection": {
    }
}

Notícias

Lista as notícias preservadas para o período desejado

path Parameters
date
required
number

Período das notícias no formato YYYYMM (ano + mês)

query Parameters
page
number

Número da página de resultados

location
string

Filtrar resultados com base na região geográfica

Responses

Response samples

Content type
application/json
{
  • "hits": [
    ],
  • "out_of": 14910,
  • "page": 1
}