Broadband USA
Department of Commerce NTIA

BTOP API Reference

The BTOP API is a convenient interface for all access to PCC award data openly available through the Department of Commerce. All information accessible is available in both JSON and XML formats. The responsive version of the BTOP website utilizes the API for delivering geolocation specific results.
/api/state
description
Access PCC Award data results based upon a state input parameter.
url structure
http://www2.ntia.doc.gov/BTOPmap/api/state/{US_STATE_ABBREVIATION}/{OUTPUT_TYPE}
method
GET
parameter
{US_STATE_ABBREVIATION}
A US state defined as two characters (case-insensitive)
Example: NC or nc
{OUTPUT_TYPE}
Formats requested in either json or xml (case-insensitive)
Example: json, JSON, xml, or XML
example
http://www2.ntia.doc.gov/BTOPmap/api/state/NC/JSON
returns
Access PCC Award data results based upon a state input parameter.
{
    "status": "OK",
    "message": {
        "totalResults": 1
    },
    "Results": [
        {
            "awardId": "13-42-B10583",
            "recipient": "Professional Resources of Rabun LLC",
            "projectName": "Technology Works!",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/professional-resources-management-of-rabun-llc",
            "pccName": "Rabun County Employment Center",
            "institution": "For-Profit Organization",
            "organization": "Program Site",
            "siteAddress": "184 South Main Street",
            "siteCity": "Clayton",
            "siteState": "GA",
            "siteZipCode": "30525",
            "pccType": "Improved",
            "numWorkstations": "18",
            "numHoursPerWeek": "40",
            "numberHoursPerWeekend": "6",
            "broadbandSpeed": "6.0mbps",
            "numberUsersPerWeek": "30",
            "latitude": "34.876011",
            "longitude": "-83.400856"
        }
    ]
}
/api/zipcode
description
Access PCC Award data results based upon a 5-digit state zip code parameter.
url structure
http://www2.ntia.doc.gov/BTOPmap/api/zipcode/{US_ZIP_CODE}/{OUTPUT_TYPE}
method
GET
parameter
{US_STATE_ZIP_CODE}
A US state zip code defined as 5 digits
Example: 30525
{OUTPUT_TYPE}
Formats requested in either json or xml (case-insensitive)
Example: json, JSON, xml, or XML
example
http://www2.ntia.doc.gov/BTOPmap/api/zipcode/30525/JSON
returns
Access PCC Award data results based upon a 5-digit state zip code parameter.
{
    "status": "OK",
    "message": {
        "totalResults": 1
    },
    "Results": [
        {
            "awardId": "13-42-B10583",
            "recipient": "Professional Resources of Rabun LLC",
            "projectName": "Technology Works!",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/professional-resources-management-of-rabun-llc",
            "pccName": "Rabun County Employment Center",
            "institution": "For-Profit Organization",
            "organization": "Program Site",
            "siteAddress": "184 South Main Street",
            "siteCity": "Clayton",
            "siteState": "GA",
            "siteZipCode": "30525",
            "pccType": "Improved",
            "numWorkstations": "18",
            "numHoursPerWeek": "40",
            "numberHoursPerWeekend": "6",
            "broadbandSpeed": "6.0mbps",
            "numberUsersPerWeek": "30",
            "latitude": "34.876011",
            "longitude": "-83.400856"
        }
    ]
}
/api/coordinates
description
Access PCC Award data results based upon a latitude and longitude coordinate point and radius in miles from that origination point.
url structure
http://www2.ntia.doc.gov/BTOPmap/api/coordinates/{LATITUDE},{LONGITUDE}/radius/{RADIUS}/{OUTPUT_TYPE}
method
GET
parameter
{LATITUDE}
A floating point number
Example: 34.876011
{LONGITUDE}
A floating point number
Example: -83.400856
{RADIUS}
A whole number (0,1,2...etc) in miles indicating the radius length from the specified coordinate point
Example: 1
{OUTPUT_TYPE}
Formats requested in either json or xml (case-insensitive)
Example: json, JSON, xml, or XML
example
http://www2.ntia.doc.gov/BTOPmap/api/coordinates/36.103653,-80.253273/radius/1/JSON
returns
Access PCC Award data results based upon a 5-digit state zip code parameter.
{
    "status": "OK",
    "message": {
        "totalResults": 6
    },
    "Results": [
        {
            "awardId": "37-42-B10529",
            "recipient": "Winstonnet Inc",
            "projectName": "WinstonNet Enhanced Community Computer Centers for Forsyth County",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/winstonnet-inc",
            "pccName": "Blessed of God Ministries",
            "institution": "Community Based Organization",
            "organization": "Program Site",
            "siteAddress": "740 Chatham Rd.",
            "siteCity": "Winston-Salem",
            "siteState": "NC",
            "siteZipCode": "27101",
            "pccType": "Improved",
            "numWorkstations": "10",
            "numHoursPerWeek": "15",
            "numberHoursPerWeekend": "",
            "broadbandSpeed": "7",
            "numberUsersPerWeek": "8",
            "latitude": "36.103653",
            "longitude": "-80.253273"
        },
        {
            "awardId": "37-42-B10529",
            "recipient": "Winstonnet Inc",
            "projectName": "WinstonNet Enhanced Community Computer Centers for Forsyth County",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/winstonnet-inc",
            "pccName": "Forsyth Tech International Cen",
            "institution": "Community College",
            "organization": "Program Site",
            "siteAddress": "660 West 5th Street",
            "siteCity": "Winston-Salem",
            "siteState": "NC",
            "siteZipCode": "27101",
            "pccType": "New",
            "numWorkstations": "18",
            "numHoursPerWeek": "20",
            "numberHoursPerWeekend": "3",
            "broadbandSpeed": "6",
            "numberUsersPerWeek": "23",
            "latitude": "36.099106",
            "longitude": "-80.251694"
        },
        {
            "awardId": "37-42-B10529",
            "recipient": "Winstonnet Inc",
            "projectName": "WinstonNet Enhanced Community Computer Centers for Forsyth County",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/winstonnet-inc",
            "pccName": "1st Outreach (was Faith Seeds ",
            "institution": "Community Based Organization",
            "organization": "Program Site",
            "siteAddress": "965 Northwest Blvd",
            "siteCity": "Winston-Salem",
            "siteState": "NC",
            "siteZipCode": "27105",
            "pccType": "Improved",
            "numWorkstations": "14",
            "numHoursPerWeek": "30",
            "numberHoursPerWeekend": "",
            "broadbandSpeed": "7",
            "numberUsersPerWeek": "23",
            "latitude": "36.10442",
            "longitude": "-80.259605"
        },
        {
            "awardId": "37-42-B10529",
            "recipient": "Winstonnet Inc",
            "projectName": "WinstonNet Enhanced Community Computer Centers for Forsyth County",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/winstonnet-inc",
            "pccName": "Winston-Salem Urban League",
            "institution": "Community Based Organization",
            "organization": "Program Site",
            "siteAddress": "201 W. 5th St.",
            "siteCity": "Winston-Salem",
            "siteState": "NC",
            "siteZipCode": "27101",
            "pccType": "New",
            "numWorkstations": "17",
            "numHoursPerWeek": "25",
            "numberHoursPerWeekend": "",
            "broadbandSpeed": "1.54",
            "numberUsersPerWeek": "9",
            "latitude": "36.099834",
            "longitude": "-80.246178"
        },
        {
            "awardId": "37-42-B10529",
            "recipient": "Winstonnet Inc",
            "projectName": "WinstonNet Enhanced Community Computer Centers for Forsyth County",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/winstonnet-inc",
            "pccName": "Union Baptist Church",
            "institution": "Community Based Organization",
            "organization": "Program Site",
            "siteAddress": "1200 N. Trade St",
            "siteCity": "Winston-Salem",
            "siteState": "NC",
            "siteZipCode": "27101",
            "pccType": "Improved",
            "numWorkstations": "10",
            "numHoursPerWeek": "12",
            "numberHoursPerWeekend": "",
            "broadbandSpeed": "7",
            "numberUsersPerWeek": "7",
            "latitude": "36.108788",
            "longitude": "-80.246468"
        },
        {
            "awardId": "37-42-B10529",
            "recipient": "Winstonnet Inc",
            "projectName": "WinstonNet Enhanced Community Computer Centers for Forsyth County",
            "projectUrl": "http:\/\/www2.ntia.doc.gov\/grantee\/winstonnet-inc",
            "pccName": "Goler Memorial AME Zion Church",
            "institution": "Community Based Organization",
            "organization": "Program Site",
            "siteAddress": "630 N. Patterson Ave",
            "siteCity": "Winston-Salem",
            "siteState": "NC",
            "siteZipCode": "27101",
            "pccType": "Improved",
            "numWorkstations": "10",
            "numHoursPerWeek": "12",
            "numberHoursPerWeekend": "",
            "broadbandSpeed": "7",
            "numberUsersPerWeek": "23",
            "latitude": "36.102013",
            "longitude": "-80.241272"
        }
    ]
}