zipcode()

The Basic Broadband API

The zipcode() function is used to query for the technologies and maximum speeds available at a given address.

Given a location it provides you with a list of all technologies and speeds that Nextpertise can deliver on that address.

Production URL:

https://api.nextpertise.nl/broadband/basic/v1

Testing URL:

https://api.nextpertise.nl/test/broadband/basic/v1 See Testing for more information.

Method

zipcode

Input

Zipcode request v1

https://api.nextpertise.nl/schemas/broadband/basic/zipcode_request_v1.json

Requests an overview of the products available on a specific location.

Location

Output

Zipcode reply v1

https://api.nextpertise.nl/schemas/broadband/basic/zipcode_reply_v1.json

Provides an overview of the technologies and maximum speeds available at a specific location.

type

object

properties

  • available

Provides per access technology the maximum speed (kb/s) and an optional area code.

type

object

patternProperties

  • KPNWBA | KPNWEAS | TELE2 | EUROFIBER | ZIGGO

Lines

additionalProperties

False

  • address

anyOf

Extended address

allOf

Location

Extended location

  • error

type

object

patternProperties

  • KPNWBA | KPNWEAS | TELE2 | EUROFIBER | ZIGGO

type

object

properties

  • message

type

string

  • code

type

integer

additionalProperties

False

Example

Request

curl -H <key> https://api.nextpertise.nl/broadband/basic/v1 -d'{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "zipcode",
    "params": {
        "zipcode": "####xx",
        "housenr": #
    }
}' | jq .

Reply

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "available": {
            "KPNWBA": {
                "ADSL": {
                    "distance": "",
                    "carrier": "Copper",
                    "max_upload": 20000,
                    "max_download": 2000,
                    "area": ""
                },
                "Fiber": {
                    "distance": "",
                    "carrier": "Fiber",
                    "max_upload": 100000,
                    "max_download": 100000,
                    "area": "FttH"
                },
                "SDSL": {
                    "distance": "",
                    "carrier": "Copper",
                    "max_upload": 2304,
                    "max_download": 2304,
                    "area": ""
                }
            },
            "KPNWEAS": {
                "Fiber": {
                    "distance": "NEARNET_WITHOUT",
                    "carrier": "Fiber",
                    "max_upload": 1024000,
                    "max_download": 1024000,
                    "area": "B"
                }
            },
            "TELE2": {
                "SDSL.bis": {
                    "distance": "Nearnet",
                    "carrier": "Copper",
                    "max_upload": 6144,
                    "max_download": 1024,
                    "area": "4"
                },
                "Fiber": {
                    "distance": "Nearnet",
                    "carrier": "Fiber",
                    "max_upload": 1024000,
                    "max_download": 1024000,
                    "area": "4"
                }
            }
        },
        "address": {
            "city": "xxxxxx",
            "housenr": 7,
            "street": "xxxxxxx",
            "zipcode": "####XX",
            "housenrext": null,
            "province": "xxxxxxx",
            "municipality": "xxxxxxx",
            "longitude": "#.#######",
            "latitude": "##.#######"
        }
    }
}

Error Handling

In case a provider produces an error when processing a request an error key is added. A list of possible error messages is found at Error codes.

Request

curl -H <key> https://api.nextpertise.nl/broadband/basic/v1 -d'{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "zipcode",
    "params": {
        "zipcode": "2408ZE",
        "housenr": 10,
        "housenrext": "A"
    }
}' | jq .

Reply

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "available": {
            "KPNWBA": {
                "Fiber": {
                    "max_upload": 102400,
                    "max_download": 102400,
                    "carrier": "Fiber",
                    "area": "FttH",
                    "distance": ""
                }
            },
            "EUROFIBER": {
                "Fiber": {
                    "max_upload": 512000,
                    "distance": "Dist: 81m",
                    "carrier": "Fiber",
                    "max_download": 512000,
                    "area": ""
                }
            },
            "TELE2": {
                "SDSL.bis": {
                    "max_upload": 4096,
                    "max_download": 4096,
                    "carrier": "Copper",
                    "distance": "Nearnet",
                    "area": "4"
                },
                "Fiber": {
                    "max_upload": 1024000,
                    "max_download": 1024000,
                    "carrier": "Fiber",
                    "distance": "Nearnet",
                    "area": "4"
                }
            }
        },
        "error": {
            "KPNWEAS": {
                "message": "002: Invalid zipcode/housenr combination: (2408ZE,10,A).",
                "code": 2
            }
        },
        "address": {
            "housenr": 10,
            "city": "Alphen aan den Rijn",
            "street": "Zuidpoolsingel",
            "zipcode": "2408ZE",
            "housenrext": "A"
        }
    }
}