---
agentTools:
  projectIndex: https://floorplanner.readme.io/llms.txt
---

# Search listings by address

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Basic AUTH",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://floorplanner.com/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/funda/mediasuppliers/search.json": {
      "get": {
        "summary": "Search listings by address",
        "description": "",
        "operationId": "search-address",
        "parameters": [
          {
            "name": "house_number_extension",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "office_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "house_number",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "postal_code",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\":\"6034aff6-4154-42c1-b1cf-e40e27cf97d6\",\n  \"postalCode\":\"9712 AD\",\n  \"houseNumber\":18,\n  \"houseNumberExtension\":\"\",\n  \"street\":\"Hoge der A\",\n  \"city\":\"Groningen\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "6034aff6-4154-42c1-b1cf-e40e27cf97d6"
                    },
                    "postalCode": {
                      "type": "string",
                      "example": "9712 AD"
                    },
                    "houseNumber": {
                      "type": "integer",
                      "example": 18,
                      "default": 0
                    },
                    "houseNumberExtension": {
                      "type": "string",
                      "example": ""
                    },
                    "street": {
                      "type": "string",
                      "example": "Hoge der A"
                    },
                    "city": {
                      "type": "string",
                      "example": "Groningen"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{ \"message\": \"listing not permitted\" }"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "listing not permitted"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{ \"message\": \"listing not found\" }"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "listing not found"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "61e58fa0f5195f0042438c8a:686cefd7140d20001137abbe"
}
```