User Agent Parser API
Introduction
The User-Agent (UA) Parser API is a highly efficient and easy-to-use parsing tool that delivers clearly reliable and defined information based on the provided UA string.
The UA string is a piece of information that is included in the header of an HTTP request made by a user's web browser. This string typically contains information about the user's web browser, operating system, and device. However, the varying formats in which different browsers provide this string can make it challenging to interpret this data accurately, often requiring significant effort in coding and testing an effective parser.
This API significantly simplifies the task of parsing UA strings, providing a simple and straightforward solution.
The UA string can be used by web servers to identify the type of device and browser that is making the request and to serve up content that is optimised for that device and browser. The User-Agent string is often used in web analytics to track user activity and to provide insights into the types of devices and browsers that are accessing a website.
It can also be utilised to recognise bot traffic (denoted by 'isSpider' in the output data) by examining the distinctive User-Agent strings typically used by bots. This enables website administrators to identify and restrict bot traffic, guaranteeing accurate analytics and optimal usage of server resources by genuine users, thereby enhancing the overall user experience on the website.
Get Started
This API is part of the IP Geolocation API Package and is available in free and paid plans. Please visit the IP Geolocation API Package package page for limits and pricing information.
Endpoint
Request
Responses
200OK
Sample Query
Schema
devicestringThe Device type parsed from the user agent string
osstringThe OS parsed from the user agent string
userAgentstringThe User-Agent parsed from the input user agent string
familystringThe family of the device, if available
versionMajorstringThe major version of the user agent, if available
versionMinorstringThe minor version of the user agent, if available
versionPatchstringPatch version of the user agent, if available
isSpiderbooleanReturns true if the device is likely to be a spider or a bot device
isMobilebooleanReturns true if the device is likely to be of a mobile type
userAgentDisplaystringThe user agent as a readable string
userAgentRawstringThe user agent string, the input for the UA parser
Sample Response
400Bad request
Sample Response
403Access denied, or your quota limit has exceeded
Sample Response
500An error has occurred and did not complete your request. Please try again
Sample Response