Fetch the encumbrances data of any property
GET/owners/encumbrances
Encumbrances Endpoint
Overview
This API fetches encumbrances ("heftelser") of a property or housing association unit based on a batch id, property id or housing association id.
It is also possible to filter by legal type code name or legal right type code name or a date range.
The API supports both single item retrieval and batch downloads.
If you want to maintain a local copy of this dataset, you can use the batch-id parameter to fetch the data in batches.
Once the full dataset is fetched, you can use the change-id-start and change-id-end parameters to fetch only the new and updated data.
Alternatively, you can use the updated-start-date and updated-end-date parameters to fetch new or updated data based on the document update date.
It returns data about encumbrances on a property or housing association unit. The data includes unique identifiers for the property and housing unit, legal right and type codes, document details (such as document number, year, and status), the associated amount, and whether any fees were paid.
Example Request
- Request with legal-type-code-name
curl -X 'GET' \
'https://apis.propcloud.no/api/public/owners/encumbrances?legal-type-code-name=SERVITUTT' \
-H 'accept: application/json' \
-H 'api-key: YOUR_API_KEY'
Response Description
| Key | Description | Beskrivelse | Source |
|---|---|---|---|
totalPages | The total number of pages of response for this specific query. | Totalt antall sider med respons for denne spesifikke forespørselen. | PropCloud |
batchId | Unique identifier for the batch | Unik identifikator for batchen | PropCloud |
housingAssociationIdNma | Unique identifier for the housing association unit, formatted as organization number-share number, i.e. "924758716-4" | Unik identifikator for borettslagsandelen, formatert som organisasjonsnummer-andelsnummer, i.e. "924758716-4" | PropCloud |
propertyIdNma | Unique identifier for the property, generated based on city number, ground number, and other details. | Unik identifikator for eiendommen generert basert paa kommunenummer, gaardsnummer og andre detaljer. | PropCloud |
legalRightId | Unique identifier for the legal right | Unik identifikator for rettsstiftelsen | Kartverket |
legalRightTypeId | Code value for the legal right type | Identifikator for rettsstiftelsestypen | Kartverket |
legalRightTypeCodeName | Name of the legal right type | Navnet paa rettsstiftelsestypen, f.eks. "UTLEGGSFORRETNING" | Kartverket |
legalTypeId | Code value for the legal type | Identifikator for rettstypen | Kartverket |
legalTypeCodeName | Name of the legal type | Navnet paa rettstypen, f.eks. "Tvangsforretning" | Kartverket |
documentId | Unique identifier for the document | Unik identifikator for dokumentet | Kartverket |
documentNumber | The document number | Dokumentnummeret | Kartverket |
documentYear | The year the document was issued | Aaret dokumentet ble opprettet | Kartverket |
timestamp | The exact datetime of when was the document was issued | Dato og tidspunk dokumentet ble opprettet | Kartverket |
documentStatusName | Status of the document | Dokumentstatus, f.eks. "Tinglyst" | Kartverket |
amount | The amount tied to the encumbrance | Heftelsens belop | Kartverket |
hasFee | Weather or not fees were paid | Hvorvidt heftelsen har gebyr | Kartverket |
feeAmount | The fee amount | Gebyrets storrelse | Kartverket |
changeType | This field indicates whether the document is a new entry or an updated entry, based on the LEGAL_RIGHT_ID. It helps differentiate between newly added documents and those that have been modified. | Dette feltet indikerer om dokumentet er en ny oppføring eller en oppdatert oppføring, basert på LEGAL_RIGHT_ID. Det hjelper med å skille mellom nylig tilføyde dokumenter og de som har blitt modifisert. | PropCloud |
changeId | This field represents the position of the document in the collection, essentially indicating it as the n-1th document. | Dette feltet representerer posisjonen til dokumentet, og indikerer det som det n-te dokumentet. | PropCloud |
updatedOn | This timestamp field records the date and time when the data was uploaded to MongoDB. | Dette tidsstempelfeltet registrerer datoen og klokkeslettet når dataene ble lastet opp til MongoDB. | PropCloud |
historical | Boolean value. "True" if there are more recent documents present for the object, "False" if this is the latest documents. | Boolean-verdi. "True" hvis det finnes nyere dokumenter for objektet, "False" hvis dette er de nyeste dokumentene. | Kartverket |
maxChangeId | Maksimal change id ("endringsid") i dataen. | Maksimal change id i samlingen. | PropCloud |
Request
Responses
- 200
- 422
Successful Response
Validation Error