GET/v1/results

Get Results

Retrieve scraped Bien'Ici real estate listings

Retrieve scraped Bien'Ici real estate listings including comprehensive property details, pricing, location, amenities, energy performance ratings, and agency information.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes

Core Result Fields

integer

Unique result identifier

Example: 8542691

object

string

Always "result"

Example: result

squid

string

Squid that produced this result

Example: 53317cbe332e408c5c46372a18e4fc76

run

string

Run that produced this result

Example: a1b2c3d4e5f6789012345678901234ab

url

string

Direct link to the listing

Example: https://www.bienici.com/annonce/vente/antibes/appartement/3pieces/apimo-7410861

listing_id

string

Unique Bien'Ici listing identifier

Example: apimo-7410861

Property Information

title

string

Headline/title of the listing

Example: 3 PIÈCES PROCHE PLACE DE GAULLE

description

string

Full listing description

Example: Idéalement situé au centre d'Antibes...

property_type

string

Type of property

Example: flat

ad_type

string

Transaction type

Example: buy

new_property

boolean

Whether it's a new build

Example: false

year_of_construction

integernull

Year the property was built

Example: 1980

reference

string

Agency reference number

Example: 7410861

Location Information

city

string

City name

Example: Antibes

postal_code

string

Postal code

Example: 06600

department_code

string

French department code

Example: 06

district

jsonnull

District information with name and INSEE code

Example: {name: Antibes, code_insee: 06004}

address_known

boolean

Whether exact address is available

Example: false

blur_info

jsonnull

Address precision level

Example: {type: cityOrArrondissement}

Pricing Information

price

float

Total listing price in euros

Example: 267000

price_without_fees

floatnull

Price excluding agency fees

Example: 260000

price_per_square_meter

floatnull

Price per square meter

Example: 5037.74

transaction_type

string

Transaction type identifier

Example: buy

fees_charged_to

stringnull

Who pays agency fees

Example: purchaser

agency_fee_percentage

floatnull

Agency fee as percentage

Example: 3.5

reduced_vat

boolean

Whether reduced VAT applies

Example: false

Size & Layout

surface_area

float

Living area in square meters

Example: 53

land_surface_area

floatnull

Land area in square meters

Example: 250

rooms_quantity

integer

Total number of rooms

Example: 3

bedrooms_quantity

integernull

Number of bedrooms

Example: 2

bathrooms_quantity

integernull

Number of bathrooms

Example: 1

shower_rooms_quantity

integernull

Number of shower rooms

Example: 1

toilet_quantity

integernull

Number of toilets

Example: 2

floor

integernull

Floor number

Example: 1

floor_quantity

integernull

Total floors in building

Example: 4

Amenities & Features

has_garage

boolean

Has garage

Example: true

has_parking

boolean

Has parking

Example: true

parking_places_quantity

integernull

Number of parking spaces

Example: 1

has_cellar

boolean

Has cellar/basement

Example: true

has_elevator

boolean

Has elevator

Example: true

has_balcony

boolean

Has balcony

Example: true

has_terrace

boolean

Has terrace

Example: true

terraces_quantity

integernull

Number of terraces

Example: 1

has_garden

boolean

Has garden

Example: true

has_pool

boolean

Has swimming pool

Example: false

has_air_conditioning

boolean

Has air conditioning

Example: true

has_fireplace

boolean

Has fireplace

Example: false

has_alarm

boolean

Has alarm system

Example: false

Security & Access

has_intercom

boolean

Has intercom

Example: true

has_door_code

boolean

Has door code entry

Example: true

has_videophone

boolean

Has video intercom

Example: false

is_disabled_people_friendly

boolean

Accessible for disabled persons

Example: false

is_calm

boolean

Quiet location

Example: true

work_to_do

boolean

Renovation needed

Example: false

exposition

stringnull

Sun exposure direction

Example: Sud-Ouest

Energy Performance

energy_classification

stringnull

Energy Performance rating (A-G)

Example: E

energy_value

floatnull

Energy consumption value (kWh/m²/year)

Example: 279

greenhouse_gaz_classification

stringnull

Greenhouse Gas rating (A-G)

Example: B

greenhouse_gaz_value

floatnull

GHG emissions value (kg CO2/m²/year)

Example: 9

energy_performance_diagnostic_date

stringnull

Date of DPE diagnosis

Example: 2022-09-21

max_energy_consumption

floatnull

Maximum estimated annual energy cost

Example: 2900

min_energy_consumption

floatnull

Minimum estimated annual energy cost

Example: 2100

use_july_2021_energy_performance_diagnostic

boolean

Uses new 2021 DPE standard

Example: true

heating

stringnull

Heating type description

Example: radiateur électrique individuel

Condominium Details

is_in_condominium

boolean

Part of a condominium

Example: true

is_condominium_in_procedure

boolean

Condominium under legal procedure

Example: false

Agency Information

account_type

string

Type of seller account

Example: agency

account_display_name

string

Agency or seller display name

Example: APIMO Agency

ad_created_by_pro

boolean

Listed by professional

Example: true

customer_id

stringnull

Agency customer identifier

Example: apimo-customer-123

agency_fee_url

stringnull

URL to agency fee document

Example: https://api.apimo.pro/document_agency/

is_exclusive_sale_mandate

boolean

Exclusive agency mandate

Example: false

Media & Images

photos

json

Array of photo URLs

Example: []

with_3d_model

boolean

Has 3D model available

Example: false

is_3d_highlighted

boolean

3D tour is highlighted

Example: false

has_lot_with_360

boolean

Has 360° view

Example: false

need_virtual_tour

boolean

Virtual tour requested

Example: false

Listing Status

status

json

Listing market status

Example: {onTheMarket: true}

is_bien_ici_exclusive

boolean

Bien'Ici exclusive listing

Example: false

price_has_decreased

boolean

Price has been reduced

Example: false

relevance_bonus

integernull

Search relevance score

Example: 5

optical_fiber_status

stringnull

Fiber optic availability

Example: deploye

Timestamps

modification_date

datetime

Last modification date (ISO 8601)

Example: 2022-09-23T09:03:11.123Z

publication_date

datetime

Original publication date

Example: 2022-09-21T13:54:51.302Z

threshold_date

datetimenull

Listing threshold date

Example: 2025-08-17T00:00:00.000Z

scraping_time

string

When scraped (ISO 8601)

Example: 2025-07-16T10:04:14.545Z

Parameters

squidstring

Required

Hash of the squid to get results from

Example: 53317cbe332e408c5c46372a18e4fc76

runstring

Optional

Hash of a specific run (optional)

Example: a1b2c3d4e5f6789012345678901234ab

pageinteger

Optional

Page number (default: 1)

Example: 1

page_sizeinteger

Optional

Results per page (default: 50, max: 100)

Example: 50

Pro Tip

Use `energy_classification` and `greenhouse_gaz_classification` to filter properties by energy efficiency (A = most efficient, G = least efficient).

Pro Tip

Check `price_has_decreased` to identify listings where prices have been reduced - useful for finding motivated sellers.

Note

DPE/GES ratings follow French energy diagnostic standards. Properties using the July 2021 standard (`use_july_2021_energy_performance_diagnostic: true`) have more accurate ratings.

Pro Tip

Filter by `ad_type` to separate purchases (`buy`) from rentals, and by `property_type` for specific property categories.