Skip to content

active ads

leesideas edited this page Nov 20, 2024 · 3 revisions

Description:
This endpoint allows users to search for active property ads across multiple broker systems. It retrieves a consolidated list of active ads and provides URLs linking directly to each ad on the respective broker's platform.

Parameters

Field Example
street_name Drottninggatan
street_number 12B
apartment_number 1001
postcode 111 51
city Stockholm
municipality Stockholm Kommun
country Sweden

Method: GET

Response:

  • 200 OK: Returns a JSON array of ads, each containing details such as title, description, and a direct URL to the listing.
  • Example Response:
{
  "ads": [
    {
      "address": {
        "street_name": "Drottninggatan",
        "street_number": "12B",
        "apartment_number": "1001",
        "postcode": "111 51",
        "city": "Stockholm",
        "municipality": "Stockholm Kommun",
        "country": "Sweden"
      },
      "url": "https://examplebroker.com/ad/12345"
    },
    {
      "address": {
        "street_name": "Kungsgatan",
        "street_number": "45A",
        "apartment_number": null,
        "postcode": "411 15",
        "city": "Gothenburg",
        "municipality": "Göteborgs Kommun",
        "country": "Sweden"
      },
      "url": "https://anotherbroker.com/ad/67890"
    }
  ]
}

Clone this wiki locally