Get started

    API Endpoint

        https://api.quprawholesale.com/

With the Qupra availability plugin it’s very easy to display an internet availabillity tool on you website. Visitors can use this tool to search on their zipcode and housenumber and see what’s available on their adres. The availabillity plugin of Qupra contans result of the copper network (DSL), FTTH (Fiber To the Home), FTTO (Fiber To The Office), Nation wide Business Fiber network and local fiber initiatives.

The Qupra availabillity plugin can easily be customized by changing the colors, adding a company name and personalization of the confirmation email so it blends into the website.

The Qupra availabillity plugin can be used by customers of Qupra Wholesale or with an free- or paid licence from Qupra

Check your Package and limit


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/limit/check \
-H 'Authorization=Bearer your_api_key' \

To your plan and daily limit, you need to make a POST call to the following url :
https://api.quprawholesale.com/limit/check


Result example :

{
    "used": 0,
    "remaining": 200,
    "limit": 200,
    "package": "Gold"
}

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.

Lookup for Network Providers


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/provider/lookup \
-H 'Authorization=Bearer your_api_key' \
-F 'HouseNr=20' \
-F 'Zipcode=1011JM' \
-F 'HouseNrExt=NULL' \

To get the search results for network providers, you need to make a POST call to the following url :
https://api.quprawholesale.com/provider/lookup


Result example :

{
    "street": "Staalstraat",
    "HouseNr": "20",
    "Zipcode": "1011JM",
    "City": "Amsterdam",
    "Municipal": "Amsterdam",
    "Province": "Noord-Holland",
    "Latitude": "52.3682035",
    "Longitude": "4.8974064",
    "available": [
        {
            "Provider": "TELE2",
            "Type": "SDSL.bis",
            "Carrier": "Copper",
            "MaxUpload": 15360,
            "MaxDownload": 15360
        },
        {
            "Provider": "TELE2",
            "Type": "Fiber",
            "Carrier": "Fiber",
            "Distance": "Nearnet",
            "Area": "4",
            "MaxUpload": 1024000,
            "MaxDownload": 1024000
        },
        {
            "Provider": "KPNWBA",
            "Type": "ADSL",
            "Carrier": "Copper",
            "MaxUpload": 976,
            "MaxDownload": 14437
        },{...}
    ]
}

Result with including pricings:

{
    "street": "Hoogoorddreef",
    "HouseNr": "71",
    "HouseNrExt": "A",
    "Zipcode": "1101BB",
    "City": "Amsterdam",
    "Municipal": "Amsterdam",
    "Province": "Noord-Holland",
    "Latitude": "52.3066692",
    "Longitude": "4.9394858",
    "available": [
        {
            "Provider": "ZIGGO",
            "Type": "Fiber",
            "Carrier": "Fiber",
            "Distance": "219m",
            "MaxUpload": 1024000,
            "MaxDownload": 1024000,
            "pricing": [
                {
                    "id": 14,
                    "Provider": "Ziggo",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": null,
                    "MaxUpload": 1024000,
                    "MaxDownload": 1024000,
                    "MonthlyPricing": "1029",
                    "OneOffPricing": "1250",
                    "Note": "1GB"
                },
                {
                    "id": 15,
                    "Provider": "Ziggo",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": null,
                    "MaxUpload": 102400,
                    "MaxDownload": 102400,
                    "MonthlyPricing": "229",
                    "OneOffPricing": "1250",
                    "Note": "100 MB"
                },
                {
                    "id": 16,
                    "Provider": "Ziggo",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": null,
                    "MaxUpload": 204800,
                    "MaxDownload": 204800,
                    "MonthlyPricing": "329",
                    "OneOffPricing": "1250",
                    "Note": "200 MB"
                },
                {
                    "id": 17,
                    "Provider": "Ziggo",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": null,
                    "MaxUpload": 512000,
                    "MaxDownload": 512000,
                    "MonthlyPricing": "529",
                    "OneOffPricing": "1250",
                    "Note": "500 MB"
                }
            ]
        },
        {
            "Provider": "ForeFreedom",
            "Type": "Fiber",
            "Carrier": "Fiber",
            "Distance": "Onnet",
            "Area": "",
            "MaxUpload": "1024000",
            "MaxDownload": "1024000",
            "pricing": [
                {
                    "id": 10,
                    "Provider": "ForeFreedom",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": "Onnet",
                    "MaxUpload": 1024000,
                    "MaxDownload": 1024000,
                    "MonthlyPricing": "1029",
                    "OneOffPricing": "1250",
                    "Note": "1GB"
                },
                {
                    "id": 11,
                    "Provider": "ForeFreedom",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": "Onnet",
                    "MaxUpload": 102400,
                    "MaxDownload": 102400,
                    "MonthlyPricing": "229",
                    "OneOffPricing": "1250",
                    "Note": "100 MB"
                },
                {
                    "id": 12,
                    "Provider": "ForeFreedom",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": "Onnet",
                    "MaxUpload": 204800,
                    "MaxDownload": 204800,
                    "MonthlyPricing": "329",
                    "OneOffPricing": "1250",
                    "Note": "200 MB"
                },
                {
                    "id": 13,
                    "Provider": "ForeFreedom",
                    "Type": "Fiber",
                    "Area": null,
                    "Carrier": "Fiber",
                    "Distance": "Onnet",
                    "MaxUpload": 512000,
                    "MaxDownload": 512000,
                    "MonthlyPricing": "529",
                    "OneOffPricing": "1250",
                    "Note": "500 MB"
                }
            ]
        }
    ]
}

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
HouseNr	String	(Required) House number field
Zipcode	String	(Required) Zipcode field
HouseNrExt	String	(Required) can be set as NULL if extension is not available.
filter	String (comma separeted values)	(optional) Filter can be used to get specific list of providers
Filter values can be KPNWBA, Tele2, Ziggo, EuroFiber, WauWau, Blackgate, DeltaFiber, SchipholConnect, ForeFreedom, FiberRevolution, XLFiber

Pricing information is only available with verified API users. Please contact support@quprawholesale.com to grant access.

Lookup for Companies


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/company/lookup \
-H 'Authorization=Bearer your_api_key' \
-F 'search=text' \

To get the search results for companies, you need to make a POST call to the following url :
https://api.quprawholesale.com/company/lookup


Result example :

[
    {
        "ID": "792321",
        "CompanyName 1": "Bijekic Beheer B.V.",
        "CompanyName 2": "",
        "CompanyName 3": "",
        "CompanyName 4": "",
        "CompanyName 5": "",
        "Street": "Malrovedonk",
        "HouseNr": "4",
        "HouseNrExt": "",
        "PostalCode": "3206BN",
        "City": "SPIJKENISSE",
        "PhoneNumber": "06-21504391",
        "KvkNr": "625119710000",
        "KvkResidenceNr": "000031512933",
        "Website": "",
        "EmailAddress": "",
        "Branch": "Financi‰le holdings",
        "Employees": "1 werknemer",
        "LegalForm": "Besloten Vennootschap",
        "FoundingYear": "2015"
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
search	String	(Required) any values

Extensive Lookup


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/ext/lookup \
-H 'Authorization=Bearer your_api_key' \
-F 'HouseNr=4' \
-F 'Zipcode=3206BN' \
-F 'HouseNrExt=NULL' \
-F 'company=Brandveiligheid' \

To get the search results for network providers, you need to make a POST call to the following url :
https://api.quprawholesale.com/ext/lookup


Result example :

{
    "street": "Malrovedonk",
    "HouseNr": "4",
    "Zipcode": "3206BN",
    "City": "Spijkenisse",
    "Municipal": "Nissewaard",
    "Province": "Zuid-Holland",
    "Latitude": "51.8320838",
    "Longitude": "4.3243366",
    "available": [
        {
            "Provider": "TELE2",
            "Type": "SDSL.bis",
            "Carrier": "Copper",
            "MaxUpload": 10240,
            "MaxDownload": 10240
        },
        {
            "Provider": "TELE2",
            "Type": "Fiber",
            "Carrier": "Fiber",
            "Distance": "Nearnet",
            "Area": "4",
            "MaxUpload": 1024000,
            "MaxDownload": 1024000
        },
        {
            "Provider": "KPNWEAS",
            "Type": "SDSL.bis",
            "Carrier": "Copper",
            "Distance": "Onnet",
            "MaxUpload": 20480,
            "MaxDownload": 20480
        },
        {
            "Provider": "KPNWBA",
            "Type": "BVDSL",
            "Carrier": "Copper",
            "MaxUpload": 64188,
            "MaxDownload": 216249
        },
        {
            "Provider": "KPNWBA",
            "Type": "VDSL",
            "Carrier": "Copper",
            "MaxUpload": 32094,
            "MaxDownload": 108125
        },
        {
            "Provider": "KPNWBA",
            "Type": "ADSL",
            "Carrier": "Copper",
            "MaxUpload": 976,
            "MaxDownload": 20279
        }
    ],
    "Buildinginformation": {
        "Building_Purpose": "woonfunctie",
        "Floor_Surface": "109"
    },
    "ean": {
        "GAS": [
            {
                "EANCodeConnection": "871689290401961346",
                "SystemOperatorName": "Stedin NB"
            }
        ]
    },
    "Companies": {
        "company_name": "Lemaro Brandveiligheid Inspecties B.V.",
        "KvK": "626781400000",
        "KvKResidenceNr": "000031665756"
    }
}

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
HouseNr	String	(Required) House number field
Zipcode	String	(Required) Zipcode field
HouseNrExt	String	(Required) can be set as NULL if extension is not available.
company	String	(Optional) company name.

Search House Numbers


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/search/address/gethousenumbers \
-H 'Authorization=Bearer your_api_key' \
-F 'zipcode=9903BS' \

To get the search results for house numbers, you need to make a POST call to the following url :
https://api.quprawholesale.com/search/address/gethousenumbers


Result example :

[
    {
        "zipcode": "9903BS",
        "houseNr": "35",
        "houseNrExt": "a"
    },
    {
        "zipcode": "9903BS",
        "houseNr": "37",
        "houseNrExt": "a"
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
zipcode	String	(Required) Zipcode field

Search House Number Extensions


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/search/address/gethousenumberadd \
-H 'Authorization=Bearer your_api_key' \
-F 'zipcode=9903BS' \
-F 'houseNr=37' \

To get the search results for house numbers extensions, you need to make a POST call to the following url :
https://api.quprawholesale.com/search/address/gethousenumberadd


Result example :

[
    {
        "houseNr": "37",
        "houseNrExt": "a",
        "zipcode": "9903BS"
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
zipcode	String	(Required) Zipcode field
houseNr	String	(Required) House number field

Search Zipcode


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/search/address/getzipcode \
-H 'Authorization=Bearer your_api_key' \
-F 'streetName=Klaverstraat' \
-F 'houseNr=37' \
-F 'houseNrExt=a' \
-F 'city=Appingedam' \

To get the search results for postcodes, you need to make a POST call to the following url :
https://api.quprawholesale.com/search/address/getzipcode


Result example :

[
    {
        "zipcode": "9903BS",
        "destination": "woonfunctie",
        "houseNr": "37",
        "houseNrExt": "a",
        "streetName": "Klaverstraat",
        "city": "Appingedam"
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
streetName	String	(Required)
houseNr	String	(Required) House number field
houseNrExt	String	(Required)
city	String	(Required)

Search Address


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/search/address/getaddress \
-H 'Authorization=Bearer your_api_key' \
-F 'zipcode=9903BS' \
-F 'houseNr=37' \
-F 'houseNrExt=a' \

To get the search results for Addresses, you need to make a POST call to the following url :
https://api.quprawholesale.com/search/address/getaddress


Result example :

[
    {
        "streetName": "Klaverstraat",
        "destination": "woonfunctie",
        "houseNr": "37",
        "houseNrExt": "a",
        "zipcode": "9903BS"
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
zipcode	String	(Required) Zipcode field
houseNr	String	(Required) House number field
houseNrExt	String	(Required)

Search Registered Number


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/search/number \
-H 'Authorization=Bearer your_api_key' \
-F 'phone=0786830012' \
OR
-F 'search=kpn' \
OR
-F 'status=status' \

To get the search results for registered numbers, you need to make a POST call to the following url :
https://api.quprawholesale.com/search/number


Result example :

{
    "totalRecords": "1",
    "records": [
        {
            "id": 3356,
            "apiCode": 1,
            "RequestNumber": "100186",
            "NumberType": "transitnetwerk signaleringspuntcode (TSPC)",
            "AssignDate": "1998-07-19T19:00:00.000Z",
            "AssignEndDate": null,
            "NumberPrefix": null,
            "NumberStatus": "Toegekend",
            "NumberRangeEnd": "0-034-3",
            "NumberRangeStart": "0-034-3",
            "City": "ROTTERDAM",
            "Company": "KPN B.V.",
            "LastChangeDate": "2006-03-22T09:12:00.000Z",
            "RelationID": "200266",
            "KVK": "27124701",
            "KvkResidence": "16430921"
        }
    ]
}

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
phone	Number	(Required)
OR
search	String	(Required)
OR
status	String	(Required)
limit	number	(Optional) default is 10
offset	number	(Optional) default is 0

HLR Lookup


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/get/info/numberinfo \
-H 'Authorization=Bearer your_api_key' \
-F 'number=0888000800' \
-F 'country=NL' \

To get the search results for HLR numbers, you need to make a POST call to the following url :
https://api.quprawholesale.com/get/info/numberinfo
Note: Special access required.


Result example :

{
    "records": [
        {
            "country": "NL",
            "number": "644425308",
            "operator": "GSM1",
            "date": "2021-01-07"
        }
    ]
}

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
number	Number	(Required)
country	String	(Required)

Order


# Here is a curl example
curl \
-X POST https://api.quprawholesale.com/provider/order \
-H 'Authorization=Bearer your_api_key' \
-F 'CompanyName=CompanyName' \
-F 'Salutation=Salutation' \
-F 'FirstName=ABC' \
-F 'LastName=XYZ' \
-F 'PhoneNumber=2134234' \
-F 'Email=abc@xyz.com' \
-F 'Street=21k' \
-F 'HouseNumber=112' \
-F 'HouseNumberExt=A' \
-F 'Zipcode=2518CM' \
-F 'City=XXXX' \
-F 'Note=note' \
-F 'ProductID=3' \
-F 'Whishdate=02-11-2022' \

To order, you need to make a POST call to the following url :
https://api.quprawholesale.com/provider/order
Note: Special access required.


Result example :

[
    {
        "id": 32,
        "CompanyName": "CompanyName",
        "Salutation": "Saluation",
        "FirstName": "abc",
        "LastName": "xyz",
        "PhoneNumber": "2134234",
        "Email": "abc@xyz.com",
        "Street": "21k",
        "HouseNumber": "112",
        "HouseNumberExt": "A",
        "Zipcode": "2518CM",
        "City": "XXX",
        "Note": "estst",
        "Whishdate": "2022-02-10T19:00:00.000Z",
        "SalesForceOrderId": "0002216",
        "ProductID": {
            "id": 3,
            "Provider": "KPNWEAS",
            "Type": "VDSL",
            "Area": null,
            "Carrier": "Copper",
            "Distance": null,
            "MaxUpload": 51200,
            "MaxDownload": 5120,
            "MonthlyPricing": "40",
            "OneOffPricing": "45",
            "Note": "50 MB",
            "DeliveryTime": null
        }
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
CompanyName	Number	(Required)
Salutation	String	(Required)
FirstName	Number	(Required)
LastName	String	(Required)
PhoneNumber	Number	(Required)
Email	String	(Required)
Street	Number	(Required)
HouseNumber	String	(Required)
HouseNumberExt	Number	(Optional)
Zipcode	String	(Required)
City	Number	(Required)
Note	String	(Optional)
ProductID	Number	(Required)
Whishdate	String	(Optional)

Broadband State


# Here is a curl example
curl \
-X GET https://api.quprawholesale.com/broadband/state \
-H 'Authorization=Bearer your_api_key' \

To order, you need to make a GET call to the following url :
https://api.quprawholesale.com/broadband/state
Note: Special access required.


Result example :

[
    {
        "id": 1089,
        "sfID": "a652p000001M74bAAC",
        "carrierID": "1441MR000820300",
        "status": null,
        "planDate": null,
        "carrierType": null,
        "carrierProductID": "634",
        "productDescription": "BVVDSL (MIGRATE)",
        "israSpecs": "001/B/MTK/METERKAST",
        "israPin": null,
        "serviceID": null,
        "primaryIPV4": null,
        "dataTechnology": null,
        "bandwithDown": null,
        "bandwithUp": null,
        "addressStreet": null,
        "addresHouseNr": "82",
        "addressZipcode": "1441MR",
        "addressCity": null,
        "slaDescription": null,
        "contactName": "support",
        "contactPhone": "888000820",
        "contactEmail": null,
        "orderName": "MT/2020314122",
        "terminationDate": null,
        "startDate": null,
        "contractFrom": null,
        "contractLastChange": null,
        "contractDuration": null,
        "contractTo": null,
        "accountID": "0015700001uuk7HAAQ",
        "lastUpdate": null,
        "addressHouseNrExt": null,
        "OrderingID": null
    }
]

QUERY PARAMETERS

Field	Type	Description
Authorization	String (headers)	Bearer 'Your API key'.
Status	String	(Optional) //Search Filter
addressZipcode	String	(Optional) //Search Filter
addresHouseNr	Number	(Optional) //Search Filter
addressCity	String	(Optional) //Search Filter
primaryIPV4	String	(Optional) //Search Filter
dataTechnology	String	(Optional) //Search Filter
OrderingID	Number	(Optional) //Search Filter
id	Number	(Optional) //Search Filter

Errors

The QUPRA API uses the following error codes:

Error Code	Meaning
500	Some parameters are missing. This error appears when you don't pass every mandatory parameters.
400	Unknown or unvalid `API_KEY`. This error appears if you use an unknow API key or if your API key expired.