The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
API reference
/
Models
ClientIpGeoLocationA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents geolocation information for a client's IP address.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description ipAddress
required string
The IP address of the client.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
continent
required string
The estimated continent where the IP address is located.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
countryCode
required string
The estimated ISO-3166 alpha-2 country code of the IP address.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
countryName
required string
The full name of the estimated country where the IP address is located.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
region
required string
The region or state within the estimated country where the IP address is located.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
city
required string
The estimated city where the IP address is located.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
zipCode
required string
The estimated ZIP code or postal code of the area where the IP address is located.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
latitude
required number (double)
The estimated latitude coordinate of the IP address location.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
longitude
required number (double)
The estimated longitude coordinate of the IP address location.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isp
required string
The estimated Internet Service Provider (ISP) associated with the IP address.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
timezone
required string
The estimated timezone of the location where the IP address is situated.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
domainName
required string
The estimated domain name associated with the IP address.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
elevation
required integer (int32)
The estimated elevation (in meters) of the location where the IP address is situated.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isInBlacklist
required boolean
Whether the IP address is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
usageTypes
required array of string
array of The estimated usage type(s) associated with the IP address.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isProxy
required boolean
Whether the IP address is from a known anonymous proxy server.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
proxyType
required string
The type of proxy, if the IP address is associated with a known proxy service.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Next steps