Skip to main content
GET
/
v1
/
results
Get Results
curl --request GET \
  --url https://api.lobstr.io/v1/results \
  --header 'Authorization: <authorization>'
{
  "url": "<string>",
  "modification_date": {},
  "city": "<string>",
  "postal_code": "<string>",
  "listing_id": "<string>",
  "ad_type": "<string>",
  "property_type": "<string>",
  "title": "<string>",
  "description": "<string>",
  "publication_date": {},
  "reference": "<string>",
  "new_property": true,
  "year_of_construction": 123,
  "price": 123,
  "price_without_fees": 123,
  "surface_area": 123,
  "land_surface_area": 123,
  "rooms_quantity": 123,
  "bedrooms_quantity": 123,
  "floor_quantity": 123,
  "floor": 123,
  "bathrooms_quantity": 123,
  "shower_rooms_quantity": 123,
  "toilet_quantity": 123,
  "terraces_quantity": 123,
  "parking_places_quantity": 123,
  "has_cellar": true,
  "has_alarm": true,
  "has_fireplace": true,
  "has_garage": true,
  "has_parking": true,
  "has_elevator": true,
  "has_intercom": true,
  "has_door_code": true,
  "has_videophone": true,
  "has_air_conditioning": true,
  "has_garden": true,
  "has_pool": true,
  "has_balcony": true,
  "has_terrace": true,
  "is_disabled_people_friendly": true,
  "is_calm": true,
  "work_to_do": true,
  "exposition": "<string>",
  "energy_value": 123,
  "greenhouse_gaz_value": 123,
  "energy_classification": "<string>",
  "greenhouse_gaz_classification": "<string>",
  "energy_performance_diagnostic_date": "<string>",
  "max_energy_consumption": 123,
  "min_energy_consumption": 123,
  "use_july_2021_energy_performance_diagnostic": true,
  "heating": "<string>",
  "is_exclusive_sale_mandate": true,
  "fees_charged_to": "<string>",
  "agency_fee_url": "<string>",
  "agency_fee_percentage": 123,
  "ad_created_by_pro": true,
  "transaction_type": "<string>",
  "price_per_square_meter": 123,
  "account_type": "<string>",
  "account_display_name": "<string>",
  "customer_id": "<string>",
  "department_code": "<string>",
  "district": "<any>",
  "address_known": true,
  "blur_info": "<any>",
  "optical_fiber_status": "<string>",
  "charging_stations": "<any>",
  "photos": "<any>",
  "with_3d_model": true,
  "is_3d_highlighted": true,
  "has_lot_with_360": true,
  "need_virtual_tour": true,
  "related_ads_ids": "<any>",
  "is_bien_ici_exclusive": true,
  "end_of_promoted_as_exclusive": 123,
  "relevance_bonus": 123,
  "price_has_decreased": true,
  "reduced_vat": true,
  "is_in_condominium": true,
  "is_condominium_in_procedure": true,
  "status": "<any>",
  "threshold_date": {},
  "display_district_name": true,
  "display_insurance_estimation": true,
  "highlight_mail_contact": true,
  "nothing_behind_form": true,
  "pdf_behind_form": true,
  "phone_displays": "<any>",
  "description_text_length": 123,
  "has_georisques_mention": true,
  "postal_code_for_search_filters": "<string>",
  "user_relative_data": "<any>",
  "photo_watermark_alias": "<string>"
}

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.

Headers

Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

Query Parameters

squid
string
required
Hash of the squid to get results from
run
string
Hash of a specific run (optional)
page
integer
Page number (default: 1). Example: 1

Result Fields

Each result object contains the following fields:
url
string
Direct URL to the listing on Bienici. Example: https://www.bienici.com/annonce/vente/antibes/appartement/3pieces/apimo-7410861
modification_date
datetime
Date the listing was last modified. Example: 2022-09-23T09:03:11.123Z
city
string
City where the property is located. Example: Antibes
postal_code
string
Postal code of the property. Example: 06600
listing_id
string
Unique identifier for the listing on Bienici. Example: apimo-7410861
ad_type
string
Type of ad (sale or rental). Example: buy
property_type
string
Type of property (apartment, house, land, etc.). Example: flat
title
string
Title of the listing. Example: 3 PIÈCES PROCHE PLACE DE GAULLE
description
text
Full description text of the listing. Example: Idéalement situé au centre d'Antibes...
publication_date
datetime
Date the listing was first published. Example: 2022-09-21T13:54:51.302Z
reference
string
Seller’s or agency’s internal reference number. Example: 7410861
new_property
boolean
Whether the property is newly built. Example: false
year_of_construction
integer
Year the property was constructed. Example: 1980
price
float
Listed price of the property. Example: 267000
price_without_fees
float
Price excluding agency fees. Example: 260000
surface_area
float
Living surface area in square meters. Example: 53
land_surface_area
float
Total land surface area in square meters. Example: 250
rooms_quantity
integer
Total number of rooms. Example: 3
bedrooms_quantity
integer
Number of bedrooms. Example: 2
floor_quantity
integer
Total number of floors in the building. Example: 4
floor
integer
Floor number where the property is located. Example: 1
bathrooms_quantity
integer
Number of bathrooms. Example: 1
shower_rooms_quantity
integer
Number of shower rooms. Example: 1
toilet_quantity
integer
Number of toilets. Example: 2
terraces_quantity
integer
Number of terraces. Example: 1
parking_places_quantity
integer
Number of parking spaces. Example: 1
has_cellar
boolean
Whether the property includes a cellar. Example: true
has_alarm
boolean
Whether the property has an alarm system. Example: false
has_fireplace
boolean
Whether the property has a fireplace. Example: false
has_garage
boolean
Whether the property includes a garage. Example: true
has_parking
boolean
Whether the property includes parking. Example: true
has_elevator
boolean
Whether the building has an elevator. Example: true
has_intercom
boolean
Whether the building has an intercom. Example: true
has_door_code
boolean
Whether the building has a door code entry. Example: true
has_videophone
boolean
Whether the building has a video intercom. Example: false
has_air_conditioning
boolean
Whether the property has air conditioning. Example: true
has_garden
boolean
Whether the property includes a garden. Example: true
has_pool
boolean
Whether the property includes a swimming pool. Example: false
has_balcony
boolean
Whether the property has a balcony. Example: true
has_terrace
boolean
Whether the property has a terrace. Example: true
is_disabled_people_friendly
boolean
Whether the property is accessible for disabled people. Example: false
is_calm
boolean
Whether the property is described as calm or quiet. Example: true
work_to_do
boolean
Whether renovation work is needed. Example: false
exposition
string
Cardinal orientation of the property (e.g. South, East). Example: Sud-Ouest
energy_value
float
Energy consumption value in kWh/m²/year. Example: 279
greenhouse_gaz_value
float
Greenhouse gas emissions value in kg CO2/m²/year. Example: 9
energy_classification
string
Energy efficiency class (A to G). Example: E
greenhouse_gaz_classification
string
Greenhouse gas emissions class (A to G). Example: B
energy_performance_diagnostic_date
string
Date of the energy performance diagnostic. Example: 2022-09-21
max_energy_consumption
float
Maximum energy consumption estimate. Example: 2900
min_energy_consumption
float
Minimum energy consumption estimate. Example: 2100
use_july_2021_energy_performance_diagnostic
boolean
Whether the July 2021 DPE regulation applies. Example: true
heating
string
Type of heating system (e.g. gas, electric, collective). Example: radiateur électrique individuel
is_exclusive_sale_mandate
boolean
Whether the agency has an exclusive sale mandate. Example: false
fees_charged_to
string
Who bears the agency fees (buyer or seller). Example: purchaser
agency_fee_url
string
URL to the agency’s fee schedule. Example: https://api.apimo.pro/document_agency/
agency_fee_percentage
float
Agency fee as a percentage of the sale price. Example: 3.5
ad_created_by_pro
boolean
Whether the ad was created by a professional agency. Example: true
transaction_type
string
Type of transaction (sale, rental, etc.). Example: buy
price_per_square_meter
float
Price per square meter. Example: 5037.74
account_type
string
Type of account that posted the listing (private or pro). Example: agency
account_display_name
string
Display name of the seller or agency. Example: APIMO Agency
customer_id
string
Unique identifier of the seller or agency account. Example: apimo-customer-123
department_code
string
French department code of the property location. Example: 06
district
json
District or neighborhood of the property. Example: {'name': 'Antibes', 'code_insee': '06004'}
address_known
boolean
Whether the exact address is known. Example: false
blur_info
json
Information about location blurring applied to the listing. Example: {'type': 'cityOrArrondissement'}
optical_fiber_status
string
Optical fiber availability status at the property. Example: deploye
charging_stations
json
Whether the property has electric vehicle charging stations. Example: {'providers': []}
photos
json
List of photo URLs for the listing. Example: []
with_3d_model
boolean
Whether a 3D model is available for the listing. Example: false
is_3d_highlighted
boolean
Whether the 3D model is featured prominently. Example: false
has_lot_with_360
boolean
Whether a 360° virtual tour is available. Example: false
need_virtual_tour
boolean
Whether a virtual tour is requested. Example: false
IDs of related listings. Example: []
is_bien_ici_exclusive
boolean
Whether the listing is exclusive to Bienici. Example: false
end_of_promoted_as_exclusive
integer
End date of the exclusive promotion period. Example: 0
relevance_bonus
integer
Relevance score boost applied to the listing. Example: 5
price_has_decreased
boolean
Whether the listing price has been reduced. Example: false
reduced_vat
boolean
Whether a reduced VAT rate applies to the property. Example: false
is_in_condominium
boolean
Whether the property is part of a condominium. Example: true
is_condominium_in_procedure
boolean
Whether the condominium has ongoing legal proceedings. Example: false
status
json
Current status of the listing (active, sold, rented, etc.). Example: {'onTheMarket': True}
threshold_date
datetime
Threshold date used for DPE classification rules. Example: 2025-08-17T00:00:00.000Z
display_district_name
boolean
Whether the district name is displayed on the listing. Example: true
display_insurance_estimation
boolean
Whether an insurance estimate is displayed. Example: true
highlight_mail_contact
boolean
Whether email contact is highlighted on the listing. Example: false
nothing_behind_form
boolean
Whether there is no gated content behind the contact form. Example: false
pdf_behind_form
boolean
Whether a PDF is available behind the contact form. Example: false
phone_displays
json
Number of times the phone number has been revealed. Example: []
description_text_length
integer
Character length of the listing description. Example: 92
has_georisques_mention
boolean
Whether the listing includes a geo-risks mention. Example: false
postal_code_for_search_filters
string
Postal code used for search filter matching. Example: 06600
user_relative_data
json
User-specific data relative to the listing (e.g. saved, contacted). Example: {}
photo_watermark_alias
string
Alias used for watermarking listing photos. Example: apimo-watermark