API Reference
Introduction
The Remax API is REST service, the API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors and JSON is returned in the response.
The API endpoint is https://api.remax.ky/api-2-0/listings
Authentication
To authenticate when making a call to Remax.ky API, the API key must be passed in as a Bearer token.
Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, generated fo use this with the Remax.ky API. The client must send this token in the Authorization header when making requests to the Remax.ky API.
Authorization: Bearer <token>
Errors
Remax API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with our servers.
HTTP status code summary
| 200 - OK | Everything worked as expected. |
|---|---|
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 402 - Request Failed | The parameters were valid but the request failed. |
| 403 - Forbidden | You have no rights to access this resource. |
| 404 - Not Found | The requested resource doesn't exist. |
| 429 - Too Many Requests | Too many requests hit the API. |
| 500, 502, 503, 504 - Server Errors | Something went wrong on Kadastre servers. (These are rare.) |
Get resources
To retrieve data from the Remax service, use a GET HTTP call to our API endpoint (don't forget to send the authentication header) with the resource you want to retrieve.
Endpoints
The available endpoints are:
| Retrieve all properties |
Example (PHP)
define('REMAX_API_URL', 'https://api.remax.ky/api-2-0/listings');
$token = 'YOUR_TOKEN';
$result = getResponse(REMAX_API_URL, $token);
echo count($result);
foreach($result as $property) {
echo "{$property->propertyTitle}";
}
function getResponse($url, $token) {
$ch = curl_init();
$headers = array();
$headers[] = "Authorization: Bearer {$token}";
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_TIMEOUT, 12);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
$response = curl_exec($ch);
if (curl_error($ch)) {
curl_close($ch);
return false;
} else {
curl_close($ch);
return json_decode($response);
}
}
Example response
For information on variable values and different property types, please refer to the CIREBA xml documentation
[{
"agents": [{
"email": "[email protected]",
"listagentCommission": null
}, {
"email": "[email protected]",
"listagentCommission": null
}],
"location": {
"district": "W Bay Bch South",
"house": "509",
"streetname": "Britannia Estates",
"area": "20",
"longitude": "-81.370883",
"latitude": "19.325457",
"parcel": "100",
"block": "12D"
},
"details": {
"parcel": "100",
"block": "12D",
"mlsId": "400232",
"priceCurrency": "US$",
"price": "7250000",
"description": "
HTML DESCRIPTION
",
"numBedrooms": "6",
"numFullBathrooms": "8.5",
"squareFeet": "14950",
"acreage": "1.19",
"views": "Water View",
"yearBuilt": "2007",
"width": "",
"depth": "",
"petsAllowed": "No",
"listdate": "2018-04-05 00:00:00",
"expiredate": "2019-04-05",
"suspendeddate": "",
"pendingDate": "",
"reduceddate": "2018-04-05",
"withdrawndate": "2020-03-19",
"pencondate": "",
"increaseddate": "2019-03-22",
"changedate": "2019-03-22",
"bmkdate": "",
"solddate": "",
"salePrice": "",
"salePriceCurr": "CI$",
"priceforchattel": "",
"pricecurrForchattel": "CI$",
"chattelIncluded": "No",
"salesByOffice": null,
"salesByAgent": null,
"saleAgentCommission": null,
"coopSale": null,
"invoicenumber": "",
"owner1Name": null,
"owner1Address": null,
"owner1City": null,
"owner1State": null,
"owner1Country": null,
"owner1Zip": null,
"owner2Name": null,
"owner2Address": null,
"owner2City": null,
"owner2State": null,
"owner2Country": null,
"owner2Zip": null,
"brochure": null
},
"otherdetails": {
"directions": "Located within Britannia Estates Gates.",
"configuration": "",
"strata": "",
"fractionalShare": "",
"week": "",
"affiliation": "",
"approxWaterFrontage": "1",
"stories": "3",
"courtOrder": "No",
"forcedSale": "No",
"lendingInstitution": "",
"waterFrontage": "1",
"storiesBuilding": "",
"storiesCondo": "",
"floorLevel": "",
"numberOfUnits": "",
"furnished": "No",
"garage": "3",
"unitNum": "",
"fence": "Yes",
"den": "Yes",
"livingRoom": "Yes",
"kitchen": "Yes",
"familyRoom": "Yes",
"diningArea": "Yes",
"breakfast": "Yes",
"pool": "No",
"covenant": "Yes",
"cityWater": "Yes",
"patio": "Yes",
"landDescImpr": "",
"zoning": "Beach Resort\/Residential",
"ac": "Multi-Zone",
"class": "Existing",
"construction": "Block",
"foundation": "Slab",
"frontageRoad": "",
"roadFrontage": "0",
"howShown": "By Appointment\/List",
"landCertificate": "",
"occupant": "Owner",
"ovenOrRange": "Gas",
"porch": "Unscreened",
"dishwasher": "Yes",
"microwave": "Yes",
"refrigerator": "Yes",
"tv": "Other",
"tennis": "No",
"assets": "",
"monthlyMaintCost": "",
"monthlyMaintCostCurr": "CI$",
"yearlyMaintCost": 0,
"yearlyMaintCostCurr": "CI$",
"insuranceInMaint": "No",
"sewageInMaint": "No",
"monthlyInsurance": "",
"monthlyInsuranceCurr": "CI$",
"yearlyInsuranceCost": 0,
"yearlyInsuranceCostCurr": "CI$",
"monthlySewage": "",
"monthlySewageCurr": "CI$",
"yearlySewageCost": 0,
"yearlySewageCostCurr": "CI$",
"annualIncome": "",
"annualIncomeCurr": "CI$",
"petsInMaintCost": "No",
"petsMaintCost": 0,
"petsMaintCostCurr": "CI$",
"tvInMaintCost": "No",
"tvMaintCost": 0,
"tvMaintCostCurr": "CI$",
"acInMaintCost": "No",
"acMaintCost": 0,
"acMaintCostCurr": "CI$",
"poolInMaintCost": "No",
"poolMaintCost": 0,
"poolMaintCostCurr": "CI$",
"gardeningInMaintCost": "No",
"gardeningMaintCost": 0,
"gardeningMaintCostCurr": "Monthly",
"possession": "",
"roadSurface": "",
"soil": "",
"title": "Leasehold",
"topography": "",
"trees": "",
"typeUse": "",
"washerDryer": "Other",
"carPort": "4",
"utility": "Yes",
"septic": "Yes",
"sewer": "Yes",
"well": "No",
"cistern": "Yes",
"disposal": "Yes",
"dock": "Yes",
"securityAlarm": "Yes",
"elevator": "Yes",
"bonus": "",
"lease": "",
"leaseDetails": "",
"permanentFixtures": "",
"limitations": null,
"annualOperatingCostsCurr": "CI$",
"annualOperatingCosts": "",
"atlaspage": null,
"atlasrow": null,
"atlascolumn": null,
"atlas2page": null,
"atlas2row": null,
"atlas2column": null,
"mediaRoom": "Yes",
"wineRoom": "Yes",
"healthCenter": "No",
"gym": "Yes",
"hurricaneShutters": "No",
"stormWindows": "Yes"
},
"multiunit": [],
"pictures": [{
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_06.jpg",
"pictureCaption": "",
"pictureFacephoto": "Y"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_c8w6333.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_12.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_03.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_13.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_20.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_c8w7848.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_02.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_16.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_18.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_19.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}, {
"pictureUrl": "https:\/\/api.remax.ky\/media\/listings\/1\/15687_sp_aerial_cropped.jpg",
"pictureCaption": "",
"pictureFacephoto": "N"
}],
"videos": [{
"videoUrl": "https:\/\/www.youtube.com\/watch?v=bHoLW90YpxI",
"videoCaption": null
}, {
"videoUrl": "https:\/\/www.youtube.com\/watch?v=xxmTJDE7saY",
"videoCaption": null
}, {
"videoUrl": "https:\/\/www.youtube.com\/watch?v=JcqPNFkmjos",
"videoCaption": null
}],
"tours": [],
"propertyTitle": "Sunset Point Britannia Estates Home and Land",
"moduleName": "For Sale",
"propertyType": "Residential",
"listingType": "Single Family Home",
"listingStatus": "Withdrawn",
"propertyEditby": "",
"id": 1
}]