Skip to content
Tophhie Cloud Docs

Fetches IP address information for specific IPs, locations, or self.

GET
/ipcheck
curl --request GET \
  --url 'https://api.tophhie.cloud/ipcheck?ip=&location=&reverseCheck=false'

Pass an ip to look up any address, a location shortcut (me returns your own IP, hoyland resolves the Hoyland DDNS record), or omit both to default to me.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
ip

The IP address you’d like to query.

string
""

The IP address you’d like to query.

location

A predefined location you’d like to query. Supported values: me, hoyland.

string
""

A predefined location you’d like to query. Supported values: me, hoyland.

reverseCheck

Indicates whether to perform a reverse DNS lookup on the IP address.

boolean

Indicates whether to perform a reverse DNS lookup on the IP address.

Responses

Section titled “Responses”

200

Section titled “200”

IP lookup successful.

Media typeapplication/json
object
result
required
string
ipVersion
required
integer
mapsUrl
required
object
google
required
string | null format: uri
bing
required
string | null format: uri
apple
required
string | null format: uri
metadata
required
object
status
required
string
country
required
string
countryCode
required
string
region
required
string
regionName
required
string
city
required
string
zip
required
string
lat
required
number
lon
required
number
timezone
required
string
utcOffset
required
integer
isp
required
string
org
required
string
as
required
string
reverse
required
string | null
mobile
required
boolean
proxy
required
boolean
hosting
required
boolean
contacts
required
Array<string>
loc_disclaimer
required
string
support
required
object
url
required
string format: uri
email
required
string format: email
Examplegenerated
{
  "result": "example",
  "ipVersion": 1,
  "mapsUrl": {
    "google": "https://example.com",
    "bing": "https://example.com",
    "apple": "https://example.com"
  },
  "metadata": {
    "status": "example",
    "country": "example",
    "countryCode": "example",
    "region": "example",
    "regionName": "example",
    "city": "example",
    "zip": "example",
    "lat": 1,
    "lon": 1,
    "timezone": "example",
    "utcOffset": 1,
    "isp": "example",
    "org": "example",
    "as": "example",
    "reverse": "example",
    "mobile": true,
    "proxy": true,
    "hosting": true
  },
  "contacts": [
    "example"
  ],
  "loc_disclaimer": "example",
  "support": {
    "url": "https://example.com",
    "email": "hello@example.com"
  }
}

400

Section titled “400”

Bad request — invalid IP address or unsupported location.

Media typeapplication/json
object
status
required
string
Allowed values: error
message
required
string
Example
{
  "status": "error"
}

404

Section titled “404”

Not found — requested location could not be resolved.

Media typeapplication/json
object
status
required
string
Allowed values: error
message
required
string
Example
{
  "status": "error"
}

500

Section titled “500”

Upstream lookup failed.

Media typeapplication/json
object
status
required
string
Allowed values: error
message
required
string
Example
{
  "status": "error"
}