{
  "aid": "swaggerhub.palace:advertising-integration-2.0.0",
  "name": "Advertising Integration API",
  "type": "Index",
  "description": "The 'Advertising' integration focuses on allowing 3rd party systems and customized websites to sync available properties from Palace to display up-to-date advertising on a company's website.<BR><BR><BR>The 'Advertising Integration' area does NOT require an upgrade from a 'Standard' API account to a 'Premium' API Account. There is a NO cost involved in using these contracts unless you are a 3rd Party solution provider wanting to integrate at a partner level.<BR><BR><BR>The following is a list of contracts to integrate 'Available Properties' into a public website.  The first contract /v2AvailableProperties/JSON provides comprehensive array of currrent available properties with details.<BR><BR><BR>  Every time the call is made to this contract it provides the current list at the time of the call.  If a property is no longer showing in the latest call that existed in previous calls you can use the /v2PreviousAvailableProperty/JSON/ contract to get information regarding the leased or withdrawn status and comments of the properties.<BR><BR><BR> You can get a list of related images to a Property in Base64 encoded string (/v2AvailablePropertyImages/JSON) or a URL (/v2AvailablePropertyImagesURL/JSON/) directly to the JPG file.  Use the Base64 encoded option to download the images to your website<BR><BR><BR> (NOTE: Do not use this contract to render images per request as the resulting request will be too slow to handle this).<BR><BR>  You can use the URL requests to link directly to your site.<BR><BR><BR><B>Update: 16th January 2025</B> - New endpoint added to retrieve VaultRE property advertising portal codes for properties synchronized between Palace and VaultRE...<BR><BR>/v2PalaceVaultAdvertisingCodes/JSON<BR><BR><BR><B>Update: 24th August 2023</B> - Property Features now accessible through API fields... <BR><BR>PropertyOnTradeMe<BR>PropertyExcludeUnitFromAddress<BR>PropertyAdvertiseAsCarpark<BR>PropertyDisabilityModification<BR>PropertyGarageParking<BR>PropertyOffStreetParking",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.palace/advertising-integration/2.0.0/apis.json",
  "tags": [
    "swaggerhub.palace",
    "advertising-integration"
  ],
  "created": "2026-04-04",
  "modified": "2026-04-04",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.palace:advertising-integration-2.0.0",
      "name": "Advertising Integration API",
      "description": "The 'Advertising' integration focuses on allowing 3rd party systems and customized websites to sync available properties from Palace to display up-to-date advertising on a company's website.<BR><BR><BR>The 'Advertising Integration' area does NOT require an upgrade from a 'Standard' API account to a 'Premium' API Account. There is a NO cost involved in using these contracts unless you are a 3rd Party solution provider wanting to integrate at a partner level.<BR><BR><BR>The following is a list of contracts to integrate 'Available Properties' into a public website.  The first contract /v2AvailableProperties/JSON provides comprehensive array of currrent available properties with details.<BR><BR><BR>  Every time the call is made to this contract it provides the current list at the time of the call.  If a property is no longer showing in the latest call that existed in previous calls you can use the /v2PreviousAvailableProperty/JSON/ contract to get information regarding the leased or withdrawn status and comments of the properties.<BR><BR><BR> You can get a list of related images to a Property in Base64 encoded string (/v2AvailablePropertyImages/JSON) or a URL (/v2AvailablePropertyImagesURL/JSON/) directly to the JPG file.  Use the Base64 encoded option to download the images to your website<BR><BR><BR> (NOTE: Do not use this contract to render images per request as the resulting request will be too slow to handle this).<BR><BR>  You can use the URL requests to link directly to your site.<BR><BR><BR><B>Update: 16th January 2025</B> - New endpoint added to retrieve VaultRE property advertising portal codes for properties synchronized between Palace and VaultRE...<BR><BR>/v2PalaceVaultAdvertisingCodes/JSON<BR><BR><BR><B>Update: 24th August 2023</B> - Property Features now accessible through API fields... <BR><BR>PropertyOnTradeMe<BR>PropertyExcludeUnitFromAddress<BR>PropertyAdvertiseAsCarpark<BR>PropertyDisabilityModification<BR>PropertyGarageParking<BR>PropertyOffStreetParking",
      "image": "",
      "baseURL": "https://api.getpalace.com/Service.svc/RestService",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.palace/advertising-integration/2.0.0",
      "version": "2.0.0",
      "tags": [
        "swaggerhub.palace",
        "advertising-integration"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.palace/advertising-integration/2.0.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.palace/advertising-integration/2.0.0"
        }
      ],
      "contact": [
        {
          "FN": "development@getpalace.com",
          "email": "development@getpalace.com"
        }
      ]
    }
  ]
}