IPGeolocation.io

opencollection: 1.0.0
info:
  name: 'IPGeolocation.io: User Agent API'
  version: '3.0'
request:
  auth:
    type: apikey
    key: apiKey
    value: '{{apiKey}}'
    placement: query
items:
- info:
    name: User Agent
    type: folder
  items:
  - info:
      name: IPGeolocation.io Parse User Agent String (auto-detect or Explicit Header)
      type: http
    http:
      method: GET
      url: https://api.ipgeolocation.io/v3/user-agent
      headers:
      - name: User-Agent
        value: Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5X Build/MMB29P) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.96
          Mobile Safari/537.36 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)
      params:
      - name: apiKey
        value: YOUR_API_KEY
        type: query
        description: 'Your IPGeolocation API key. Required unless Request Origin (CORS) authentication

          is configured for your domain on a paid plan. Get your key from the

          [IPGeolocation dashboard](https://app.ipgeolocation.io/).

          '
    docs: 'Parses a user agent string and returns browser, device, and operating system

      details. Also detects bots, crawlers, and malicious or malformed user agent strings.


      This endpoint supports two usage modes:


      **Mode 1 — Auto-detect caller''s user agent:**

      Omit the `User-Agent` header entirely. The API will parse the user agent string

      of the calling client automatically. This is the default browser behavior — when

      executed in browser JavaScript, the header is appended automatically and no

      additional co'
  - info:
      name: IPGeolocation.io Parse Custom User Agent String (payload)
      type: http
    http:
      method: POST
      url: https://api.ipgeolocation.io/v3/user-agent
      params:
      - name: apiKey
        value: YOUR_API_KEY
        type: query
        description: 'Your IPGeolocation API key. Required unless Request Origin (CORS) authentication

          is configured for your domain on a paid plan. Get your key from the

          [IPGeolocation dashboard](https://app.ipgeolocation.io/).

          '
      body:
        type: json
        data: '{}'
    docs: 'Parses a custom user agent string supplied in the JSON request body and returns

      browser, device, and operating system details.


      **Mode 3 — Custom user agent string via POST body:**

      Pass the user agent string as the `uaString` field in a JSON payload. This is

      intended for server-side use cases where the string to be parsed is different

      from the caller''s own user agent and is known at request time.


      This endpoint is available on **paid plans only**.


      Each successful lookup consumes **1 credit**.

      '
  - info:
      name: IPGeolocation.io Bulk Parse User Agent Strings
      type: http
    http:
      method: POST
      url: https://api.ipgeolocation.io/v3/user-agent-bulk
      params:
      - name: apiKey
        value: YOUR_API_KEY
        type: query
        description: 'Your IPGeolocation API key. Required unless Request Origin (CORS) authentication

          is configured for your domain on a paid plan. Get your key from the

          [IPGeolocation dashboard](https://app.ipgeolocation.io/).

          '
      body:
        type: json
        data: '{}'
    docs: 'Parses up to **50,000 user agent strings** in a single request.


      Pass a JSON body containing the `uaStrings` array. Each entry in the array

      is parsed independently. The total credits charged equals the number of strings

      in the array.


      This endpoint is available on **paid plans only**.

      '
bundled: true