---
title: "UA Lookup"
method: GET
path: "/ua-lookup"
tags: ["Data Tools"]
---

# UA Lookup

`GET /ua-lookup`

Parse, validate and get detailed user-agent information from a user agent string or from client hints

## Query parameters

- `ua` string, required
- `ua-version` string
- `ua-platform` string
- `ua-platform-version` string
- `ua-mobile` string
- `device-model` string
- `device-brand` string
- `ua-arch` string
- `ua-bitness` string
- `ua-form-factors` string

## Response `200`

OK

- UALookupResponse — Structure of ua-lookup
  - `ua` string, required — The user agent string
  - `type` string, required — The user agent type, possible values are: <br> <ul> <li>desktop</li> <li>phone</li> <li>tablet</li> <li>wearable</li> <li>tv</li> <li>console</li> <li>email</li> <li>library</li> <li>robot</li> <li>unknown</li> </ul>
  - `name` string, required — The client software name / user agent name
  - `version` string, required — The user agent software full version
  - `version-major` string, required — The user agent software major version
  - `browser-engine` string, required — For web browsers which underlying browser engine does it use
  - `browser-release` string, required — For web browsers which year was this browser version released
  - `os` string, required — The full operating system name
  - `os-family` string, required — The operating system family. The major OS families are: Android, Windows, macOS, iOS, Linux
  - `os-version` string, required — The operating system full version
  - `os-version-major` string, required — The operating system major version
  - `is-mobile` boolean, required — Is this a mobile device (e.g. a phone or tablet)
  - `is-webview` boolean, required — Is this a WebView or embedded web browser. This includes mobile and desktop apps using WebViews
  - `device-brand` string, required — The device brand / manufacturer
  - `device-model` string, required — The device model
  - `device-model-code` string, required — The device model code
  - `device-release` string, required — The year when this device model was released
  - `device-price` number, double, required — The average device price on release in USD
  - `device-resolution` string, required — The device display resolution in physical pixels (e.g. 720x1280)
  - `device-ppi` number, double, required — The device display PPI (pixels per inch)
  - `device-pixel-ratio` number, double, required — The device display pixel ratio (the ratio of the resolution in physical pixels to the resolution in CSS pixels)
  - `device-width-px` number, double, required — The device display width in CSS 'px'
  - `device-height-px` number, double, required — The device display height in CSS 'px'
  - `is-current` boolean, required — For web browsers is the version up-to-date with the current stable release (+/- one version)
  - `is-ua-frozen` boolean, required — For chrome/chromium based browsers is this user agent string frozen and requires client hints for more accurate details. For more information see <a href="https://www.chromium.org/updates/ua-reduction/">user-agent reduction</a> and to test a browser for client hints go to the <a href="https://www.neutrinoapi.com/client-hints-analyzer/">client hints analyzer</a> test page
  - `device-width-mm` integer, required — The device display width in millimeters
  - `device-height-mm` integer, required — The device display height in millimeters

## Other responses

- `400` — Your API request has been rejected. Check error code for details
- `403` — You have failed to authenticate
- `500` — We messed up, sorry! Your request has caused a fatal exception
- `default` — We messed up, sorry! Your request has caused an error

---

[API](https://skmtc.net/neutrinoapi/apis/neutrino-api.md) · [All operations](https://skmtc.net/neutrinoapi/apis/neutrino-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/neutrinoapi/neutrino-api/revisions/4ebd6b56de42/schema)
