Get Broadband Availability

This endpoint allows you get broadband availability for a specific address

Get broadband availability for a specific address using GET Request

{BASE_URL}/broadband/availability/addressId/postcode

Example

{BASE_URL}/broadband/availability/Gold|A00007997291|ST|/Sp63ep

URL Parameters

Parameter	Type	Required	Description
addressId	string	yes*	Address Id: Unique identifier for each address
postcode	string	yes*	UK postcode being checked

Responses

Success Example

Status Code: 200

{
    "success": true,
    "data": {
       "salesFilter1Date": "01-03-2013",
        "exchangeName": "FORDINGBRIDGE",
        "exchangeCode": "STFORDB",
        "salesFilter1Switch": "ON",
        "addressId": "Gold|A00007997291|ST|",
        "enjoyEligible": false,
        "serviceLineTypes": [
            {
                "bb": "GREEN",
                "bbUpsellAvailable": "N",
                "differentFromCurrentSLT": false,
                "exchangeState": "E",
                "infinity": false,
                "maxRangeSpeed": "3.5M",
                "minRangeSpeed": "1M",
                "serviceLineType": "BBSLT_UPTO_8M_WBC",
                "speed": "1.5M",
                "speedDescriptor": "Ofcom",
                "supportsMoCo": "NoLinearChannel",
                "supportsMulticast": "NoLinearChannel",
                "supportsVision": "RED",
                "speedGuaranteeAvailable": false,
                "normDownloadSpeedUpper": "3000",
                "normDownloadSpeedLower": "1000",
                "normUploadSpeedUpper": "1000",
                "normUploadSpeedLower": "1000",
                "minGuaranteeDownloadSpeed": "1000",
                "BTTV_UHD_EXTRABOX": "RED",
                "MinThreshold": "256k"
            },
            {
                "bb": "GREEN",
                "bbUpsellAvailable": "Y",
                "differentFromCurrentSLT": false,
                "exchangeState": "E",
                "infinity": true,
                "serviceLineType": "BBSLT_UPTO_40M_10M_FTTCWBC",
                "speedDescriptor": "Ofcom",
                "supportsMoCo": "RED",
                "supportsMulticast": "HD-S",
                "supportsVision": "GREEN",
                "speedGuaranteeAvailable": false,
                "normDownloadSpeedUpper": "36000",
                "normDownloadSpeedLower": "31000",
                "normUploadSpeedUpper": "9000",
                "normUploadSpeedLower": "6000",
                "minGuaranteeDownloadSpeed": "28000",
                "AvailabilityFlag": "Y",
                "BTTV_EXTRABOX": "GREEN",
                "BTTV_UHD_EXTRABOX": "RED",
                "CLEAN_BOTTOM_DOWNSPEED": "35000",
                "CLEAN_BOTTOM_UPSPEED": "7100",
                "CLEAN_MIN_DOWNSPEED": "33000",
                "CLEAN_TOP_DOWNSPEED": "40000",
                "CLEAN_TOP_UPSPEED": "10000"
            }
        ],
        "MarketIndicator": "B",
        "postcode": "Sp63ep",
        "USOFixedResponse": "Y",
        "Is4GRAvailable": false,
        "isADSLFSAvailable": false
    }
}

Validation Error Response

Status Code: 200

{
    "success": false,
    "message": "Invalid postcode or address Id"
}

Error

Status Code: 400

{

    "success": false,
    "message": "Message Returned"
}