Wymmo GPT · GPT-Aktionen

{
  "openapi": "3.0.1",
  "info": {
    "title": "Wymmo Ai Plugin",
    "description": "Plugin to search for your next place to live in the ads for sale and rent in France, and in French !",
    "termsOfService": "https://wymmo.com/tos",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://api.wymmo.com/v2/ai_plugin"
    }
  ],
  "paths": {
    "/search": {
      "get": {
        "summary": "Look for a place to live in France",
        "operationId": "search",
        "parameters": [
          {
            "in": "query",
            "description": "Keyword based query containing some criteria to look for a place to live (in French !)",
            "name": "q",
            "examples": {
              "rentAFlatInParis18": {
                "value": "Appart, Location, Paris 18, 2 pièces, 50m2, 1000€"
              },
              "buyAHouseInLaRochelle": {
                "value": "Vente, Maison, La Rochelle (17000), 4 pièces, 100m2, max 400000€"
              },
              "buyATinyHouseInBriveLaGaillardeByZipCode": {
                "value": "Maison 19100"
              },
              "allFlatsToRentInLimoges": {
                "value": "Appartement en location, Limoges"
              },
              "allFlatsToRentInFrance": {
                "value": "Location Appart"
              }
            },
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The latest 10 results corresponding to the query",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "SearchResponse": {
        "type": "object",
        "required": [
          "humanSearchUrl",
          "sales",
          "rentals"
        ],
        "properties": {
          "humanSearchUrl": {
            "$ref": "#/components/schemas/Url"
          },
          "sales": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchedSale"
            }
          },
          "rentals": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchedRental"
            }
          }
        }
      },
      "SearchedSale": {
        "description": "Searched Sale",
        "type": "object",
        "required": [
          "adUrl",
          "title",
          "description",
          "specs",
          "locationHint"
        ],
        "properties": {
          "adUrl": {
            "$ref": "#/components/schemas/Url"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "price": {
            "description": "Price in euros",
            "type": "number",
            "format": "money"
          },
          "specs": {
            "$ref": "#/components/schemas/BuildingSpecs"
          }
        }
      },
      "SearchedRental": {
        "description": "Search rental",
        "type": "object",
        "required": [
          "adUrl",
          "title",
          "description",
          "rent",
          "specs",
          "locationHint"
        ],
        "properties": {
          "adUrl": {
            "$ref": "#/components/schemas/Url"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "rent": {
            "description": "rent in euros",
            "type": "number",
            "format": "money"
          },
          "specs": {
            "$ref": "#/components/schemas/BuildingSpecs"
          }
        }
      },
      "BuildingSpecs": {
        "description": "Building specifications",
        "type": "object",
        "required": [
          "buildingType",
          "heating",
          "energyAudit"
        ],
        "properties": {
          "buildingType": {
            "$ref": "#/components/schemas/BuildingType"
          },
          "livingArea": {
            "description": "Living area in square meters",
            "type": "number",
            "format": "area"
          },
          "roomsCount": {
            "type": "integer",
            "format": "uint16"
          },
          "landArea": {
            "description": "Land area in square meters",
            "type": "number",
            "format": "area"
          },
          "bedsCount": {
            "description": "Bedrooms count",
            "type": "integer",
            "format": "uint16"
          },
          "bathsCount": {
            "description": "Bathrooms count",
            "type": "integer",
            "format": "uint16"
          },
          "showersCount": {
            "description": "Shower rooms count",
            "type": "integer",
            "format": "uint16"
          },
          "floor": {
            "description": "Floor number of an apartment",
            "type": "integer",
            "format": "int16"
          },
          "floorsCount": {
            "description": "Floors count of the building",
            "type": "integer",
            "format": "uint16"
          },
          "builtYear": {
            "description": "Year the building was built",
            "type": "integer",
            "format": "uint16"
          },
          "brandNew": {
            "description": "Whether the building is brand new",
            "type": "boolean"
          },
          "terrace": {
            "description": "Whether the building has a terrace",
            "type": "boolean"
          },
          "swimmingPool": {
            "description": "Whether the building has a swimming pool",
            "type": "boolean"
          }
        }
      },
      "BuildingType": {
        "description": "Building types",
        "type": "string",
        "enum": [
          "House",
          "Apartment",
          "Building",
          "Shop",
          "Castle",
          "Unknown",
          "Office",
          "Mansion",
          "Tenement",
          "Warehouse",
          "Loft",
          "Parking",
          "Land",
          "Property",
          "Blueprint"
        ]
      },
      "Url": {
        "x-exclude-rust": true,
        "x-exclude-graphql": true,
        "type": "string",
        "description": "an Url",
        "format": "url",
        "example": "https://www.wymmo.com/search"
      }
    }
  }
}