ImobyFlowParcerias Imobiliárias
Navegar na documentação
English

Lançamentos

O catálogo de lançamentos da cidade: empreendimento, tipologias, tabela e estágio da obra.

As rotas

GET/v1/launches

Lançamentos da cidade

O catálogo de lançamentos, com as tipologias.

Permissão: launches:read

Filtros e paginação

limitinteger
Itens por página: de 1 a 50 (padrão 20).
cursorstring
O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.
citySlugstring
Identificador da cidade no catálogo.
neighborhoodstring
Bairro (nome).
typestring
Subtipo.um de APARTAMENTO CASA_RUA CASA_CONDOMINIO CASA_VILA STUDIO FLAT COBERTURA SALA_COMERCIAL LOJA_PONTO GALPAO PREDIO TERRENO_RUA TERRENO_CONDOMINIO CHACARA_SITIO FAZENDA
stagestring
Estágio da obra.um de LAUNCH OFF_PLAN NEW READY
priceMinnumber
Preço mínimo.
priceMaxnumber
Preço máximo.
qstring
Busca no nome.

Resposta200OK

datalista de Launchobrigatório
Os empreendimentos.
nextCursorstringobrigatóriopode vir nulo
Cursor da próxima página (nulo = acabou).

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/launches' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

Os objetos

AddressArea

O endereço até o bairro.

neighborhoodstringobrigatóriopode vir nulo
Nome do bairro.
neighborhoodSlugstringobrigatóriopode vir nulo
Bairro do catálogo.
citystringobrigatóriopode vir nulo
Nome da cidade.
cityIdstringobrigatóriopode vir nulo
Código do IBGE.
citySlugstringobrigatóriopode vir nulo
Identificador da cidade no catálogo.
statestringobrigatóriopode vir nulo
Estado (UF).

Typology

Uma tipologia do empreendimento.

idstringobrigatório
Id da tipologia.
titlestringobrigatóriopode vir nulo
Nome.
typestringobrigatóriopode vir nulo
Subtipo.
statusstringobrigatório
Situação.
salePricenumberobrigatóriopode vir nulo
Preço.
bedroomsintegerobrigatóriopode vir nulo
Quartos.
suitesintegerobrigatóriopode vir nulo
Suítes.
bathroomsintegerobrigatóriopode vir nulo
Banheiros.
parkingSpotsintegerobrigatóriopode vir nulo
Vagas.
areanumberobrigatóriopode vir nulo
Área privativa, em m².
privateAreanumberobrigatóriopode vir nulo
Área coberta, em m².
coverPhotostringobrigatóriopode vir nulo
Capa.
floorPlanslista de stringobrigatório
Plantas.
unitFeatureslista de stringobrigatório
Itens da unidade.
unitsAvailableintegerobrigatóriopode vir nulo
Unidades disponíveis.
unitsTotalintegerobrigatóriopode vir nulo
Unidades no total.

Launch

Um empreendimento do catálogo de lançamentos.

idstringobrigatório
Id do empreendimento.
titlestringobrigatóriopode vir nulo
Nome.
developerstringobrigatóriopode vir nulo
Construtora.
addressAddressAreaobrigatório
Endereço até o bairro (a rua não sai no catálogo).
constructionStagestringobrigatóriopode vir nulo
Estágio da obra.um de LAUNCH OFF_PLAN NEW READY
deliveryDatestringobrigatóriopode vir nulo
Previsão de entrega.
constructionProgressintegerobrigatóriopode vir nulo
Andamento da obra, em %.
coverPhotostringobrigatóriopode vir nulo
Capa.
amenitieslista de stringobrigatório
Itens do empreendimento.
commissionPercentnumberobrigatóriopode vir nulo
Comissão para o corretor, em %.
priceMinnumberobrigatóriopode vir nulo
Menor preço entre as tipologias.
priceMaxnumberobrigatóriopode vir nulo
Maior preço.
typologyCountintegerobrigatório
Quantas tipologias.
typologieslista de Typologyobrigatório
As tipologias.