Location Scores

POST location/scores

Returns scores for the specified location.

Request

Example Request 1

curl -X POST 'https://api.pricehubble.com/api/v1/location/scores' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "location": {
    "coordinates": {
      "latitude": 47.36925,
      "longitude": 8.531118
    }
  },
  "dossierId": "b2ca709a-b01d-4c60-b1a8-40c0b3b37d0a",
  "countryCode": "CH"
}'

Example Request 2

curl -X POST 'https://api.pricehubble.com/api/v1/location/scores' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "location": {
    "address": {
      "street": "Gerechtigkeitsgasse",
      "houseNumber": "19",
      "postCode": "8001",
      "city": "Zurich"
    }
  },
  "dossierId": "b2ca709a-b01d-4c60-b1a8-40c0b3b37d0a",
  "countryCode": "CH"
}'

Field	Description	Type	Remarks
location	Location for which information should be retrieved	Location
countryCode	ISO country code	string	Valid values are AT, BE, CH, CZ, DE, FR, JP, NL, SK and UK
dossierId	Unique id of dossier	string	Since overridden score are applied to dossier, dossierId should be provided to get overridden score value. Otherwise isOverridden will be set to false

Response

{
    "catering": 0.98,
    "family": 0.98,
    "health": 1,
    "leisure": 0.92,
    "location": 0.464,
    "noise": 0.546,
    "nuisance": 0.951,
    "shopping": 0.98,
    "view": 0.575,
    "scores": {
        "health": {
            "isOverridden": false,
            "originalScore": 1,
            "score": 1
        },
        "leisure": {
            "isOverridden": false,
            "originalScore": 0.92,
            "score": 0.92
        },
        "family": {
            "isOverridden": false,
            "originalScore": 0.98,
            "score": 0.98
        },
        "shopping": {
            "isOverridden": false,
            "originalScore": 0.98,
            "score": 0.98
        },
        "catering": {
            "isOverridden": false,
            "originalScore": 0.98,
            "score": 0.98
        },
        "view": {
            "isOverridden": false,
            "originalScore": 0.575,
            "score": 0.575
        },
        "noise": {
            "isOverridden": false,
            "originalScore": 0.546,
            "score": 0.546
        },
        "nuisance": {
            "isOverridden": false,
            "originalScore": 0.951,
            "score": 0.951
        },
        "location": {
            "isOverridden": false,
            "originalScore": 0.464,
            "score": 0.464
        }
    }
}

Field	Description	Type	Remarks
scores	Overridden scores response	object
scores.family	Family score	OverriddenScore
scores.location	Overall location score	OverriddenScore	Only available in CH
scores.noise	Noise score	OverriddenScore	Not available in JP
scores.nuisance	Nuisance score	OverriddenScore	Only available in CH
scores.shopping	Shopping score	OverriddenScore
scores.view	View score	OverriddenScore	Only available in CH
scores.catering	Catering score	OverriddenScore
scores.health	Health score	OverriddenScore
scores.leisure	Leisure score	OverriddenScore
family	Family score	Score	Always equals to originalScore. Deprecated since 2022-03-15. Use scores.family instead.
location	Overall location score	Score	Only available in CH. Always equals to originalScore. Deprecated since 2022-03-15. Use scores.location instead.
noise	Noise score	Score	Not available in JP. Always equals to originalScore. Deprecated since 2022-03-15. Use scores.noise instead.
nuisance	Nuisance score	Score	Only available in CH. Always equals to originalScore. Deprecated since 2022-03-15. Use scores.nuisance instead.
shopping	Shopping score	Score	Always equals to originalScore. Deprecated since 2022-03-15. Use scores.shopping instead.
view	View score	Score	Only available in CH. Always equals to originalScore. Deprecated since 2022-03-15. Use scores.view instead.
catering	Catering score	Score	Always equals to originalScore. Deprecated since 2022-03-15. Use scores.catering instead.
health	Health score	Score	Always equals to originalScore. Deprecated since 2022-03-15. Use scores.health instead.
leisure	Leisure score	Score	Always equals to originalScore. Deprecated since 2022-03-15. Use scores.leisure instead.