FREE Client Info API

Introduction

This API is a fast and simple way to find out the public IPv4 address and browser details of your customers. It offers proxy detection by examining the X-Forwarded-For (XFF) HTTP header field and detailed User Agent (UA) information, providing a quick overview of the visitor and the device they are using to access your services.

 

Example Response

The response is only available in JSON format. The below response should be expected for the following request:



Awaiting request submission...

API Pricing

  1. Client Info API
    FREE
    Unlimited queries

Response Format

The response should be expected in JSON format

Field

Data type

Description

ipString

string

Returns the client’s IP address in a string format

ipNumeric

32 bit unsigned integer

Returns the client’s IP address in a numeric format

ipType

string

Returns the IP address type. Possible values: "IPv4"

isBehindProxy

boolean

Indicates if the request was detected as delivered via proxy

proxyIp

string

Returns the IP address of the proxy server  (omitted if no proxy detected)

device

string

The Device parsed from the user agent string

os

string

The OS parsed from the user agent string

userAgent

string

The User Agent parsed from the user agent string

family

string

The family of the device, if available

versionMajor

string

Major version of the user agent, if available

versionMinor

string Minor version of the user agent, if available

versionPatch

string Patch version of the user agent, if available

isSpider

string Returns true if the device is likely to be a spider or a bot device

userAgentDisplay

string The user agent as a readbale string

userAgentRaw

string The user agent string, the input for the UA parser

userLanguages

array of string List of user languages as reported by the client

Related APIs