BAG API

get

Returns data from the Basic Registration of Addresses and Buildings (BAG) after entering the postal code and house number.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

postalCodestringRequired

Zipcode

Example: 1251NJ

houseNumberintegerRequired

House number

Example: 22

houseLetterstringOptional

House letter

houseNumberExtstringOptional

House number extention

Responses

200

BagDataResponse

application/json

statusCodeintegerRequiredExample: 200

isBase64EncodedbooleanRequiredExample: false

400

HTTP 400

application/json

401

HTTP 401

application/json

403

HTTP 403

application/json

404

HTTP 404

application/json

500

HTTP 500

application/json

get

/bag-data

HTTPcURLJavaScriptPython

GET /v1/bag-data?postalCode=1251NJ&houseNumber=22 HTTP/1.1
Host: api.matrixian.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200,
  "headers": {
    "Content-Type": "application/json"
  },
  "isBase64Encoded": false,
  "body": {
    "id": "string",
    "params": {
      "postalCode": "1251NJ",
      "houseNumber": "22"
    },
    "data": {
      "building": {
        "beginDate": "2018-12-06T00:00:00+00:00",
        "buildYear": 1955,
        "documentDate": "2018-12-06T00:00:00+00:00",
        "documentNumber": "2018-0887",
        "id": 417100000005928,
        "mutationDate": null,
        "noted": false,
        "status": "Pand in gebruik"
      },
      "numberDesignation": {
        "beginDate": "1954-12-24T00:00:00+00:00",
        "documentDate": "1954-12-24T00:00:00+00:00",
        "documentNumber": "L3286",
        "houseLetter": null,
        "houseNumber": 22,
        "houseNumberExtension": null,
        "id": 417200000001419,
        "mutationDate": null,
        "noted": false,
        "objectType": "Verblijfsobject",
        "postcode": "1251NJ",
        "relatedPublicSpace": "0417300000000061",
        "status": "Naamgeving uitgegeven"
      },
      "object": {
        "beginDate": "2018-12-06T00:00:00+00:00",
        "documentDate": "2018-12-06T00:00:00+00:00",
        "documentNumber": "2018-0887",
        "id": 417010001001419,
        "location": {
          "x": 144882.297,
          "y": 473885.719
        },
        "mutationDate": null,
        "noted": false,
        "relatedBuilding": 417100000005928,
        "relatedMainAddress": 417200000001419,
        "status": "Verblijfsobject in gebruik",
        "usePurpose": "woonfunctie",
        "useSurface": 131
      },
      "place": {
        "beginDate": "2009-03-25T00:00:00+00:00",
        "documentDate": "2009-03-25T00:00:00+00:00",
        "documentNumber": "200911",
        "id": "2890",
        "mutationDate": null,
        "name": "Laren",
        "noted": false,
        "status": "Woonplaats aangewezen"
      },
      "publicSpace": {
        "beginDate": "2010-09-28T00:00:00+00:00",
        "documentDate": "2010-09-28T00:00:00+00:00",
        "documentNumber": "-2.07.155.2",
        "id": "0417300000000061",
        "mutationDate": null,
        "name": "Graafland",
        "noted": false,
        "relatedPlace": "2890",
        "status": "Naamgeving uitgegeven"
      },
      "sourceHolder": {
        "id": "0417",
        "name": "Laren (NH.)"
      }
    },
    "error": {},
    "meta": {},
    "status": "success"
  }
}