Queries

Important

All examples below are based on test data hence fictional and not related to real decisions made by municipal boards.

Authorisation

In order to access GraphQL API on huslejenaevn.dk, an API key is required. The API key must be provided as a custom HTTP Header named X-API-KEY such as:

X-API-KEY: a74b6864-aa0f-4ded-b626-f5cde4ba6759

Note

The above API key is not valid and just an example. Please contact naevn@sbst.dk for obtaining a valid API key. You will need to provide contact information and your purpose of access to these resources.

A valid API key authorise access to all resources on the GraphQL API endpoint, hence all query objects.

Query objects

The GraphQL API endpoint exposes six query objects:

Object	Description
addresses	Information about specific addresses where decisions have been made about level of rents.
decisions	Information about specific decisions made by municipal boards.
pagedAddresses	Paged object about addresses to improve performance when querying data.
pagedDecisions	Paged object about decisions to improve performance when querying data.
laws	Information about specific laws which are applicable for decisions made by municipal boards.
municipalities	Information about specific municipalities of Denmark.

It is highly recommended to use the paged query objects for addresses and decisions to improve performance and limit size of responses (payload).

Addresses

addresses and pagedAddresses provides information about addresses and their rent level (da: huslejeniveau) where decisions have been made by the Rent boards (da: huslejenævn) and Resident complaints boards (beboerklagenævn) in the municipalities of Denmark in accordance to level of rent. Level of rent for multiple addresses can be based on the same decision. Information about the specific decision are not available - such correlation are not allowed hence by design.

Decisions

decisions and pagedDecisions provides information about decisions (da: afgørelser) made by the Rent boards (da: huslejenævn) and Resident complaints boards (beboerklagenævn) in the municipalities of Denmark. A Decision can be based on multiple addresses. Information about addresses are not available - such correlation are not allowed hence by design.

Laws

laws provide information about laws (da: lovgivning) which are applicable for decisions made by municipal boards. Several laws are applicable as statutory basis (da: lovhjemmel) when municipal boards make formal decisions. Decisions are referenced to these laws.

Municipalities

municipalities provides information about municipalities of Denmark. Decisions are made by the Rent boards (da: huslejenævn) and Resident complaints boards (beboerklagenævn) boards in the municipalities of Denmark.

Pagination

Filtering

A example of a query for addresses where streetName should be filtrered to the fictional: "Korsbæk Ødevej":

query {
  addresses(where: { streetName: { contains: "Korsbæk Ødevej" } }) {
    bfeIdentifierForPieceOfLand
    bfeIdentifierForUnit
    designation
    district
    floorIdentifier
    id
    municipalityCode
    postalNumber
    streetBuildingIdentifier
    streetName
    suiteIdentifier
    supplementaryName
    rent {
      categoryOfRent
      dateOfRentDetermination
      declarationOfRent
      grossArea
      methodOfRentDetermination
      rent
    }
    coordinates {
      x
      y
    }
    municipalityName
  }
}

Which could return:

{
  "data": {
    "addresses": [
      {
        "bfeIdentifierForPieceOfLand": 6012666,
        "bfeIdentifierForUnit": null,
        "designation": "Korsbæk Ødevej 15, st. tv, 2300 København S",
        "district": "København S",
        "floorIdentifier": "st",
        "id": "39fdd618-7e0b-4df0-938c-6a10c2be1295",
        "municipalityCode": "0101",
        "postalNumber": 2300,
        "streetBuildingIdentifier": "15",
        "streetName": "Korsbæk Ødevej",
        "suiteIdentifier": "tv",
        "supplementaryName": "",
        "rent": {
          "categoryOfRent": "MONTHLY_RENT",
          "dateOfRentDetermination": "2015-02-04T10:55:05.729+01:00",
          "declarationOfRent": "TENANCY_SPECIFIC_RENT",
          "grossArea": 109,
          "methodOfRentDetermination": "BASED_ON_COMPARABLE_RENTS",
          "rent": 10910
        },
        "coordinates": {
          "x": 12.612525939941406,
          "y": 55.645957946777344
        },
        "municipalityName": "Københavns Kommune"
      }
    ]
  }
}

Sorting