ImobyFlowParcerias Imobiliárias
Browse the documentation
Português

Launches

The city's new-development catalog: development, unit types, price list and construction stage.

Routes

GET/v1/launches

The city's new developments

The new-development catalog, with unit types.

Permission: launches:read

Query parameters

limitinteger
Items per page: 1 to 50 (default 20).
cursorstring
The nextCursor from the previous page. The list is over when it comes back null. It is only valid for this route and this account.
citySlugstring
City identifier in the catalog.
neighborhoodstring
Neighborhood (name).
typestring
Subtype.one of APARTAMENTO CASA_RUA CASA_CONDOMINIO CASA_VILA STUDIO FLAT COBERTURA SALA_COMERCIAL LOJA_PONTO GALPAO PREDIO TERRENO_RUA TERRENO_CONDOMINIO CHACARA_SITIO FAZENDA
stagestring
Construction stage.one of LAUNCH OFF_PLAN NEW READY
priceMinnumber
Minimum price.
priceMaxnumber
Maximum price.
qstring
Search in the name.

Response200OK

datalist of Launchrequired
The developments.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

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

Errors for this route

And the errors common to every route

Objects

AddressArea

The address down to the neighborhood.

neighborhoodstringrequirednullable
Neighborhood name.
neighborhoodSlugstringrequirednullable
Catalog neighborhood.
citystringrequirednullable
City name.
cityIdstringrequirednullable
IBGE code.
citySlugstringrequirednullable
City identifier in the catalog.
statestringrequirednullable
State (UF).

Typology

A unit type of the development.

idstringrequired
Unit type id.
titlestringrequirednullable
Name.
typestringrequirednullable
Subtype.
statusstringrequired
Status.
salePricenumberrequirednullable
Price.
bedroomsintegerrequirednullable
Bedrooms.
suitesintegerrequirednullable
Suites.
bathroomsintegerrequirednullable
Bathrooms.
parkingSpotsintegerrequirednullable
Parking spots.
areanumberrequirednullable
Private area, in m².
privateAreanumberrequirednullable
Covered area, in m².
coverPhotostringrequirednullable
Cover photo.
floorPlanslist of stringrequired
Floor plans.
unitFeatureslist of stringrequired
Unit features.
unitsAvailableintegerrequirednullable
Available units.
unitsTotalintegerrequirednullable
Total units.

Launch

A development in the new-development catalog.

idstringrequired
Development id.
titlestringrequirednullable
Name.
developerstringrequirednullable
Developer.
addressAddressArearequired
Address down to the neighborhood (the street is not in the catalog).
constructionStagestringrequirednullable
Construction stage.one of LAUNCH OFF_PLAN NEW READY
deliveryDatestringrequirednullable
Expected delivery.
constructionProgressintegerrequirednullable
Construction progress, in %.
coverPhotostringrequirednullable
Cover photo.
amenitieslist of stringrequired
Development amenities.
commissionPercentnumberrequirednullable
Broker commission, in %.
priceMinnumberrequirednullable
Lowest unit-type price.
priceMaxnumberrequirednullable
Highest price.
typologyCountintegerrequired
How many unit types.
typologieslist of Typologyrequired
The unit types.