Get IP address details

client.radar.entities.get(, ?): EntityGetResponse { ip }

GET/radar/entities/ip

Retrieves IP address information.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

query: EntityGetParams { ip, format }

ip: string

IP address.

formatip

format?: "JSON" | "CSV"

Format in which results will be returned.

One of the following:

"JSON"

"CSV"

ReturnsExpand Collapse

EntityGetResponse { ip }

ip: IP { asn, asnLocation, asnName, 5 more }

asn: string

asnLocation: string

asnName: string

asnOrgName: string

ip: string

ipVersion: string

location: string

locationName: string

Get IP address details

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const entity = await client.radar.entities.get({ ip: '8.8.8.8' });

console.log(entity.ip);

{
  "result": {
    "ip": {
      "asn": "15169",
      "asnLocation": "US",
      "asnName": "GOOGLE",
      "asnOrgName": "Google LLC",
      "ip": "8.8.8.8",
      "ipVersion": "IPv4",
      "location": "GB",
      "locationName": "United Kingdom"
    }
  },
  "success": true
}

Returns Examples

{
  "result": {
    "ip": {
      "asn": "15169",
      "asnLocation": "US",
      "asnName": "GOOGLE",
      "asnOrgName": "Google LLC",
      "ip": "8.8.8.8",
      "ipVersion": "IPv4",
      "location": "GB",
      "locationName": "United Kingdom"
    }
  },
  "success": true
}