Skip to content
Examples

Get Results

Retrieve scraped data from Bien'Ici Search Export

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/results

Retrieve scraped data from your Bien'Ici Search Export runs.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Query Parameters

squidstringqueryrequired

Hash of the squid to get results from

runstringquery

Hash of a specific run (optional)

pageintegerquery

Page number (default: 1). Example: 1

Result Fields

Each result object contains the following fields:

urlstring

Direct URL to the listing on Bienici. Example: https://www.bienici.com/annonce/vente/antibes/appartement/3pieces/apimo-7410861

modification_datedatetime

Date the listing was last modified. Example: 2022-09-23T09:03:11.123Z

citystring

City where the property is located. Example: Antibes

postal_codestring

Postal code of the property. Example: 06600

listing_idstring

Unique identifier for the listing on Bienici. Example: apimo-7410861

ad_typestring

Type of ad (sale or rental). Example: buy

property_typestring

Type of property (apartment, house, land, etc.). Example: flat

titlestring

Title of the listing. Example: 3 PIÈCES PROCHE PLACE DE GAULLE

descriptiontext

Full description text of the listing. Example: Idéalement situé au centre d'Antibes...

publication_datedatetime

Date the listing was first published. Example: 2022-09-21T13:54:51.302Z

referencestring

Seller's or agency's internal reference number. Example: 7410861

new_propertyboolean

Whether the property is newly built. Example: false

year_of_constructioninteger

Year the property was constructed. Example: 1980

pricefloat

Listed price of the property. Example: 267000

price_without_feesfloat

Price excluding agency fees. Example: 260000

surface_areafloat

Living surface area in square meters. Example: 53

land_surface_areafloat

Total land surface area in square meters. Example: 250

rooms_quantityinteger

Total number of rooms. Example: 3

bedrooms_quantityinteger

Number of bedrooms. Example: 2

floor_quantityinteger

Total number of floors in the building. Example: 4

floorinteger

Floor number where the property is located. Example: 1

bathrooms_quantityinteger

Number of bathrooms. Example: 1

shower_rooms_quantityinteger

Number of shower rooms. Example: 1

toilet_quantityinteger

Number of toilets. Example: 2

terraces_quantityinteger

Number of terraces. Example: 1

parking_places_quantityinteger

Number of parking spaces. Example: 1

has_cellarboolean

Whether the property includes a cellar. Example: true

has_alarmboolean

Whether the property has an alarm system. Example: false

has_fireplaceboolean

Whether the property has a fireplace. Example: false

has_garageboolean

Whether the property includes a garage. Example: true

has_parkingboolean

Whether the property includes parking. Example: true

has_elevatorboolean

Whether the building has an elevator. Example: true

has_intercomboolean

Whether the building has an intercom. Example: true

has_door_codeboolean

Whether the building has a door code entry. Example: true

has_videophoneboolean

Whether the building has a video intercom. Example: false

has_air_conditioningboolean

Whether the property has air conditioning. Example: true

has_gardenboolean

Whether the property includes a garden. Example: true

has_poolboolean

Whether the property includes a swimming pool. Example: false

has_balconyboolean

Whether the property has a balcony. Example: true

has_terraceboolean

Whether the property has a terrace. Example: true

is_disabled_people_friendlyboolean

Whether the property is accessible for disabled people. Example: false

is_calmboolean

Whether the property is described as calm or quiet. Example: true

work_to_doboolean

Whether renovation work is needed. Example: false

expositionstring

Cardinal orientation of the property (e.g. South, East). Example: Sud-Ouest

energy_valuefloat

Energy consumption value in kWh/m²/year. Example: 279

greenhouse_gaz_valuefloat

Greenhouse gas emissions value in kg CO2/m²/year. Example: 9

energy_classificationstring

Energy efficiency class (A to G). Example: E

greenhouse_gaz_classificationstring

Greenhouse gas emissions class (A to G). Example: B

energy_performance_diagnostic_datestring

Date of the energy performance diagnostic. Example: 2022-09-21

max_energy_consumptionfloat

Maximum energy consumption estimate. Example: 2900

min_energy_consumptionfloat

Minimum energy consumption estimate. Example: 2100

use_july_2021_energy_performance_diagnosticboolean

Whether the July 2021 DPE regulation applies. Example: true

heatingstring

Type of heating system (e.g. gas, electric, collective). Example: radiateur électrique individuel

is_exclusive_sale_mandateboolean

Whether the agency has an exclusive sale mandate. Example: false

fees_charged_tostring

Who bears the agency fees (buyer or seller). Example: purchaser

agency_fee_urlstring

URL to the agency's fee schedule. Example: https://api.apimo.pro/document_agency/

agency_fee_percentagefloat

Agency fee as a percentage of the sale price. Example: 3.5

ad_created_by_proboolean

Whether the ad was created by a professional agency. Example: true

transaction_typestring

Type of transaction (sale, rental, etc.). Example: buy

price_per_square_meterfloat

Price per square meter. Example: 5037.74

account_typestring

Type of account that posted the listing (private or pro). Example: agency

account_display_namestring

Display name of the seller or agency. Example: APIMO Agency

customer_idstring

Unique identifier of the seller or agency account. Example: apimo-customer-123

department_codestring

French department code of the property location. Example: 06

districtjson

District or neighborhood of the property. Example: {'name': 'Antibes', 'code_insee': '06004'}

address_knownboolean

Whether the exact address is known. Example: false

blur_infojson

Information about location blurring applied to the listing. Example: {'type': 'cityOrArrondissement'}

optical_fiber_statusstring

Optical fiber availability status at the property. Example: deploye

charging_stationsjson

Whether the property has electric vehicle charging stations. Example: {'providers': []}

photosjson

List of photo URLs for the listing. Example: []

with_3d_modelboolean

Whether a 3D model is available for the listing. Example: false

is_3d_highlightedboolean

Whether the 3D model is featured prominently. Example: false

has_lot_with_360boolean

Whether a 360° virtual tour is available. Example: false

need_virtual_tourboolean

Whether a virtual tour is requested. Example: false

related_ads_idsjson

IDs of related listings. Example: []

is_bien_ici_exclusiveboolean

Whether the listing is exclusive to Bienici. Example: false

end_of_promoted_as_exclusiveinteger

End date of the exclusive promotion period. Example: 0

relevance_bonusinteger

Relevance score boost applied to the listing. Example: 5

price_has_decreasedboolean

Whether the listing price has been reduced. Example: false

reduced_vatboolean

Whether a reduced VAT rate applies to the property. Example: false

is_in_condominiumboolean

Whether the property is part of a condominium. Example: true

is_condominium_in_procedureboolean

Whether the condominium has ongoing legal proceedings. Example: false

statusjson

Current status of the listing (active, sold, rented, etc.). Example: {'onTheMarket': True}

threshold_datedatetime

Threshold date used for DPE classification rules. Example: 2025-08-17T00:00:00.000Z

display_district_nameboolean

Whether the district name is displayed on the listing. Example: true

display_insurance_estimationboolean

Whether an insurance estimate is displayed. Example: true

highlight_mail_contactboolean

Whether email contact is highlighted on the listing. Example: false

nothing_behind_formboolean

Whether there is no gated content behind the contact form. Example: false

pdf_behind_formboolean

Whether a PDF is available behind the contact form. Example: false

phone_displaysjson

Number of times the phone number has been revealed. Example: []

description_text_lengthinteger

Character length of the listing description. Example: 92

has_georisques_mentionboolean

Whether the listing includes a geo-risks mention. Example: false

postal_code_for_search_filtersstring

Postal code used for search filter matching. Example: 06600

user_relative_datajson

User-specific data relative to the listing (e.g. saved, contacted). Example: {}

photo_watermark_aliasstring

Alias used for watermarking listing photos. Example: apimo-watermark

Response

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
}