IFP Schemas

This schema is for the Advert JSON data used within the IFP systems. While it is called "sale-advert-schema" it supports both sale and rental adverts.

Public Schemas:

Please use the latest version of these schemas when sending us sale adverts:

Public Sale Advert JSON Schema Changelog

• Public Sale Advert JSON Schema v1.2.0 - adds the property's coordinates, geo.user_data.lat / lon
• Public Sale Advert JSON Schema v1.1.0
• Public Sale Advert JSON Schema v1.0.0

Public Document Examples:

• Public Sale Advert JSON v1.2.0 example

• Public Sale Advert JSON v1.1.0 example

• Public Sale Advert JSON v1.0.0 example

• Public Sale Advert JSON v1.* list of enums available - see this for the full list of the enums in the schema that can be used for the lookup values in their respective keys.

• Public Sale Advert JSON v1.2.0 notes (only notes the additions to v1.1.0)

• Public Sale Advert JSON v1.1.0 notes (only notes the changes/additions to v1.0.0)

• Public Sale Advert JSON v1.0.0 notes

This document provides notes about the use for each field. There are two top-level objects:

• advert: Information about the advert, i.e. the advertising details.
• property: Information about the actual property being advertised.

There is some logic to the required fields of the property.geo.user_data, which must be followed in order ensure the advert is validated. It is necessary to supply one of the following combinations as a minimum:

• post_code
• commune_name + department_name
• commune_name + department_code

Other published schemas:

• Simplified Export Sale Advert JSON Schema v1.0.0 - the schema of the property exports we send to partners. Field-by-field notes: partner_exports.md.
• Geo Public JSON Schema v1.1.0 / v1.0.0 - referenced by property.geo in the public sale advert schemas (v1.2.0 uses v1.1.0, which adds lat / lon); you do not need to fetch it separately to validate.

Validating your JSON:

Run the repo's own validator over every schema and fixture:

pip install 'jsonschema~=4.25'
python3 bin/validate.py

It runs in CI on every branch and pull request.

JSON resources:

• Tutorials
• JSON Validator - paste our public schema into the left box, then paste your JSON document into the right to validate that it adheres to the schema.

---

Internal Schemas:

Internal Sale Advert JSON Schema Changelog

• Internal Sale Advert JSON Schema v1.2.0
• Internal Sale Advert JSON Schema v1.1.0
• Internal Sale Advert JSON Schema v1.0.0

---

Versioning (loosely) follows:

• SchemaVer
• Self-Describing JSON Schema
• Self-Describing JSONs