Skip to content

Type alias: ClientData

Ƭ ClientData: Object

Type declaration

NameTypeDescription
asn?number | unknownThe autonomous system number (ASN) handling the client's connection.
city_name?string | unknownThe city name of the connecting IP. This is based on MaxMind lookups
client?anyA map of key-value pairs containing additional information about the client, including browser type, version, etc. Example js { "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36", "browser": { "name": "Chrome", "version": "124.0.0.0", "major": "124" }, "engine": { "name": "Blink", "version": "124.0.0.0" }, "os": { "name": "Mac OS", "version": "10.15.7" }, "device": { "vendor": "Apple", "model": "Macintosh" }, "cpu": {} }
country_code?string | unknownThe two-character country code of the visitor’s country
country_name?string | unknownThe country name of the connecting IP. This is based on MaxMind lookups
device_id?stringA UUID that identifies this device. For lite honeypots, this is similar to Amplitude's cookie-based device ID. For a more robust, fingerprint-based device ID, use Honeypot Pro.
identity?stringIf the client provides an identity (e.g. user ID, wallet address), etc for the user, then it will be reflected here.
ip_address?stringThe connecting IP address
ip_address_connecting?stringThe connecting IP address (alias for ip_address)
ip_address_forwarded_for?stringThe IP address of the HTTP proxy (if available). Otherwise, this value will be the same as the connecting IP
latitude?string | unknownThe visitor's approximate latitude (based on the IP address)
longitude?string | unknownThe visitor's approximate longitude (based on the IP address)
org_idstringThe org ID associated with the honeypot
ref?stringA unique reference / request ID.
region_code?string | unknownThe two-digit ISO 3166-2 region code of the visitor (if known). Example ts NY
region_name?string | unknownThe ISO 3166-2 region name of the visitor (if known). Example ts New York
session_id?stringA UUID that identifies the current session for this user. Sessions expired after 30 minutes of inactivity.
timezone?string | unknownThe visitor's timezone Example ts America/New_York