Fetch market activity summary for a specific area.

POST 
/map-layer/market-activity/summary

Market Activity Summary Endpoint

Overview

This API fetches the activity of the market in certain geographic area and lets the user know what type of property is being sold for which price. This API returns a summary of that data. Use geojson for generating the coordinates in a geojson format.

Parameters

Parameter	Type	Required	Description
bbox	list[list[list[float]]]	Yes	A geojson data that contains the coordinates of a geometry
property-type	list[integer]	Yes	The property type for which the data is recorded. It is expected to be a list of integers, where the values represent, 0: 'leilighet', 1: 'enebolig', 2: 'tomannsbolig', 3: 'rekkehus', 4: 'fritidsbolig'.
market-activity-type	list[integer]	Yes	The market activity type for which the data is recorded. It is expected to be a list of integers, where the values represent, 0: 'OPM_TRANSACTION', 1: 'AD', 2: 'FOR_SALE', 3: 'OTHER_TRANSACTION'. Here OPM_TRANSACTION means Open Market Transaction meaning valid transactions, AD means this advertisement is not live/active for sale anymore, FOR_SALE means they are currently live/active for sale, OTHER_TRANSACTION did not happen in open market.
time-period	string	Yes	For last how many days of data should be fetched. The values can be '3 mo', '6 mo', '1 yr', '2 yr', '3 yr', '4 yr', '5 yr', '10 yr'.
bra	object	Yes	Object containing 2 values, min and max. Example: { "min": 0, "max": 100 }
price	object	Yes	Object containing 2 values, min and max. Example: { "min": 0, "max": 100 }

Headers

Header	Value
accept	application/json
api-key	YOUR_API_KEY

Example Request

curl -X 'POST' \
  'https://apis.propcloud.no/api/public/map-layer/market-activity/summary' \
  -H 'accept: application/json' \
  -H 'api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "bbox": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          10.776086561681458,
          59.9028339763978
        ],
        [
          10.781317878721966,
          59.9028339763978
        ],
        [
          10.781317878721966,
          59.90083870179467
        ],
        [
          10.776086561681458,
          59.90083870179467
        ],
        [
          10.776086561681458,
          59.9028339763978
        ]
      ]
    ]
  },
  "property-type": [
    0,
    1,
    2,
    3,
    4
  ],
  "market-activity-type": [
    0,
    1,
    2,
    3
  ],
  "time-period": "3 mo",
  "bra": {
    "min": 0,
    "max": 100
  },
  "price": {
    "min": 10000,
    "max": 10000000
  }
}'

Request

Responses

200

Successful Response

422

Validation Error