Skip to content

Queries

kluknowledgecube edited this page Aug 7, 2024 · 20 revisions

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 query object.

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 rent.
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

Decisions

Laws

Municipalities

Clone this wiki locally