Skip to main content
POST
/pap/listings/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
produit
enum<string>
default:vente
Available options:
vente,
location
property_type
enum<string>[]
Available options:
maison,
appartement,
terrain,
garage-parking,
immeuble,
surface-a-amenager,
peniche,
mobil-home,
viager,
multipropriete,
residence-avec-service,
bureaux,
local-commercial,
fonds-de-commerce,
local-d-activite,
divers
rooms
integer[]
Required range: 1 <= x <= 6
min_bedrooms
integer | null
Required range: 1 <= x <= 6
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_area
integer | null
Required range: x >= 0
max_area
integer | null
Required range: x >= 0
min_land_area
integer | null
Required range: x >= 0
max_land_area
integer | null
Required range: x >= 0
exclude_new
boolean
default:false
tags
enum<string>[]
Available options:
ascenseur,
duplex-triplex,
dernier-etage,
piscine,
balcon-terrasse,
garages-parkings,
acces-handicape,
investissement-locatif,
visite-virtuelle

Response

Successful Response

id
string
required
@type
string
default:PapSearchListing
url
string | null
property_type
string | null
price
number | null
area_m2
number | null
room_count
integer | null
bedroom_count
integer | null
energy_class
string | null
city
string | null
zip_code
string | null
image
string | null