KPN Internet Speed Check API

Introduction

Find out the maximum available upload and download speed for any given address in the Netherlands. Also get insight into the technologies (copper, bonded copper or fiber) that are available for an address.


Conceptual model

Conceptual model


API workflow

API workflow


How to...

Retrieve maximum internet speed and carrier type for an address

We are going to use this data as example data to call /offer endpoint (with a full path of https://api-prd.kpn.com/network/kpn/internet-speed-check/offer)

^^Request example^^
"service_address": {  
    "house_number":3,
    "zip_code":"3544ZE",
    "house_number_extension":""
}

Since it's a valid address, the alerts field will not be populated and the response will look like the following:

^^Response example^^
{
    "available_on_address": {
        "technologies": [
            {
                "name": "FIBER",
                "download": 500,
                "upload": 500,
            },
            {
                "name": "COPPER",
                "download": 16,
                "upload": 2,
            },
            {
                "name": "COPPER",
                "download": 12,
                "upload": 1,
            },
            {
                "name": "NoAccess",
                "download": 0,
                "upload": 0
            }
        ],
        "house_number_extensions": [],
    },
    "max_bandwidth": {
        "up": 500,
        "down": 500
    },
    "alerts": [],
}


Return codes

Code   Description
200   Success.
201   Created.
202   Accepted.
302   Found. Link in location header.
400   Bad request.
401   Unauthorized.
403   Forbidden.
404   Not found.
405   Method not allowed.
412   Precondition failed.
429   Too many requests.
500   Internal server error.
502   Bad gateway.
503   Service unavailable.