Get Results
curl --request GET \
--url https://api.lobstr.io/v1/results \
--header 'Authorization: <authorization>'import requests
url = "https://api.lobstr.io/v1/results"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.lobstr.io/v1/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lobstr.io/v1/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lobstr.io/v1/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/results")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lobstr.io/v1/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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>"
}Bien'Ici Listings Search Export
Get Results
Retrieve scraped data from Bien’Ici Search Export
GET
/
v1
/
results
Get Results
curl --request GET \
--url https://api.lobstr.io/v1/results \
--header 'Authorization: <authorization>'import requests
url = "https://api.lobstr.io/v1/results"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.lobstr.io/v1/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lobstr.io/v1/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lobstr.io/v1/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/results")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lobstr.io/v1/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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>"
}Retrieve scraped data from your Bien’Ici Search Export runs.
Headers
string
required
Your API authentication token. Value:
Token YOUR_API_KEYQuery Parameters
string
required
Hash of the squid to get results from
string
Hash of a specific run (optional)
integer
Page number (default: 1). Example:
1Result Fields
Each result object contains the following fields:string
Direct URL to the listing on Bienici. Example:
https://www.bienici.com/annonce/vente/antibes/appartement/3pieces/apimo-7410861datetime
Date the listing was last modified. Example:
2022-09-23T09:03:11.123Zstring
City where the property is located. Example:
Antibesstring
Postal code of the property. Example:
06600string
Unique identifier for the listing on Bienici. Example:
apimo-7410861string
Type of ad (sale or rental). Example:
buystring
Type of property (apartment, house, land, etc.). Example:
flatstring
Title of the listing. Example:
3 PIÈCES PROCHE PLACE DE GAULLEtext
Full description text of the listing. Example:
Idéalement situé au centre d'Antibes...datetime
Date the listing was first published. Example:
2022-09-21T13:54:51.302Zstring
Seller’s or agency’s internal reference number. Example:
7410861boolean
Whether the property is newly built. Example:
falseinteger
Year the property was constructed. Example:
1980float
Listed price of the property. Example:
267000float
Price excluding agency fees. Example:
260000float
Living surface area in square meters. Example:
53float
Total land surface area in square meters. Example:
250integer
Total number of rooms. Example:
3integer
Number of bedrooms. Example:
2integer
Total number of floors in the building. Example:
4integer
Floor number where the property is located. Example:
1integer
Number of bathrooms. Example:
1integer
Number of shower rooms. Example:
1integer
Number of toilets. Example:
2integer
Number of terraces. Example:
1integer
Number of parking spaces. Example:
1boolean
Whether the property includes a cellar. Example:
trueboolean
Whether the property has an alarm system. Example:
falseboolean
Whether the property has a fireplace. Example:
falseboolean
Whether the property includes a garage. Example:
trueboolean
Whether the property includes parking. Example:
trueboolean
Whether the building has an elevator. Example:
trueboolean
Whether the building has an intercom. Example:
trueboolean
Whether the building has a door code entry. Example:
trueboolean
Whether the building has a video intercom. Example:
falseboolean
Whether the property has air conditioning. Example:
trueboolean
Whether the property includes a garden. Example:
trueboolean
Whether the property includes a swimming pool. Example:
falseboolean
Whether the property has a balcony. Example:
trueboolean
Whether the property has a terrace. Example:
trueboolean
Whether the property is accessible for disabled people. Example:
falseboolean
Whether the property is described as calm or quiet. Example:
trueboolean
Whether renovation work is needed. Example:
falsestring
Cardinal orientation of the property (e.g. South, East). Example:
Sud-Ouestfloat
Energy consumption value in kWh/m²/year. Example:
279float
Greenhouse gas emissions value in kg CO2/m²/year. Example:
9string
Energy efficiency class (A to G). Example:
Estring
Greenhouse gas emissions class (A to G). Example:
Bstring
Date of the energy performance diagnostic. Example:
2022-09-21float
Maximum energy consumption estimate. Example:
2900float
Minimum energy consumption estimate. Example:
2100boolean
Whether the July 2021 DPE regulation applies. Example:
truestring
Type of heating system (e.g. gas, electric, collective). Example:
radiateur électrique individuelboolean
Whether the agency has an exclusive sale mandate. Example:
falsestring
Who bears the agency fees (buyer or seller). Example:
purchaserstring
URL to the agency’s fee schedule. Example:
https://api.apimo.pro/document_agency/float
Agency fee as a percentage of the sale price. Example:
3.5boolean
Whether the ad was created by a professional agency. Example:
truestring
Type of transaction (sale, rental, etc.). Example:
buyfloat
Price per square meter. Example:
5037.74string
Type of account that posted the listing (private or pro). Example:
agencystring
Display name of the seller or agency. Example:
APIMO Agencystring
Unique identifier of the seller or agency account. Example:
apimo-customer-123string
French department code of the property location. Example:
06json
District or neighborhood of the property. Example:
{'name': 'Antibes', 'code_insee': '06004'}boolean
Whether the exact address is known. Example:
falsejson
Information about location blurring applied to the listing. Example:
{'type': 'cityOrArrondissement'}string
Optical fiber availability status at the property. Example:
deployejson
Whether the property has electric vehicle charging stations. Example:
{'providers': []}json
List of photo URLs for the listing. Example:
[]boolean
Whether a 3D model is available for the listing. Example:
falseboolean
Whether the 3D model is featured prominently. Example:
falseboolean
Whether a 360° virtual tour is available. Example:
falseboolean
Whether a virtual tour is requested. Example:
falsejson
IDs of related listings. Example:
[]boolean
Whether the listing is exclusive to Bienici. Example:
falseinteger
End date of the exclusive promotion period. Example:
0integer
Relevance score boost applied to the listing. Example:
5boolean
Whether the listing price has been reduced. Example:
falseboolean
Whether a reduced VAT rate applies to the property. Example:
falseboolean
Whether the property is part of a condominium. Example:
trueboolean
Whether the condominium has ongoing legal proceedings. Example:
falsejson
Current status of the listing (active, sold, rented, etc.). Example:
{'onTheMarket': True}datetime
Threshold date used for DPE classification rules. Example:
2025-08-17T00:00:00.000Zboolean
Whether the district name is displayed on the listing. Example:
trueboolean
Whether an insurance estimate is displayed. Example:
trueboolean
Whether email contact is highlighted on the listing. Example:
falseboolean
Whether there is no gated content behind the contact form. Example:
falseboolean
Whether a PDF is available behind the contact form. Example:
falsejson
Number of times the phone number has been revealed. Example:
[]integer
Character length of the listing description. Example:
92boolean
Whether the listing includes a geo-risks mention. Example:
falsestring
Postal code used for search filter matching. Example:
06600json
User-specific data relative to the listing (e.g. saved, contacted). Example:
{}string
Alias used for watermarking listing photos. Example:
apimo-watermarkResponse
200
{
"total_results": 1,
"limit": 50,
"page": 1,
"total_pages": 1,
"result_from": 1,
"result_to": 1,
"data": [
{
"id": 29338,
"object": "result",
"squid": "55a371355446ebb3d3cb415f48919146",
"run": "e2d92e66d85eba25f6e9a6affa046b7d",
"url": "https://www.bienici.com/annonce/vente/antibes/appartement/3pieces/apimo-7410861",
"modification_date": "2022-09-23T09:03:11.123Z",
"city": "Antibes",
"postal_code": "06600",
"listing_id": "apimo-7410861",
"ad_type": "buy",
"property_type": "flat",
"title": "3 PIÈCES PROCHE PLACE DE GAULLE",
"description": "Idéalement situé au centre d'Antibes...",
"publication_date": "2022-09-21T13:54:51.302Z",
"reference": "7410861",
"new_property": false,
"year_of_construction": 1980,
"price": 267000,
"price_without_fees": 260000,
"surface_area": 53,
"land_surface_area": 250,
"rooms_quantity": 3,
"bedrooms_quantity": 2,
"floor_quantity": 4,
"floor": 1,
"bathrooms_quantity": 1,
"shower_rooms_quantity": 1,
"toilet_quantity": 2,
"terraces_quantity": 1,
"parking_places_quantity": 1,
"has_cellar": true,
"has_alarm": false,
"has_fireplace": false,
"has_garage": true,
"has_parking": true,
"has_elevator": true,
"has_intercom": true,
"has_door_code": true,
"has_videophone": false,
"has_air_conditioning": true,
"has_garden": true,
"has_pool": false,
"has_balcony": true,
"has_terrace": true,
"is_disabled_people_friendly": false,
"is_calm": true,
"work_to_do": false,
"exposition": "Sud-Ouest",
"energy_value": 279,
"greenhouse_gaz_value": 9,
"energy_classification": "E",
"greenhouse_gaz_classification": "B",
"energy_performance_diagnostic_date": "2022-09-21",
"max_energy_consumption": 2900,
"min_energy_consumption": 2100,
"use_july_2021_energy_performance_diagnostic": true,
"heating": "radiateur électrique individuel",
"is_exclusive_sale_mandate": false,
"fees_charged_to": "purchaser",
"agency_fee_url": "https://api.apimo.pro/document_agency/",
"agency_fee_percentage": 3.5,
"ad_created_by_pro": true,
"transaction_type": "buy",
"price_per_square_meter": 5037.74,
"account_type": "agency",
"account_display_name": "APIMO Agency",
"customer_id": "apimo-customer-123",
"department_code": "06",
"district": {
"name": "Antibes",
"code_insee": "06004"
},
"address_known": false,
"blur_info": {
"type": "cityOrArrondissement"
},
"optical_fiber_status": "deploye",
"charging_stations": {
"providers": []
},
"photos": [],
"with_3d_model": false,
"is_3d_highlighted": false,
"has_lot_with_360": false,
"need_virtual_tour": false,
"related_ads_ids": [],
"is_bien_ici_exclusive": false,
"end_of_promoted_as_exclusive": 0,
"relevance_bonus": 5,
"price_has_decreased": false,
"reduced_vat": false,
"is_in_condominium": true,
"is_condominium_in_procedure": false,
"status": {
"onTheMarket": true
},
"threshold_date": "2025-08-17T00:00:00.000Z",
"display_district_name": true,
"display_insurance_estimation": true,
"highlight_mail_contact": false,
"nothing_behind_form": false,
"pdf_behind_form": false,
"phone_displays": [],
"description_text_length": 92,
"has_georisques_mention": false,
"postal_code_for_search_filters": "06600",
"user_relative_data": {},
"photo_watermark_alias": "apimo-watermark",
"functions": null,
"native_id": 29338
}
],
"next": null,
"previous": null
}