Skip to main content

IP Intel | Node.js SDK

The IP Intel service allows you to retrieve security information about known IP addresses that have been collected across the internet for several decades, giving you insight into the reputation of an IP.

Geolocate

geolocate(ip: string, options: GeolocateOptions): Promise<PangeaResponse<GeolocateResult>>

Retrieve geolocation information for an IP address from a provider, including an optional detailed report.

required parameters

string

The IP to be looked up

Intel.IP.GeolocateOptions

An object of optional parameters. Parameters supported:

  • provider {String} - Use geolocation data from this provider: "digitalelement". Default provider defined by the configuration.
  • verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
  • raw {Boolean} - Include raw data from this provider. Default: raw=false.

Response Object

Promise<PangeaResponse<GeolocateResult>>
const response = await ipIntel.geolocate(
  "1.1.1.1",
  {
    provider: "digitalelement"
  }
);

Domain

getDomain(ip: string, options: DomainOptions): Promise<PangeaResponse<DomainResult>>

Retrieve the domain name associated with an IP address.

required parameters

string

The IP to be looked up

Intel.IP.DomainOptions

An object of optional parameters. Parameters supported:

  • provider {String} - Use data from this provider: "digitalelement". Default provider defined by the configuration.
  • verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
  • raw {Boolean} - Include raw data from this provider. Default: raw=false.

Response Object

Promise<PangeaResponse<DomainResult>>
const response = await ipIntel.getDomain(
  "1.1.1.1",
  {
    provider: "digitalelement"
  }
);

Proxy

isProxy(ip: string, options: ProxyOptions): Promise<PangeaResponse<ProxyResult>>

Determine if an IP address is provided by a proxy service.

required parameters

string

The IP to be looked up

Intel.IP.ProxyOptions

An object of optional parameters. Parameters supported:

  • provider {String} - Use data from this provider: "digitalelement". Default provider defined by the configuration.
  • verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
  • raw {Boolean} - Include raw data from this provider. Default: raw=false.

Response Object

Promise<PangeaResponse<ProxyResult>>
const response = await ipIntel.isProxy(
  "1.1.1.1",
  {
    provider: "digitalelement"
  }
);

VPN

isVPN(ip: string, options: VPNOptions): Promise<PangeaResponse<VPNResult>>

Determine if an IP address is provided by a VPN service.

required parameters

string

The IP to be looked up

Intel.IP.VPNOptions

An object of optional parameters. Parameters supported:

  • provider {String} - Use data from this provider: "digitalelement". Default provider defined by the configuration.
  • verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
  • raw {Boolean} - Include raw data from this provider. Default: raw=false.

Response Object

Promise<PangeaResponse<VPNResult>>
const response = await ipIntel.isVPN(
  "1.1.1.1",
  {
    provider: "digitalelement"
  }
);

Reputation

reputation(ip: string, options: ReputationOptions): Promise<PangeaResponse<ReputationResult>>

Retrieve a reputation score for an IP address from a provider, including an optional detailed report.

required parameters

string

Geolocate this IP and check the corresponding country against

Intel.IP.ReputationOptions

An object of optional parameters. Parameters supported:

  • provider {String} - Use reputation data from this provider: "crowdstrike". Default provider defined by the configuration.
  • verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
  • raw {Boolean} - Include raw data from this provider. Default: raw=false.

Response Object

Promise<PangeaResponse<ReputationResult>>
const response = await ipIntel.reputation(
  "1.1.1.1",
  {
    provider: "crowdstrike"
  }
);