Documentation Index
Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt
Use this file to discover all available pages before exploring further.
Retrieve scraped data from your Bien’Ici Search Export runs.
Your API authentication token. Value: Token YOUR_API_KEY
Query Parameters
Hash of the squid to get results from
Hash of a specific run (optional)
Page number (default: 1). Example: 1
Result Fields
Each result object contains the following fields:
Direct URL to the listing on Bienici. Example: https://www.bienici.com/annonce/vente/antibes/appartement/3pieces/apimo-7410861
Date the listing was last modified. Example: 2022-09-23T09:03:11.123Z
City where the property is located. Example: Antibes
Postal code of the property. Example: 06600
Unique identifier for the listing on Bienici. Example: apimo-7410861
Type of ad (sale or rental). Example: buy
Type of property (apartment, house, land, etc.). Example: flat
Title of the listing. Example: 3 PIÈCES PROCHE PLACE DE GAULLE
Full description text of the listing. Example: Idéalement situé au centre d'Antibes...
Date the listing was first published. Example: 2022-09-21T13:54:51.302Z
Seller’s or agency’s internal reference number. Example: 7410861
Whether the property is newly built. Example: false
Year the property was constructed. Example: 1980
Listed price of the property. Example: 267000
Price excluding agency fees. Example: 260000
Living surface area in square meters. Example: 53
Total land surface area in square meters. Example: 250
Total number of rooms. Example: 3
Number of bedrooms. Example: 2
Total number of floors in the building. Example: 4
Floor number where the property is located. Example: 1
Number of bathrooms. Example: 1
Number of shower rooms. Example: 1
Number of toilets. Example: 2
Number of terraces. Example: 1
Number of parking spaces. Example: 1
Whether the property includes a cellar. Example: true
Whether the property has an alarm system. Example: false
Whether the property has a fireplace. Example: false
Whether the property includes a garage. Example: true
Whether the property includes parking. Example: true
Whether the building has an elevator. Example: true
Whether the building has an intercom. Example: true
Whether the building has a door code entry. Example: true
Whether the building has a video intercom. Example: false
Whether the property has air conditioning. Example: true
Whether the property includes a garden. Example: true
Whether the property includes a swimming pool. Example: false
Whether the property has a balcony. Example: true
Whether the property has a terrace. Example: true
is_disabled_people_friendly
Whether the property is accessible for disabled people. Example: false
Whether the property is described as calm or quiet. Example: true
Whether renovation work is needed. Example: false
Cardinal orientation of the property (e.g. South, East). Example: Sud-Ouest
Energy consumption value in kWh/m²/year. Example: 279
Greenhouse gas emissions value in kg CO2/m²/year. Example: 9
Energy efficiency class (A to G). Example: E
greenhouse_gaz_classification
Greenhouse gas emissions class (A to G). Example: B
energy_performance_diagnostic_date
Date of the energy performance diagnostic. Example: 2022-09-21
Maximum energy consumption estimate. Example: 2900
Minimum energy consumption estimate. Example: 2100
use_july_2021_energy_performance_diagnostic
Whether the July 2021 DPE regulation applies. Example: true
Type of heating system (e.g. gas, electric, collective). Example: radiateur électrique individuel
is_exclusive_sale_mandate
Whether the agency has an exclusive sale mandate. Example: false
Who bears the agency fees (buyer or seller). Example: purchaser
URL to the agency’s fee schedule. Example: https://api.apimo.pro/document_agency/
Agency fee as a percentage of the sale price. Example: 3.5
Whether the ad was created by a professional agency. Example: true
Type of transaction (sale, rental, etc.). Example: buy
Price per square meter. Example: 5037.74
Type of account that posted the listing (private or pro). Example: agency
Display name of the seller or agency. Example: APIMO Agency
Unique identifier of the seller or agency account. Example: apimo-customer-123
French department code of the property location. Example: 06
District or neighborhood of the property. Example: {'name': 'Antibes', 'code_insee': '06004'}
Whether the exact address is known. Example: false
Information about location blurring applied to the listing. Example: {'type': 'cityOrArrondissement'}
Optical fiber availability status at the property. Example: deploye
Whether the property has electric vehicle charging stations. Example: {'providers': []}
List of photo URLs for the listing. Example: []
Whether a 3D model is available for the listing. Example: false
Whether the 3D model is featured prominently. Example: false
Whether a 360° virtual tour is available. Example: false
Whether a virtual tour is requested. Example: false
IDs of related listings. Example: []
Whether the listing is exclusive to Bienici. Example: false
end_of_promoted_as_exclusive
End date of the exclusive promotion period. Example: 0
Relevance score boost applied to the listing. Example: 5
Whether the listing price has been reduced. Example: false
Whether a reduced VAT rate applies to the property. Example: false
Whether the property is part of a condominium. Example: true
is_condominium_in_procedure
Whether the condominium has ongoing legal proceedings. Example: false
Current status of the listing (active, sold, rented, etc.). Example: {'onTheMarket': True}
Threshold date used for DPE classification rules. Example: 2025-08-17T00:00:00.000Z
Whether the district name is displayed on the listing. Example: true
display_insurance_estimation
Whether an insurance estimate is displayed. Example: true
Whether email contact is highlighted on the listing. Example: false
Whether there is no gated content behind the contact form. Example: false
Whether a PDF is available behind the contact form. Example: false
Number of times the phone number has been revealed. Example: []
Character length of the listing description. Example: 92
Whether the listing includes a geo-risks mention. Example: false
postal_code_for_search_filters
Postal code used for search filter matching. Example: 06600
User-specific data relative to the listing (e.g. saved, contacted). Example: {}
Alias used for watermarking listing photos. Example: apimo-watermark