FREE Client Info API
Introduction
The Free Client Info API is a fast and simple way to establish 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 that they are using to access your services.
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.
Endpoints
IPv4 only API Endpoint
Use this endpoint to force API calls routed over the IPv4 network only
GET
https://api.bigdatacloud.net/data/client-info
Dual-Stack API Endpoint
This endpoint has native IPv6 support and backs the API calls routed over both IPv4 and IPv6 networks
GET
https://api-bdc.net/data/client-info
Request
This API doesn't require any request parameters.
Responses
200Success
200
Success
Sample Query
GET
https://api-bdc.net/data/client-info
Schema
application/json
ipStringstringReturns the client’s IP address in a string format
ipStringstring
Returns the client’s IP address in a string format
ipNumericstringipNumeric object
ipNumericstring
ipNumeric object
ipTypestringReturns the IP address type. Expected values: "IPv4", "IPv6"
ipTypestring
Returns the IP address type. Expected values: "IPv4", "IPv6"
isBehindProxybooleanIndicates whether the request was detected as delivered via proxy
isBehindProxyboolean
Indicates whether the request was detected as delivered via proxy
proxyIpstringReturns the IP address of the proxy server (omitted if no proxy detected)
proxyIpstring
Returns the IP address of the proxy server (omitted if no proxy detected)
devicestringThe Device type parsed from the user agent string
devicestring
The Device type parsed from the user agent string
osstringThe OS parsed from the user agent string
osstring
The OS parsed from the user agent string
userAgentstringThe User-Agent parsed from the input user agent string
userAgentstring
The User-Agent parsed from the input user agent string
familystringThe family of the device, if available
familystring
The family of the device, if available
versionMajorstringThe major version of the user agent, if available
versionMajorstring
The major version of the user agent, if available
versionMinorstringThe minor version of the user agent, if available
versionMinorstring
The minor version of the user agent, if available
versionPatchstringPatch version of the user agent, if available
versionPatchstring
Patch version of the user agent, if available
isSpiderbooleanReturns true if the device is likely to be a spider or a bot device
isSpiderboolean
Returns true if the device is likely to be a spider or a bot device
isMobilebooleanReturns true if the device is likely to be of a mobile type
isMobileboolean
Returns true if the device is likely to be of a mobile type
userAgentDisplaystringThe user agent as a readable string
userAgentDisplaystring
The user agent as a readable string
userAgentRawstringThe user agent string, the input for the UA parser
userAgentRawstring
The user agent string, the input for the UA parser
userLanguagesarrayuserLanguages object
userLanguagesarray
userLanguages object
Sample Response
JSON View
500An error has occurred and did not complete your request. Please try again
500
An error has occurred and did not complete your request. Please try again
Sample Response
JSON View
Was this page helpful?