{
  "openapi": "3.0.1",
  "info": {
    "title": "French Property Sale Prices (DVF) – Sales, €/m² & Valuations",
    "description": "Official French property sale prices (DVF, up to mid-2026): one clean row per sale with price per m², area statistics and trends, and automated valuations from comparable sales for any address.",
    "version": "0.1",
    "x-build-id": "4jRINF7bdk9hlLOaJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/yck69~french-property-prices/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-yck69-french-property-prices",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/yck69~french-property-prices/runs": {
      "post": {
        "operationId": "runs-sync-yck69-french-property-prices",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/yck69~french-property-prices/run-sync": {
      "post": {
        "operationId": "run-sync-yck69-french-property-prices",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What do you want?",
            "enum": [
              "sales",
              "stats",
              "valuation"
            ],
            "type": "string",
            "description": "<b>Sales</b>: one row per sale with price, €/m², areas, rooms, address and GPS.<br><b>Price statistics</b>: median price and €/m² by commune, postal code, year, quarter, month, type or rooms, with trends.<br><b>Valuation</b>: an estimated price range for one or many properties, from comparable sales nearby.",
            "default": "sales"
          },
          "address": {
            "title": "Address",
            "type": "string",
            "description": "Any French address, e.g. <code>12 rue de la République, Lyon</code>. Sales within the radius are returned. Also the property to value in Valuation mode."
          },
          "radiusKm": {
            "title": "Radius (km)",
            "minimum": 0.05,
            "maximum": 20,
            "type": "number",
            "description": "Up to 20 km around the address.",
            "default": 1
          },
          "latitude": {
            "title": "Latitude",
            "type": "number",
            "description": "Instead of an address."
          },
          "longitude": {
            "title": "Longitude",
            "type": "number",
            "description": "Instead of an address."
          },
          "communes": {
            "title": "Communes",
            "type": "array",
            "description": "Names or INSEE codes, e.g. <code>Bordeaux</code>, <code>Paris</code> (all arrondissements), <code>69381</code>.",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "type": "array",
            "description": "e.g. <code>75011</code>.",
            "items": {
              "type": "string"
            }
          },
          "departments": {
            "title": "Departments",
            "type": "array",
            "description": "e.g. <code>33</code>, <code>2A</code>. DVF doesn't cover Alsace-Moselle (57, 67, 68) or Mayotte.",
            "items": {
              "type": "string"
            }
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Default: apartments and houses.",
            "items": {
              "type": "string",
              "enum": [
                "apartment",
                "house",
                "land",
                "commercial",
                "outbuilding",
                "multiple_dwellings",
                "mixed"
              ],
              "enumTitles": [
                "Apartment",
                "House",
                "Land only",
                "Commercial premises",
                "Outbuilding only (parking, cellar…)",
                "Several dwellings (building)",
                "Dwelling + commercial"
              ]
            },
            "default": [
              "apartment",
              "house"
            ]
          },
          "saleTypes": {
            "title": "Sale types",
            "type": "array",
            "description": "Default: regular sales and new builds (VEFA).",
            "items": {
              "type": "string",
              "enum": [
                "sale",
                "new_build",
                "auction",
                "building_land",
                "exchange",
                "expropriation"
              ],
              "enumTitles": [
                "Sale",
                "New build (VEFA)",
                "Auction",
                "Building land",
                "Exchange",
                "Expropriation"
              ]
            },
            "default": [
              "sale",
              "new_build"
            ]
          },
          "dateFrom": {
            "title": "Sold after",
            "type": "string",
            "description": "A date (<code>2025-01-01</code>) or a duration (<code>2 years</code>)."
          },
          "dateTo": {
            "title": "Sold before",
            "type": "string",
            "description": "A date or a duration."
          },
          "minPrice": {
            "title": "Minimum price (€)",
            "type": "integer",
            "description": "Sale price."
          },
          "maxPrice": {
            "title": "Maximum price (€)",
            "type": "integer",
            "description": "Sale price."
          },
          "minLivingArea": {
            "title": "Minimum living area (m²)",
            "type": "number",
            "description": "Built living area of the dwellings sold."
          },
          "maxLivingArea": {
            "title": "Maximum living area (m²)",
            "type": "number",
            "description": "Built living area of the dwellings sold."
          },
          "minRooms": {
            "title": "Minimum rooms",
            "type": "integer",
            "description": "Main rooms (pièces principales)."
          },
          "maxRooms": {
            "title": "Maximum rooms",
            "type": "integer",
            "description": "Main rooms."
          },
          "minLandArea": {
            "title": "Minimum land (m²)",
            "type": "number",
            "description": "Land area sold."
          },
          "maxLandArea": {
            "title": "Maximum land (m²)",
            "type": "number",
            "description": "Land area sold."
          },
          "minPricePerM2": {
            "title": "Minimum €/m²",
            "type": "integer",
            "description": "Only single-dwelling sales have a price per m²."
          },
          "maxPricePerM2": {
            "title": "Maximum €/m²",
            "type": "integer",
            "description": "Only single-dwelling sales have a price per m²."
          },
          "excludeOutliers": {
            "title": "Exclude symbolic and abnormal prices",
            "type": "boolean",
            "description": "Removes sales under €1,000 (symbolic or family transfers) and prices per m² outside €300–30,000.",
            "default": true
          },
          "sortBy": {
            "title": "Sort sales by",
            "enum": [
              "date",
              "distance",
              "price",
              "pricePerM2"
            ],
            "type": "string",
            "description": "Default: distance for address searches, newest first otherwise."
          },
          "groupBy": {
            "title": "Statistics by",
            "enum": [
              "year",
              "quarter",
              "month",
              "commune",
              "postalCode",
              "department",
              "propertyType",
              "rooms"
            ],
            "type": "string",
            "description": "Time groupings include the change in median €/m² from one period to the next.",
            "default": "year"
          },
          "valuationType": {
            "title": "Property type",
            "enum": [
              "apartment",
              "house"
            ],
            "type": "string",
            "description": "Apartment or house.",
            "default": "apartment"
          },
          "livingArea": {
            "title": "Living area (m²)",
            "type": "number",
            "description": "Required for a valuation."
          },
          "rooms": {
            "title": "Rooms",
            "type": "integer",
            "description": "Optional: comparable sales with the same number of rooms count more."
          },
          "landArea": {
            "title": "Land (m²)",
            "type": "number",
            "description": "Optional, for houses: sales with similar land count more."
          },
          "properties": {
            "title": "Several properties (bulk valuation)",
            "type": "array",
            "description": "A list like <code>[{\"address\": \"…\", \"propertyType\": \"house\", \"livingArea\": 120, \"rooms\": 5, \"landArea\": 600}]</code>. One valuation per item."
          },
          "monthsBack": {
            "title": "Use sales from the last … months",
            "minimum": 6,
            "maximum": 60,
            "type": "integer",
            "description": "Comparable sales period, counted back from the most recent data.",
            "default": 24
          },
          "includeNewBuilds": {
            "title": "Include new builds (VEFA) as comparables",
            "type": "boolean",
            "description": "New builds sell at a premium; turn on when valuing a new property.",
            "default": false
          },
          "maxComparables": {
            "title": "Comparable sales to list",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "The most relevant comparable sales are listed with each valuation.",
            "default": 10
          },
          "maxResults": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Sales, statistics rows or valuations.",
            "default": 100
          },
          "countOnly": {
            "title": "Count only (free preview)",
            "type": "boolean",
            "description": "Count matching sales and give their median €/m². Nothing is charged.",
            "default": false
          },
          "refreshCache": {
            "title": "Rebuild data cache (maintainer only)",
            "type": "boolean",
            "description": "Maintenance: rebuilds the pre-processed DVF files. Only works for the Actor's maintainer.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}