REST API & Data Dictionary

Resources

DeviceAtlas provides a REST API for fetching definitions of pre-defined property values (data dictionary) and for sending device/User-Agent data to DeviceAtlas.

URI structure

All DeviceAtlas requests start with https://deviceatlas.com/api/rest/v1/ prefix. The following parts of the path depend on the endpoint of the request.

For example, the following shows cURL fetching all of the possible browserNames:

curl --user dauser:dapassword https://deviceatlas.com/api/rest/v1/data/property/browserName/values

Supported Endpoints

Endpoint	HTTP method	Description
data/files/identifiers/apple	GET	Returns list of Apple devices and their hardware identifiers.
data/property/{property}/values	GET	Returns lists of predefined property values. The following property names should be substituted for {property} in the endpoint path. primaryHardwareType primarySoftwareType osVendor osName osFamily browserVendor browserName browserRenderingEngine contextualUsage highestCellularGeneration
data/webusage/{property}/report	GET	Returns lists of Mobile Operating system or Browser names and their most popular versions. The following property names should be substituted for {property} in the endpoint path. osVersion browserVersion

Authentication

The DeviceAtlas REST API uses HTTP Basic authentication over SSL. Please provide the username and password you would normally login to DeviceAtlas when using the REST API.

Response codes

The REST API returns JSON data with the following response codes:

HTTP Code	Description
200 OK	Returned on success. The response contains an entity corresponding to the requested resource.
400 Bad Request	Returned if the caller submits a badly formed request. For example, the caller can receive this return if you forget a required parameter.
401 Unauthorized	Returned if the call requires authentication and either the credentials provided failed or no credentials were provided.
403 Forbidden	Returned if the caller attempts to make a call or modify a resource for which the caller is not authorized.
404 Not Found	Returned if the specified resource does not exist.

Full example

Download all possible OS names used by devices in DeviceAtlas:

cURL command

curl --user dauser:dapassword https://deviceatlas.com/api/rest/v1/data/property/osName/values

Response

[
 "Android",
 "Bada",
 "Firefox OS",
 "Linux",
 "Linux - Arch",
 "Linux - CentOS",
 "Linux - Debian",
 "Linux - Fedora",
 "Linux - Mint",
 "Linux - Red Hat",
 "Linux - Slackware",
 "Linux - Ubuntu",
 "Linux - openSUSE",
 "Mac OS",
 "OS X",
 "RIM",
 "Symbian",
 "Windows",
 "Windows 2000",
 "Windows 7",
 "Windows 8",
 "Windows Mobile",
 "Windows Phone",
 "Windows RT",
 "Windows Vista",
 "Windows XP",
 "iOS",
 "webOS"
]

Resources