Machen Sie einen Termin
apimo™

Webservice & API

Willkommen in unserer API für Immobilienanbieter, hier finden Sie alle Details einer Immobilienagentur mit ihren Anzeigen, Kontaktiert und einigen ihrer Parameter. Je nach Ihren Rechten können Sie auch Informationen wie Leads versenden.

Partners

Kontaktieren Sie uns

Agencies/requests

verfügbare Methoden

HTTP Methode Weg Funktion
get /agencies/{agency_id}/requests Retrieve the requests list
post /agencies/{agency_id}/requests Create a new request
put /agencies/{agency_id}/requests/{request_id} Update a request
get /agencies/{agency_id}/requests/{request_id}/crossings Crossing list (matched properties) for a specific request

get Retrieve the requests list /agencies/{agency_id}/requests

Pfadparameter

  • agency_id  The unique id for the real estate agency

Request body parameters

  • limit  The number of records to return (max: 10000, default: 10000)
  • offset  The number of records to skip (default: 0)
  • timestamp  Return records created or updated since this UNIX/POSIX timestamp

Response body

  • total_items  The total number of item regardless of pagination
  • timestamp  UNIX/POSIX timestamp of the most recent item inside this list
  • requests  Array

Beispiel einer Anfrage

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/requests' \
--user 'provider:token' <?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Beispiel einer Antwort

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 25 Apr 2024 15:14:28 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"requests":[{"id":156488,"active":false,"contact":"220351","user":"3896","ranking":null,"last_action":null,"auto":true,"validated":false,"emailing":{"subscription":"1","last_at":null},"category":"1","subcategory":null,"types":["1","2"],"subtype":null,"referral":null,"subreferral":null,"country":"FR","locations":[{"region":null,"city":{"id":"2039","name":"Antibes"},"district":null}],"coordinates":null,"sector":null,"zone":null,"rooms_operator":"2","rooms":null,"bedrooms":0,"standing":null,"view":{"type":null,"landscape":null},"condition":null,"availability":null,"margin":"10","area":{"min":"100","max":null,"unit":"1"},"price":{"min":null,"max":"400000","currency":"EUR"},"floor":{"operator":"1","type":null,"value":null},"areas":[{"type":18,"number":1,"area_min":null}],"proximities":[],"services":[],"activities":[],"tags":[],"tags_customized":[],"comment":"","free_criteria":"","created_at":"2010-10-08 15:12:02","created_by":"3896","updated_at":"2014-04-10 09:37:18","updated_by":"3896"}]}

post Create a new request /agencies/{agency_id}/requests

Pfadparameter

  • agency_id  The unique id for the real estate agency

Request body parameters

Response body

  • id  Unique ID to store for any update (PUT method)
  • created_at  Date/time of the first creation
  • updated_at  Date/time of the last update

Beispiel einer Anfrage

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/requests' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }' \
--include <?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Beispiel einer Antwort

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 25 Apr 2024 15:14:28 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":1004656,"created_at":"2020-06-02 08:40:13","updated_at":"2020-06-02 08:40:13"}

put Update a request /agencies/{agency_id}/requests/{request_id}

Pfadparameter

  • agency_id  The unique id for the real estate agency
  • request_id  The unique id of the request

Request body parameters

Response body

  • id  Unique ID to store for any update (PUT method)
  • created_at  Date/time of the first creation
  • updated_at  Date/time of the last update

Beispiel einer Anfrage

Console
PHP
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/requests/{request_id}' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "id": "1004656", "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }' \
--include <?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests/{request_id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "id": "1004656", "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Beispiel einer Antwort

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 25 Apr 2024 15:14:28 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":1004656,"created_at":"2020-06-02 08:40:13","updated_at":"2020-06-02 08:40:13"}

get Crossing list (matched properties) for a specific request /agencies/{agency_id}/requests/{request_id}/crossings

Pfadparameter

  • agency_id  The unique id for the real estate agency
  • request_id  The unique id for the request

Request body parameters

  • limit  The number of records to return (max: 10000, default: 10000)
  • offset  The number of records to skip (default: 0)
  • timestamp  Return records created or updated since this UNIX/POSIX timestamp
  • step  Return records with specific step

Response body

  • total_items  The total number of item regardless of pagination
  • timestamp  UNIX/POSIX timestamp of the most recent item inside this list
  • crossings  Array
    • property_id  Unique ID of the property
    • step_id  1: To suggest, 2: Already suggested, 3: Not suggested
    • total  Score from 0 to 100
    • created_at  Date/time of the first creation
    • updated_at  Date/time of the last update

Beispiel einer Anfrage

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/requests/{request_id}/crossings' \
--user 'provider:token' <?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests/{request_id}/crossings');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Beispiel einer Antwort

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 25 Apr 2024 15:14:28 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"total_items":1,"timestamp":1397115438,"crossings":[{"property_id":1234567,"step_id":1,"total":"100","created_at":"2010-10-08 15:12:02","updated_at":"2014-04-10 09:37:18"}]}

Diese Website ist durch reCAPTCHA geschützt und es gelten die Datenschutzbestimmungen und Nutzungsbedingungen von Google.