BigDataCloud Logo

FREE Client Info API

Introduction

The Free Client Info API provides a quick and simple way to identify the public IPv4 address and browser details of your users. It also includes proxy detection by analysing the X-Forwarded-For (XFF) HTTP header field, along with detailed User-Agent (UA) information. This gives you a clear overview of your visitor’s identity and the device they are using to access your services.

Important Notice: While the API is free to use with no throttling limits, we expect responsible usage. Excessive or unreasonable requests, such as repeatedly querying the same IP address at high volumes, are prohibited and may result in restricted access. If you encounter errors or connection blocks despite adhering to reasonable usage practices, please contact our support team for assistance.

Get Started

This API is part of the FREE API Package and is available in free and paid plans. Please visit the FREE API Package package page for limits and pricing information.

Endpoint

GET
https://api.bigdatacloud.net/data/client-info

Request

This API doesn't require any request parameters.

Responses

200
OK

Sample Query

GET
https://api.bigdatacloud.net/data/client-info

Schema

application/json
ipStringstring
Returns the client’s IP address in a string format
ipNumericinteger
Returns the client’s IP address in a numeric format
ipTypestring
Returns the IP address type. Expected values: "IPv4", "IPv6"
isBehindProxyboolean
Indicates whether the request was detected as delivered via proxy
proxyIpstring
Returns the IP address of the proxy server (omitted if no proxy detected)
devicestring
The Device type parsed from the user agent string
osstring
The OS parsed from the user agent string
userAgentstring
The User-Agent parsed from the input user agent string
familystring
The family of the device, if available
versionMajorstring
The major version of the user agent, if available
versionMinorstring
The minor version of the user agent, if available
versionPatchstring
Patch version of the user agent, if available
isSpiderboolean
Returns true if the device is likely to be a spider or a bot device
isMobileboolean
Returns true if the device is likely to be of a mobile type
userAgentDisplaystring
The user agent as a readable string
userAgentRawstring
The user agent string, the input for the UA parser
userLanguagesarray
userLanguages object

Sample Response

JSON View
500
An error has occurred and did not complete your request. Please try again

Sample Response

JSON View
Was this page helpful?