Configuring Arbo as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Arbo option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need to provide your Arbo API authentication token to access your data. The following configuration is required:- Auth Token: The API key to authenticate against the Arbo API service. Contact Arbo support to obtain your API authentication token.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Below you’ll find all available data streams from Arbo and their corresponding fields:Imoveis
Imoveis
Stream for managing property listings, including all property details, location information, pricing, and features.Identifiers:
ref_id- Unique identifier for the property (primary key)codigo- Property codecodigo_origem- Original property code
ativo- Whether the property is activepublicado- Whether the property is publishedstatus_comercial- Commercial statusorigemcadastro- Registration origin
titulo- Property titledescricao- Property descriptioncategoria- Property categorycategoria_imovel- Property category typetipo_imovel- Property type (Residencial, Comercial, etc.)finalidade- Property purpose (Venda, Aluguel, Venda e Locação)mobiliado- Whether the property is furnishedpermuta- Whether exchange is acceptedfinanciamento- Whether financing is available
qtd_quartos- Number of bedroomsqtd_suites- Number of suitesqtd_vagas- Number of parking spacesqtd_banheiro- Number of bathroomsarea_total- Total areaarea_privativa- Private area
end_condominio- Condominium nameend_bairro- Neighborhoodend_cidade- Cityend_estado- Stateend_logradouro- Street addressend_complemento- Address complementend_numero- Address numberend_cep- ZIP codelatitude- Latitude coordinatelongitude- Longitude coordinate
valor_venda- Sale pricevalor_aluguel- Rental pricevalor_condominio- Condominium feevalor_iptu- IPTU tax value
fotos- Array of property photos, each containing:url- Photo URLordem- Display orderprincipal- Whether it’s the main photomarcadagua_url- Watermark URLsizes- Object withmediumandsmallimage URLs
url_video- Video URLurl_tour- Virtual tour URL
condominio- Condominium ID (foreign key to condominios)prop_id- Property ID (used for child stream proprietarios)corretor- Broker information object:codigo- Broker codenome- Broker name
imobiliaria- Real estate agency information object:nome- Agency nameinfos- Array of info objects withurlandtipotelefones- Array of phone numbers
caracteristicas- Array of property features/amenitiesemp_fields- Enterprise fields object with pricing and area filters:emp_preco_min- Minimum priceemp_preco_max- Maximum priceemp_preco_min_loc- Minimum rental priceemp_preco_max_loc- Maximum rental priceemp_areautil_min- Minimum usable areaemp_areautil_max- Maximum usable areaemp_areaprivativa_min- Minimum private areaemp_areaprivativa_max- Maximum private areaemp_areatotal_min- Minimum total areaemp_areatotal_max- Maximum total areaemp_dorm_min- Minimum bedroomsemp_dorm_max- Maximum bedroomsemp_porcentagem_total- Total percentage
created_at- Creation timestampupdated_at- Last update timestamp
Condominios
Condominios
Stream for managing condominium information, including location, characteristics, and photos.Identifiers:
id- Unique identifier for the condominium (primary key)cond_cod- Condominium codecond_cod_origem- Original condominium code
cond_nome- Condominium namecond_tipo- Condominium typecond_ano- Construction year (can be string or number)cond_construt- Builder/Constructorcond_desc- Descriptioncond_coment- Commentscondominio_ativo- Whether the condominium is active
cond_logradouro- Street addresscond_numero- Address numbercond_bairro- Neighborhoodcond_ptref- Reference pointcond_city- Citycond_est- Statecond_cep- ZIP codecond_latitude- Latitude coordinatecond_longitude- Longitude coordinatecond_raiomapa- Map radius
fotos- Array of condominium photos, each containing:url- Photo URLordem- Display orderprincipal- Whether it’s the main photomarcadagua_url- Watermark URLsizes- Object withmediumandsmallimage URLs
caracteristicas- Array of condominium features/amenitiesimobiliaria- Real estate agency information (can be ID number or full object)
createdat- Creation timestampupdatedat- Last update timestamp
Proprietarios
Proprietarios
Stream for managing property owners. This is a child stream of Imoveis, meaning it requires a parent property record to fetch owner information.Identifiers:
id- Unique identifier for the owner (primary key)usu_id- User ID (property ID, references prop_id from imoveis)imb_id- Real estate agency ID
nome- Owner nameemail- Owner emailrg- RG (Brazilian ID)cpf- CPF (Brazilian tax ID)
telefones- Array of phone number objects, each containing:id- Phone number IDnumero- Phone numbercontato- Contact name/description
createdat- Creation timestampupdatedat- Last update timestamp
Cidades
Cidades
Stream for retrieving cities with available properties.Identifiers:
end_cidade- City name (primary key)
count- Number of properties in this city
Bairros
Bairros
Stream for retrieving neighborhoods with available properties.Identifiers:
end_bairro- Neighborhood name (part of composite primary key)end_cidade- City name (part of composite primary key)
count- Number of properties in this neighborhood
Tipos Imovel
Tipos Imovel
Stream for retrieving property type categories.Identifiers:
id- Property type ID (primary key)
categoria- Property type category
Data Model
The following diagram illustrates the relationships between the data streams in Arbo. The arrows indicate the join keys that link the different entities, providing a clear overview of the data structure.Use Cases for Data Analysis
This guide outlines valuable business intelligence use cases when consolidating Arbo data, along with ready-to-use SQL queries that you can run on Explorer.1. Property Portfolio Overview
Get a comprehensive view of your property portfolio with key metrics including property counts, pricing distribution, and availability by location. Business Value:- Identify property distribution across cities and neighborhoods
- Analyze pricing trends and availability
- Track active vs. published properties
- Understand property type distribution
SQL query
SQL query
- AWS
- GCP
Sample Result
Sample Result
| city | neighborhood | category | property_type | purpose | property_count | condominium_count | avg_sale_price | avg_rental_price | active_count | published_count | avg_total_area | avg_bedrooms |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Pelotas | Centro | Studio | Residencial | Venda | 45 | 12 | 245000.00 | NULL | 45 | 42 | 35.5 | 1.0 |
| Pelotas | Três Vendas | Apartamento | Residencial | Venda e Locação | 38 | 8 | 385000.00 | 2800.00 | 38 | 35 | 72.3 | 2.5 |
| Pelotas | Laranjal | Terreno | Residencial | Venda | 22 | 3 | 150000.00 | NULL | 22 | 20 | 250.0 | NULL |
2. Property-Owner Relationships
Analyze the relationship between properties and their owners to understand portfolio distribution and owner information. Business Value:- Identify owners with multiple properties
- Analyze owner contact information completeness
- Track property-owner associations
- Understand property distribution per owner
SQL query
SQL query
- AWS
- GCP
Sample Result
Sample Result
| owner_name | owner_email | owner_cpf | property_count | property_categories | cities | avg_property_value | total_phone_numbers |
|---|---|---|---|---|---|---|---|
| João Silva | [email protected] | 123.456.789-00 | 5 | Studio, Apartamento | Pelotas | 285000.00 | 2 |
| Maria Santos | [email protected] | 987.654.321-00 | 3 | Terreno, Casa | Pelotas, Rio Grande | 320000.00 | 1 |
3. Condominium Analysis
Analyze condominium data to understand property distribution, features, and location patterns. Business Value:- Understand property concentration in condominiums
- Analyze condominium characteristics and features
- Track condominium locations and distribution
- Compare property values within condominiums
SQL query
SQL query
- AWS
- GCP
Implementation Notes
Data Quality Considerations
- The
proprietariosstream is a child stream ofimoveisand requires a parent property record with a validprop_id - Property prices (
valor_venda,valor_aluguel) may be NULL for properties not available for sale/rent - Some fields like
cond_ano(construction year) may be returned as strings or numbers depending on the API response - The
imobiliariafield in condominios can be either an ID number or a full object, and is converted to a string format for consistency
API Limits & Performance
- The API uses pagination with a page size of 100 records
- For faster extractions, select only the streams necessary for your analysis
- The
proprietariosstream will only sync for properties that have a validprop_idvalue