---
title: "Parse User-Agent"
method: GET
path: "/user_agent"
tags: ["Ipregistry User-Agent API"]
---

# Parse User-Agent

`GET /user_agent`

Initiates user-agent parsing using user-agent from either the `ua` query parameter or the `user-agent` header received with the request if no `ua` query parameter is defined. User-Agent parsing allows detecting any browser, device & OS in real-time to bring user experience to perfection (e.g. native app download, tailored advertising, crawler protection, and more). Each call costs 1 credit.

## Query parameters

- `params` object, required

## Response `200`

Successful operation

- UserAgent — Parsed User-Agent result containing browser, device, engine, and operating system information.
  - `header` string — The raw User-Agent string extracted from the request.
  - `name` string — The name of the browser.
  - `type` string — The browser classification: browser, browser-webview, cloud-application, email-client, hacker, mobile-app, robot, robot-mobile, special, testclient, or voice.
  - `version` string — The browser version number.
  - `version_major` string — The major version number of the browser.
  - `device` UserAgentDevice — Device information extracted from a User-Agent string.
    - `brand` string — The hardware brand or manufacturer.
    - `name` string — The hardware device name.
    - `type` string — The device classification: anonymized, desktop, ereader, game-console, hacker, handheld-game-console, mobile, phone, robot, robot-imitator, robot-mobile, set-top-box, tablet, tv, virtual-reality, voice, or watch.
  - `engine` UserAgentEngine — Rendering engine information extracted from a User-Agent string.
    - `name` string — The name of the rendering engine.
    - `type` string — The engine classification: browser, mobile-app, hacker, or robot.
    - `version` string — The rendering engine version.
    - `version_major` string — The major version number of the rendering engine.
  - `os` UserAgentOperatingSystem — Operating system information extracted from a User-Agent string.
    - `name` string — The name of the operating system.
    - `type` string — The OS classification: cloud, desktop, embedded, game-console, hacker, or mobile.
    - `version` string — The operating system version.

## Other responses

- `401` — Unauthorized — Missing or disabled API key
- `403` — Forbidden — Invalid API key, insufficient credits, or restricted IP/origin
- `429` — Too many requests — Rate limit exceeded

---

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