/pap/listings/search
curl --request POST \
--url https://api.anysite.io/api/pap/listings/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location": "<string>",
"count": 2,
"timeout": 300,
"produit": "vente",
"property_type": [],
"rooms": [],
"min_bedrooms": 3,
"min_price": 1,
"max_price": 1,
"min_area": 1,
"max_area": 1,
"min_land_area": 1,
"max_land_area": 1,
"exclude_new": false,
"tags": []
}
'import requests
url = "https://api.anysite.io/api/pap/listings/search"
payload = {
"location": "<string>",
"count": 2,
"timeout": 300,
"produit": "vente",
"property_type": [],
"rooms": [],
"min_bedrooms": 3,
"min_price": 1,
"max_price": 1,
"min_area": 1,
"max_area": 1,
"min_land_area": 1,
"max_land_area": 1,
"exclude_new": False,
"tags": []
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
location: '<string>',
count: 2,
timeout: 300,
produit: 'vente',
property_type: [],
rooms: [],
min_bedrooms: 3,
min_price: 1,
max_price: 1,
min_area: 1,
max_area: 1,
min_land_area: 1,
max_land_area: 1,
exclude_new: false,
tags: []
})
};
fetch('https://api.anysite.io/api/pap/listings/search', 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.anysite.io/api/pap/listings/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location' => '<string>',
'count' => 2,
'timeout' => 300,
'produit' => 'vente',
'property_type' => [
],
'rooms' => [
],
'min_bedrooms' => 3,
'min_price' => 1,
'max_price' => 1,
'min_area' => 1,
'max_area' => 1,
'min_land_area' => 1,
'max_land_area' => 1,
'exclude_new' => false,
'tags' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/pap/listings/search"
payload := strings.NewReader("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"produit\": \"vente\",\n \"property_type\": [],\n \"rooms\": [],\n \"min_bedrooms\": 3,\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_area\": 1,\n \"max_area\": 1,\n \"min_land_area\": 1,\n \"max_land_area\": 1,\n \"exclude_new\": false,\n \"tags\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/pap/listings/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"produit\": \"vente\",\n \"property_type\": [],\n \"rooms\": [],\n \"min_bedrooms\": 3,\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_area\": 1,\n \"max_area\": 1,\n \"min_land_area\": 1,\n \"max_land_area\": 1,\n \"exclude_new\": false,\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/pap/listings/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"produit\": \"vente\",\n \"property_type\": [],\n \"rooms\": [],\n \"min_bedrooms\": 3,\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_area\": 1,\n \"max_area\": 1,\n \"min_land_area\": 1,\n \"max_land_area\": 1,\n \"exclude_new\": false,\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "PapSearchListing",
"url": "<string>",
"property_type": "<string>",
"price": 123,
"area_m2": 123,
"room_count": 123,
"bedroom_count": 123,
"energy_class": "<string>",
"city": "<string>",
"zip_code": "<string>",
"image": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/pap
/pap/listings/search
Search PAP.fr real estate listings by location (city, arrondissement, department, region or postal code) for sale (vente) or rent (location), with property type, rooms, bedrooms, price, living area, land area, new-build exclusion and amenity filters. Returns listing cards with property type, price, living area, rooms, bedrooms, energy class, city, zip code, description snippet, photo and the listing detail url.
Price: 10 credits per 12 results
⚠️ Common errors: 412: Location could not be resolved
POST
/
api
/
pap
/
listings
/
search
/pap/listings/search
curl --request POST \
--url https://api.anysite.io/api/pap/listings/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location": "<string>",
"count": 2,
"timeout": 300,
"produit": "vente",
"property_type": [],
"rooms": [],
"min_bedrooms": 3,
"min_price": 1,
"max_price": 1,
"min_area": 1,
"max_area": 1,
"min_land_area": 1,
"max_land_area": 1,
"exclude_new": false,
"tags": []
}
'import requests
url = "https://api.anysite.io/api/pap/listings/search"
payload = {
"location": "<string>",
"count": 2,
"timeout": 300,
"produit": "vente",
"property_type": [],
"rooms": [],
"min_bedrooms": 3,
"min_price": 1,
"max_price": 1,
"min_area": 1,
"max_area": 1,
"min_land_area": 1,
"max_land_area": 1,
"exclude_new": False,
"tags": []
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
location: '<string>',
count: 2,
timeout: 300,
produit: 'vente',
property_type: [],
rooms: [],
min_bedrooms: 3,
min_price: 1,
max_price: 1,
min_area: 1,
max_area: 1,
min_land_area: 1,
max_land_area: 1,
exclude_new: false,
tags: []
})
};
fetch('https://api.anysite.io/api/pap/listings/search', 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.anysite.io/api/pap/listings/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location' => '<string>',
'count' => 2,
'timeout' => 300,
'produit' => 'vente',
'property_type' => [
],
'rooms' => [
],
'min_bedrooms' => 3,
'min_price' => 1,
'max_price' => 1,
'min_area' => 1,
'max_area' => 1,
'min_land_area' => 1,
'max_land_area' => 1,
'exclude_new' => false,
'tags' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/pap/listings/search"
payload := strings.NewReader("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"produit\": \"vente\",\n \"property_type\": [],\n \"rooms\": [],\n \"min_bedrooms\": 3,\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_area\": 1,\n \"max_area\": 1,\n \"min_land_area\": 1,\n \"max_land_area\": 1,\n \"exclude_new\": false,\n \"tags\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/pap/listings/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"produit\": \"vente\",\n \"property_type\": [],\n \"rooms\": [],\n \"min_bedrooms\": 3,\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_area\": 1,\n \"max_area\": 1,\n \"min_land_area\": 1,\n \"max_land_area\": 1,\n \"exclude_new\": false,\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/pap/listings/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"produit\": \"vente\",\n \"property_type\": [],\n \"rooms\": [],\n \"min_bedrooms\": 3,\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_area\": 1,\n \"max_area\": 1,\n \"min_land_area\": 1,\n \"max_land_area\": 1,\n \"exclude_new\": false,\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "PapSearchListing",
"url": "<string>",
"property_type": "<string>",
"price": 123,
"area_m2": 123,
"room_count": 123,
"bedroom_count": 123,
"energy_class": "<string>",
"city": "<string>",
"zip_code": "<string>",
"image": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
application/json
Minimum string length:
1Required range:
x >= 1Required range:
20 <= x <= 1500Available options:
vente, location 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 Required range:
1 <= x <= 6Required range:
1 <= x <= 6Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Available options:
ascenseur, duplex-triplex, dernier-etage, piscine, balcon-terrasse, garages-parkings, acces-handicape, investissement-locatif, visite-virtuelle Response
Successful Response