For Developers - Accessibility Clearinghouse API (v2.0)
Geting Started - Sign Up for an API Key
Before using any of the Accessibility Clearinghouse API's you must first sign up for an API Key.Authentication & Authorization is collapsed.
- Description
- API requests must be authenticated using a unique API key.
- Example Call
- http://data.fcc.gov/api/accessibilityclearinghouse/product/products?api_key=[API KEY]&category=mobile®ion=North%20America&format=jsonp&jsonpCallback=?
| Parameter | Type | Description |
|---|---|---|
| api_key required | string | Unique API key. Valid values: Your assigned API key. |
Disability Types is collapsed.
- API Description
- Returns a list of disabilities along with the disability type name, id, short description and long description.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/disabilityTypes?api_key=[API KEY]&format=xml
- API Example Call
- http://data.fcc.gov/api/accessibilityclearinghouse/disabilityTypes?api_key=[API KEY]&format=jsonp&jsonpCallback=?
- Excel API Description
- Returns a list of disabilities along with the disability type name, id, short description and long description in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/DisabilityTypesService?api_key=[API KEY]&format=xml
- Excel API Example Call
- http://data.fcc.gov/api/accessibilityclearinghouse/DisabilityTypesService?api_key=[API KEY]&format=jsonp&jsonpCallback=?
| Parameter | Type | Description |
|---|---|---|
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
Products (Mobile Devices) is collapsed.
- Description
- Returns a list of mobile devices as well as the original source of the data. The features, manufacturers, and regions API's can be used to provide optional parameter inputs.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/product/products?[API KEY]&category=mobile
- Example Call
- http://data.fcc.gov/api/accessibilityclearinghouse/product/products?[API KEY]&category=mobile®ion=North%20America&format=jsonp&jsonpCallback=?
| Parameter | Type | Description |
|---|---|---|
| category required | string | Returns the results based on a category type. Valid values: mobile (only the mobile category is currently supported) |
| feat optional | integer | One or more feature ID's. Used to identify a device's supported accessibility features. Valid values: Refer to the Product Features API for more info. |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| mfg optional | string | One or more device manufacturer names. Valid values: Refer to the Product Manufacturers API for more info. |
| page optional | integer | Returns the results for a specified page number. Valid values: any integer > 0 |
| region optional | string | One or more geographical regions where a device may be available. (Refer to the Product Regions API for more info.) Valid values: pre-selected georgraphical regions |
| rowPerPage optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |
Products (Mobile Devices) Details is collapsed.
- Description
- Returns a list of accessibility features (with name and description) that are supported by a particular device as well as the source for the original data.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/product/productFeatures?api_key=[API KEY]
- Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/product/productFeatures?api_key=[API KEY]&productID=716
| Parameter | Type | Description |
|---|---|---|
| productID required | integer | Returns results based on the product ID. Valid values: [productID] (to retrieve a product ID refer to the Products (Mobile Devices) API) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
Products (Mobile Devices) Features is collapsed.
- Description
- Returns a list of accessibility features (with name and description) that may be supported by various products. Can be used with the Products (Mobile Devices) API to provide optional parameters for feat.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/featureGroups?api_key=[API KEY]
- Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/featureGroups?api_key=[API KEY]&disabilityId=5
| Parameter | Type | Description |
|---|---|---|
| disabilityId optional | integer | Returns results based on the disability ID. Valid values: 3, 4, 5, 6, 7 (for mapping details on the disability type name and id please use the Disability Types API) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
Products (Mobile Devices) Manufacturers is collapsed.
- Description
- Returns a list of product manufacturers. Can be used with the Products (Mobile Devices) API to provide optional parameters for mfg.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/product/manufacturers?api_key=[API KEY]&category=mobile
- Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/product/manufacturers?api_key=[API KEY]&category=mobile&format=jsonp&jsonCallback=?
| Parameter | Type | Description |
|---|---|---|
| category required | string | Returns the results based on a category type. Valid values: mobile (only the mobile category is currently supported) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
Products (Mobile Devices) Regions is collapsed.
- Description
- Returns a list of regions where various products may be available. Can be used with the Products (Mobile Devices) API to provide optional parameter inputs for region).
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/product/regions?api_key=[API KEY]&category=mobile
- Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/product/regions?api_key=[API KEY]&category=mobile&order=desc&format=jsonp&jsonCallback=?
| Parameter | Type | Description |
|---|---|---|
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| order optional | string | Format for the returned results. Valid values: asc (default), desc |
Products (Mobile Devices) Search is collapsed.
- Description
- Returns a list of mobile devices based on a search query (manufacturer, brand, or model) as well as the original source of the data.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/product/searchProducts?api_key=[API KEY]
- Example Call
- http://data.fcc.gov/api/accessibilityclearinghouse/product/searchProducts?api_key=[API KEY]&searchString=apple
| Parameter | Type | Description |
|---|---|---|
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| page optional | integer | Returns the results for a specified page number. Valid values: any integer > 0 |
| rowPerPage optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |
| searchString required | string | Search term. Valid values: any string value (manufacturer, brand, or model) |
Products (Mobile Devices) Search Autocomplete is collapsed.
- Description
- Returns a list of mobile devices (manufacturer or brand and model number) as the user types a search query.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/product/searchProducts?api_key=[API KEY]
- Example Call
- http://data.fcc.gov/api/accessibilityclearinghouse/product/makerBrandModel?api_key=[API KEY]&searchString=ap
| Parameter | Type | Description |
|---|---|---|
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| limit optional | integer | Maximum number of results to return. Valid values: any integer > 0 |
| searchString required | string | Search term. Valid values: any string value |
Apps & Technologies is collapsed.
- API Description
- Returns a list of accessible apps and assistive technologies as well as the original source of the data.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/apps?api_key=[API KEY]
- API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/apps?api_key=[API KEY]&disabilityId=7&page=1&rowPerPage=20&format=xml
- Excel API Description
- Returns a list of accessible apps and assistive technologies as well as the original source of the data in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/AppsService?api_key=[API KEY]
- Excel API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/AppsService?api_key=[API KEY]&pgID=4&entityType=factsheets&disabilityId=5
| Parameter | Type | Description |
|---|---|---|
| disabilityId optional | integer | Returns results based on the disability ID. Valid values: 3, 4, 5, 6, 7 (for mapping details on the disability type name and id please use the Disability Types API) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| page optional | integer | Returns the results for a specified page number. Valid values: any integer > 0 |
| rowPerPage optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |
Content is collapsed.
- API Description
- Returns content for Fact Sheets and User Voice questions as well as the original source of the data.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/content?api_key=[API KEY]
- API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/content?api_key=[API KEY]&contentType=Fact%20sheet&disabilityId=6&format=json&jsonpCallback=?
- Excel API Description
- Returns content for Fact Sheets and User Voice questions as well as the original source of the data in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/ContentService?api_key=[API KEY]
- Excel API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/ContentService?api_key=[API KEY]&contentType=Fact%20sheet&disabilityId=6
| Parameter | Type | Description |
|---|---|---|
| contentType required | string | Returns results based on the content type. Valid values: Fact sheet, UserVoice |
| disabilityId optional | integer | Returns results based on the disability ID. Valid values: 3, 4, 5, 6, 7 (for mapping details on the disability type name and id please use the Disability Types API) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
Convenience Contacts Listing is collapsed.
- API Description
- Returns a variety of convenience contact information as well as the original source of the data for Service Providers, Equipment Manufacturers, Schools and Universities, and National and International Organizations. The list of contacts can be grouped by state.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/contacts?api_key=[API KEY]
- API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/contacts?api_key=[API KEY]&entityType=national&stateName=California&groupByState=false&format=xml
- Excel API Description
- Returns a variety of convenience contact information as well as the original source of the data for Service Providers, Equipment Manufacturers, Schools and Universities, and National and International Organizations in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/ContactService?api_key=[API KEY]
- Excel API Request
- http://data.fcc.gov/api/accessibilityclearinghouse/ContactService?api_key=[API KEY]&entityType=national&stateName=California&groupByState=false
| Parameter | Type | Description |
|---|---|---|
| entityType required | string | Returns results based on the entity type. tag and entityType should not be used together. Valid values: AT Program, Equipment Manufacturer, Service Provider, School, International, National |
| disabilityId optional | integer | Returns results based on the disability ID. Valid values: 3, 4, 5, 6, 7 (for mapping details on the disability type name and id please use the Disability Types API) |
| entityRangeStartWith optional | alphanumeric | Used with entityRangeEndWith to filter entity names within a defined range. Valid Values: 0-9, a-z |
| entityRangeEndWith optional | alphanumeric | Used with entityRangeStartWith to filter entity names within a defined range. Valid Values: 0-9, a-z |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| groupByState optional | boolean | Returns results grouped by state name. Valid values: true or false |
| page optional | integer | Returns the results for a specified page number. Valid values: any integer > 0 |
| rowPerPage optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |
| stateName optional | string | Returns results with addresses within a specified state. Valid values: Any US State name (for a list of states applicable for the particular category please use the States API) |
| tag required | string | Returns results that have been tagged as contacts for Veterans, Family & Children or Seniors. tag and entityType should not be used together. Valid values: VET, KID, SEN |
States is collapsed.
- API Description
- Returns a list of states by which the convenience contacts can be grouped.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/states?api_key=[API KEY]
- API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/states?api_key=[API KEY]&entityType=school&format=xml
- Excel API Description
- Returns a list of states by which the convenience contacts can be grouped in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/StatesService?api_key=[API KEY]
- Excel API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/StatesService?api_key=[API KEY]&entityType=school&format=xml
| Parameter | Type | Description |
|---|---|---|
| entityType required | string | Returns a list of states where the specified entity type can be found. Valid values: Service Provider, Equipment Manufacturer, School, National, International |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
Events is collapsed.
- API Description
- Returns a list of upcoming and past Disability Related Events.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/events?api_key=[API KEY]
- API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/events?api_key=[API KEY]&dateFlag=future&disabilityId=3&rowPerPage=20
- Excel API Description
- Returns a list of upcoming and past Disability Related Events in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/EventService?api_key=[API KEY]
- Excel API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/EventService?api_key=[API KEY]&dateFlag=future&disabilityId=3&rowPerPage=20
| Parameter | Type | Description |
|---|---|---|
| date optional | integer | Returns current events based on the given date. Valid values: MM/DD/YYYY or null (If null then dateFlag is required.) |
| dateFlag optional | string | Returns past or future events based on a given date. If date is null past or future events are returned based on the current date. Valid values: past, future (default) |
| disabilityId optional | integer | Returns results based on the disability ID Valid values: 3, 4, 5, 6, 7 (for mapping details on the disability type name and id please use the Disability Types API) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| page optional | integer | Returns the results for a specified page number. Valid values: any integer > 0 |
| rowPerPage optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |
Federal Contacts is collapsed.
- Description
- Returns a list of Federal Agencies that provide accessibility related services or information.
- API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/fedContacts?api_key=[API KEY]&disabilityId=3
- Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/fedContacts?api_key=[API KEY]&disabilityId=3&rowPerPage=20
- Excel API Description
- Returns a list of Federal Agencies that provide accessibility related services or information in a downloadable XLS file.
- Excel API URL
- http://data.fcc.gov/api/accessibilityclearinghouse/FedContactService?api_key=[API KEY]&disabilityId=3
- Excel API Example Request
- http://data.fcc.gov/api/accessibilityclearinghouse/FedContactService?api_key=[API KEY]&disabilityId=3&rowPerPage=20
| Parameter | Type | Description |
|---|---|---|
| disabilityId optional | integer | Returns results based on the disability ID. Valid values: 3, 4, 5, 6, 7 (for mapping details on the disability type name and id please use the Disability Types API) |
| format optional | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| rowPerPage optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |
Video Programming Distributors (VPD) Closed Captioning Contacts is collapsed.
- Description
- Returns a list of contact information for various Video Programming Distributors.
- API URL
- http://data.fcc.gov/api/vpd-service/contacts/vpdtype=lec.xml
- Example Request
- http://data.fcc.gov/api/vpd-service/contacts/vpdtype=lec.json?page=1&rows_per_page=20&jsonpCallback=?
| Parameter | Type | Description |
|---|---|---|
| vpdtype required | string | Return results based on the specified VPD type. Valid values: broadcaster, cable, lec (telephone company), satellite, other |
| format required | string | Format for the returned results. Valid values: xml (default), json, jsonp |
| page optional | integer | Returns the results for a specified page number. Valid values: any integer > 0 |
| row_per_page optional | integer | The number of results to show per page. Valid values: 20, 40, 60, 100 (a value of -1 will show all rows on one page) |