Calcasa Public API v1
Project description
calcasa-api
The Calcasa API is used to connect to Calcasa provided services. This is the first production version of the service
Client packages
Client implementation notes
Clients should at all times be tolerant to the following:
- Extra fields in responses
- Empty or hidden fields in responses
- Extra values in enumerations
- Unexpected error responses in the form of Problem Details
OpenAPI Specification
This API is documented in OpenAPI format version 3 you can use tools like the OpenAPI Generator to generate API clients for for example the languages we don't provide a pre-built client for. This is documented here.
Changelog
2022-04-12 (v1.1.4)
- Added proper Content-Disposition headers to the
GET /v1/rapporten/{id}
andGET /v1/facturen/{id}
endpoints with the correct filename. - Fix Mime Types for the
GET /v1/configuratie/callbacks
andPOST /v1/configuratie/callbacks
endpoints to only beapplication/json
. - Fix C# API client to correctly use the
application/json-patch+json
content type in requests that require it. - Fix C# client's
FileParameter
type correct handling of response headers likeContent-Disposition
andContent-Type
. - Removed C# client's useless implementation of
IValidatableObject
. - Fix Python client's internal namespace name being illegal
calcasa-api
-> calcasa.api.
2022-03-22 (v1.1.3)
- Add 402 (Payment required) and 422 (Unprocessable entity) as potential response for
PATCH /v1/waarderingen/{id}
.
2022-03-17 (v1.1.2)
- Fixed response type for
GET /v1/geldverstrekkers/{productType}
endpoint.
2022-03-08 (v1.1.1)
- Added
GET /v1/geldverstrekkers/{productType}
endpoint. - Restored all
ProblemDetails
models.
2022-03-07 (v1.1.0)
- Added
isErfpacht
toWaarderingInputParameters
. - Cleaned up serialization of null values, they should no longer appear in the output.
2021-02-04
- Added extra clarification to the documentation pertaining to the
WaarderingInputParameters
and which fields are required for the different input parameter combinations.
2022-01-11 (v1.0.2)
- Fixed
GET /api/v1/bodem/{id}
endpoint path parameter description, query parameter was never meant to be there.
2021-12-23
- Clarified the documentation pertaining to the
WaarderingInputParameters
and which fields are required for the different product types.
2021-12-22 (v1.0.1)
- Dates are now serialized in the ISO date-only format
yyyy-MM-dd
to stop any confusion around timezones and are all assumed to be in UTC.peildatum
inWaarderingsInputParameters
datum_bestemmingplan
inBestemmingsdata
datum_laatste_onderzoek
inBodemdata
verkoopdatum
inReferentieobject
verkoopdatum
inVorigeVerkoop
waardebepalingsdatum
inModeldata
- Reintroduced the
WaarderingWebhookPayload
model that was omitted.
2021-12-21
- Patching the status of a
Waardering
object will now immediatly reflect its new status in the response object.
2021-12-13 (v1.0.0)
- Initial release of
v1
based onv0.0.6
Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
Authentication
Authentication is done via OAuth2 and the client credentials grant type.
Previous versions changelogs
2022-02-02
- API version
v0
was removed from service.
2021-12-23
- Mark
v0
as officially deprecated. No further versions will be released. Every implementation should move tov1
2021-12-10 (v0.0.6)
- Added extra field
peildatum
to theWaarderingInputParameters
model.
2021-11-25 (v0.0.5)
- Updated all reported OAuth2 scopes and reduced the superflous scope information on each endpoint.
2021-11-23 (v0.0.4)
- Added per square meter developments to the
WaarderingOntwikkeling
object (fields with thePerVierkantemeter
suffix).
2021-11-15 (v0.0.3)
- Added callback update and read endpoints and models.
- Updated documentation.
2021-11-11
- Renamed /fundering endpoint to /funderingen to be more in line with other endpoints
- Renamed
HerstelType
toFunderingHerstelType
. - Added
FunderingType
values.
2021-11-10
- Adjusted OpenAPI Spec generation to fix some issues with certain generators. This also means that the nullable nature of certain fields is now correctly represented. Please refer to the Generation article for more information, the config files were updated aswell.
2021-11-09
- Added
Status
andTaxatiedatum
toTaxatiedata
model.
2021-11-08
- Renamed
id
field inAdresInfo
model tobagNummeraanduidingId
. - Added
GET /v0/fundering/{id}
endpoint with corresponding models. - Changed HTTP response code for the
BusinessRulesProblemDetails
error return type ofPOST /v0/waardering
from422 Unprocessable Entity
to406 Not Acceptable
to fix a duplicate.
2021-10-13
- Added
taxatie
field toWaardering
model. - Added
Taxatiedata
model containing thetaxatieorganisatie
field for desktop valuations.
2021-09-29
- Added
aangemaakt
timestamp field toWaardering
model. - Added
WaarderingZoekParameters
model to replaceWaarderingInputParameters
in thePOST /v0/waarderingen/zoeken
endpoint. - Split
Omgevingsdata
model into a set of separateGebiedsdata
models that also contain extra statistics. - Added
bijzonderheden
field toVorigeVerkoop
model. - Renamed
ReferentieBijzonderheden
model toVerkoopBijzonderheden
.
2021-09-22
- Initial release of
v0
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.1.4
- Package version: 1.1.4
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.calcasa.nl/contact
Requirements.
Python >=3.6
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import calcasa.api
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import calcasa.api
Getting Started
Please follow the installation procedure and then run the following:
import time
import calcasa.api
from pprint import pprint
from calcasa.api.api import adressen_api
from calcasa.api.model.adres import Adres
from calcasa.api.model.adres_info import AdresInfo
from calcasa.api.model.not_found_problem_details import NotFoundProblemDetails
from calcasa.api.model.permissions_denied_problem_details import PermissionsDeniedProblemDetails
from calcasa.api.model.problem_details import ProblemDetails
# Defining the host is optional and defaults to https://api.calcasa.nl
# See configuration.py for a list of all supported configuration parameters.
configuration = calcasa.api.Configuration(
host = "https://api.calcasa.nl"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure OAuth2 access token for authorization: oauth
configuration = calcasa.api.Configuration(
host = "https://api.calcasa.nl"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with calcasa.api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = adressen_api.AdressenApi(api_client)
bag_nummeraanduiding_id = 1 # int | Een BAG Nummeraanduiding ID om een adres te specificeren.
try:
# Adres info op basis van BAG Nummeraanduiding Id.
api_response = api_instance.get_adres(bag_nummeraanduiding_id)
pprint(api_response)
except calcasa.api.ApiException as e:
print("Exception when calling AdressenApi->get_adres: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.calcasa.nl
Class | Method | HTTP request | Description |
---|---|---|---|
AdressenApi | get_adres | GET /api/v1/adressen/{bagNummeraanduidingId} | Adres info op basis van BAG Nummeraanduiding Id. |
AdressenApi | search_adres | POST /api/v1/adressen/zoeken | Zoek adres info op basis van het gegeven adres. |
BestemmingsplannenApi | get_bestemming_by_id | GET /api/v1/bestemmingsplannen/{bagNummeraanduidingId} | Gegevens over de bestemmingsplannen op de locatie van een adres (BAG Nummeraanduiding ID). |
BodemApi | get_bodem_by_id | GET /api/v1/bodem/{bagNummeraanduidingId} | Gegevens over de bodemkwaliteit op de locatie van een adres (BAG Nummeraanduiding ID). |
BuurtApi | get_buurt | GET /api/v1/buurt/{buurtId} | Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is. |
ConfiguratieApi | get_callbacks | GET /api/v1/configuratie/callbacks | Haal de geconfigureerde callback URL's op voor de huidige client. |
ConfiguratieApi | update_callbacks | POST /api/v1/configuratie/callbacks | Configureer callback URL voor een specifieke API versie voor de huidige client. |
FacturenApi | get_factuur | GET /api/v1/facturen/{id} | Factuur op basis van een waardering Id. |
FotosApi | get_foto | GET /api/v1/fotos/{id} | Foto op basis van een foto Id. |
FunderingenApi | get_fundering_by_id | GET /api/v1/funderingen/{bagNummeraanduidingId} | Gegevens over de fundering op de locatie van een adres (BAG Nummeraanduiding ID). |
GeldverstrekkersApi | get_geldverstrekkers | GET /api/v1/geldverstrekkers/{productType} | Alle geldverstrekkers die te gebruiken zijn voor aanvragen. |
RapportenApi | get_rapport | GET /api/v1/rapporten/{id} | Rapport op basis van waardering Id. |
WaarderingenApi | create_waardering | POST /api/v1/waarderingen | Creërt een waardering. |
WaarderingenApi | get_waardering | GET /api/v1/waarderingen/{id} | Waardering op basis van Id. |
WaarderingenApi | get_waardering_ontwikkeling | GET /api/v1/waarderingen/{id}/ontwikkeling | Waardering ontwikkeling op basis van waardering Id. |
WaarderingenApi | patch_waarderingen | PATCH /api/v1/waarderingen/{id} | Patcht een waardering. |
WaarderingenApi | search_waarderingen | POST /api/v1/waarderingen/zoeken | Zoek waardering op basis van input parameters. |
Documentation For Models
- Aanvraagdoel
- Adres
- AdresInfo
- Bestemmingsdata
- BodemStatusType
- Bodemdata
- BusinessRulesCode
- BusinessRulesProblemDetails
- Callback
- CbsIndeling
- Energielabel
- Factuur
- Foto
- FunderingDataBron
- FunderingHerstelType
- FunderingRisico
- FunderingRisicoLabel
- FunderingSoortBron
- FunderingType
- FunderingTypering
- Funderingdata
- Gebiedsdata
- Geldverstrekker
- HttpValidationProblemDetails
- InvalidArgumentProblemDetails
- JsonPatchDocument
- KlantwaardeType
- Kwartaal
- Modeldata
- NotFoundProblemDetails
- Notitie
- Notities
- Objectdata
- Omgevingsdata
- Operation
- OperationType
- PermissionsDeniedProblemDetails
- ProblemDetails
- ProductType
- Rapport
- Referentieobject
- ResourceExhaustedProblemDetails
- Taxatiedata
- Taxatiestatus
- ValidationProblemDetails
- VerkoopBijzonderheden
- VorigeVerkoop
- Waardering
- WaarderingInputParameters
- WaarderingOntwikkeling
- WaarderingOntwikkelingKwartaal
- WaarderingStatus
- WaarderingWebhookPayload
- WaarderingZoekParameters
- WoningType
Documentation For Authorization
oauth
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- all: Full permissions for all areas.
- api:all: Full permissions for all areas of the public API.
- api:bestemmingsplannen:all: Full permissions for the bestemmingsplannen area of the public API.
- api:bodem:all: Full permissions for the bodem area of the public API.
- api:buurt:all: Full permissions for the buurt area of the public API.
- api:configuratie:all: Full permissions for the configuratie area of the public API.
- api:facturen:all: Full permissions for the facturen area of the public API.
- api:fotos:all: Full permissions for the fotos area of the public API.
- api:funderingen:all: Full permissions for the funderingen area of the public API.
- api:rapporten:all: Full permissions for the rapporten area of the public API.
- api:waarderingen:all: Full permissions for the waarderingen area of the public API.
- api:adressen:read: Read permissions for the adressen area of the public API.
- api:bestemmingsplannen:read: Read permissions for the bestemmingsplannen area of the public API.
- api:bodem:read: Read permissions for the bodem area of the public API.
- api:buurt:read: Read permissions for the buurt area of the public API.
- api:configuratie:read: Read permissions for the configuratie area of the public API.
- api:configuratie:write: Write permissions for the configuratie area of the public API.
- api:facturen:read: Read permissions for the facturen area of the public API.
- api:fotos:read: Read permissions for the fotos area of the public API.
- api:funderingen:read: Read permissions for the funderingen area of the public API.
- api:geldverstrekkers:read: Read permissions for the geldverstrekkers area of the public API.
- api:rapporten:read: Read permissions for the rapporten area of the public API.
- api:waarderingen:create: Create permissions for the waarderingen area of the public API.
- api:waarderingen:patch: Patch permissions for the waarderingen area of the public API.
- api:waarderingen:read: Read permissions for the waarderingen area of the public API.
- api:waarderingen:ontwikkeling: Read permissions for the ontwikkelingen endpoint in the waarderingen area of the public API.
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in calcasa.api.apis and calcasa.api.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from calcasa.api.api.default_api import DefaultApi
from calcasa.api.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import calcasa.api
from calcasa.api.apis import *
from calcasa.api.models import *
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for calcasa_api-1.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51142e3569b83cf54d200e67561d153e2a6af101a046547479bff7e085aeaf99 |
|
MD5 | 66ad2d33bde21853a58fbcf07ded9ee0 |
|
BLAKE2b-256 | 2a0025f1a817442995f00128aec245cfc763046bde68f5691816334dbf4bd356 |