Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IPGeolocation.io User Agent API

API endpoints for parsing user agent strings into browser, device, layout engine,and operating system details. Supports single lookups via request header, customstring lookups via JSON body, and bulk parsing of up to 50,000 strings per request.Also detects bots, crawlers, and malicious or malformed user agent strings.

IPGeolocation.io User Agent API is one of 7 APIs that IPGeolocation.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Agent. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.7, at version 3.0.

Requests are made against a single base URL, https://api.ipgeolocation.io.

3 operations 2 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.7
API Version
3.0
Base URL
https://api.ipgeolocation.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

IPGeolocation.io User Agent API declares 1 security scheme for authenticating requests. An API key is passed in the query as apiKey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key passed as the apiKey query parameter. Get yours from the [IPGeolocation dashboard](https://app.ipgeolocation.io/). For client-side usage, consider usin…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

User Agent 3

API endpoints for parsing user agent strings into browser, device, layout engine, and operating system details. Supports single lookups via request header, custom string lookups v…

GET
/v3/user-agent
IPGeolocation.io Parse User Agent String (auto-detect or Explicit Header)
parseUserAgent 2 params → 200400401405429499500502
POST
/v3/user-agent
IPGeolocation.io Parse Custom User Agent String (payload)
parseCustomUserAgent 1 param body → 200400401405429499500502
POST
/v3/user-agent-bulk
IPGeolocation.io Bulk Parse User Agent Strings
parseUserAgentBulk 1 param body → 200400401405429499500502

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are UserAgentResponse (8 properties), OperatingSystem (5 properties), Device (4 properties), Engine (4 properties). Each schema is shown below with its type and property counts.

Engine
object
Layout engine information extracted from the user agent string.
4 properties
ErrorResponse
object
Returned for any non-200 response. Contains only a human-readable message. Message text can vary by status and condition; examples in this spec are representat…
1 property 1 required
OperatingSystem
object
Operating system information extracted from the user agent string.
5 properties
UserAgentResponse
object
Parsed user agent details including browser, device, layout engine, and operating system information. Also indicates bots, crawlers, or malicious user agent st…
8 properties
Device
object
Hardware device information extracted from the user agent string.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ipgeolocation-user-agent-api-openapi.yml Raw ↑

Other APIs IPGeolocation.io publishes across the network.

IPGeolocation.io ASN Lookup API
IPGeolocation.io Astronomy API
IPGeolocation.io IP Abuse Contact API
IPGeolocation.io IP Geolocation API
IPGeolocation.io IP Security API
IPGeolocation.io Timezone API