\r\n

51Degrees API Documentation  4.5

Search

Documentation

• IP Intelligence
• IP Intelligence Quick Start

IP Intelligence Quick Start

Getting Started with IP Intelligence

IP Intelligence provides geolocation, ISP, connection type, and network information from IP addresses. It helps enhance user experience, security, and content delivery.

Choose Your Integration

Cloud API

Best for: Quick deployment, minimal infrastructure, always up-to-date data

Benefits:

• No infrastructure - No servers or data files to manage
• Always updated - Latest IP intelligence data automatically
• Quick setup - Get running in minutes with just an API key

Things to consider:

• Internet dependency - Requires network connectivity
• Latency - Network round-trip time for each request
• Data processing - Occurs on 51Degrees infrastructure

Licensing: Will require a Resource Key once launched. Contact us to start your IP Intelligence trial.

On-premise Deployment

Best for: High-performance, privacy-sensitive, or offline environments

Benefits:

• Ultra-low latency - Sub-millisecond detection time with in-process deployment
• Data processing - Stays within your infrastructure with optional usage sharing available
• High throughput - Designed for high-load scenarios
• Offline capable - No internet dependency for detection
• Full control - Customize update schedules and deployment architecture

Things to consider:

• Setup required - Initial configuration and data file management
• Resource usage - Uses local CPU/RAM (optimized but measurable)
• Automatic update - Daily automated updates without restarting the process

Licensing: Requires a License Key

Combined Device Detection + IP Intelligence

Best for: Comprehensive user profiling and enhanced accuracy

Benefits:

• Complete user context - Combine location/network data with device characteristics
• Enhanced fraud detection - Cross-reference device properties with IP risk data
• Optimized content delivery - Device capabilities + geographic location for perfect targeting
• Advanced analytics - Rich user segmentation with both device and location dimensions

Things to consider:

• Multiple engines - Requires configuration of both Device Detection and IP Intelligence
• Data file management - Need both device data files (.hash) and IP data files (.ipi) for On-premise
• Resource usage - Combined memory and CPU usage for both engines

Licensing: Requires licenses for both Device Detection and IP Intelligence services

Language-Specific Integration

Select your language below for detailed setup instructions:

C C++ C# Java Go

Select a language.

C does not have a Pipeline implementation or the ability to use the cloud-based version of IP intelligence. To get started with C IP intelligence On-premise:

1. Clone the GitHub repository.
2. Ensure all submodules are checked out by running git submodule update --init --recursive in the repository.
3. Follow the installation instructions to get set up with the project.
4. Follow the linked example here: Getting Started.
5. To run the example, contact us to obtain an enterprise IPI data file.

C++ does not have a Pipeline implementation or the ability to use the cloud-based version of IP intelligence. To get started with C++ IP intelligence On-premise:

1. Clone the GitHub repository.
2. Ensure all submodules are checked out by running git submodule update --init --recursive in the repository.
3. Follow the installation instructions to get set up with the project.
4. Follow the linked example here: Getting Started.
5. To run the example, contact us to obtain an enterprise IPI data file.

Console Applications

1. Install the FiftyOne.IpIntelligence package via Nuget.
2. Choose your deployment option:
   • Cloud Example - Uses 51Degrees Cloud API for processing
   • On-premise Example - Local processing with data files
   • Combined Example - Mix IP Intelligence with Device Detection

Web Applications (ASP.NET Core)

1. Install the FiftyOne.IpIntelligence and FiftyOne.Pipeline.Web packages via Nuget.
2. Follow the web integration guide to add the Pipeline middleware.
3. Choose your deployment option:
   • Cloud Web Example - Uses 51Degrees Cloud API
   • On-premise Web Example - Local processing
   • Combined Web Example - Mix IP Intelligence with Device Detection

Console Applications

1. Add the IP Intelligence dependency to your project:
   <dependency>

   <groupId>com.51degrees</groupId>

   <artifactId>ip-intelligence</artifactId>

   </dependency>
   Check Maven Central for the latest version.
2. Choose your deployment option:
   • On-premise Example - Local processing with data files

Web Integration

For web applications, add the web integration dependency:

<dependency>

<groupId>com.51degrees</groupId>

<artifactId>pipeline.web</artifactId>

</dependency>

Choose your deployment option:

• On-premise Web Example - Local processing

Console Applications

1. Install the IP Intelligence package:
   go get github.com/51Degrees/ip-intelligence-go/v4
2. Choose your deployment option:
   • On-premise Example - Local processing with data files

Web Integration

For web applications, you can integrate IP Intelligence into your HTTP handlers:

• On-premise Web Example - Local processing

Generated by doxygen 1.8.15