51Degrees API Documentation  4.5

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 - Create a Resource Key to configure your cloud request

Things to consider:

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

Licensing: Requires a Resource Key, which is free to create. The free plan includes the country and LocationConfidence, and paid plans add more IP Intelligence properties. See pricing.

On-premise deployment🔗

Best for: High-performance, data-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

Combine Device Detection and IP Intelligence🔗

Best for: Combining device characteristics with network and location data

Benefits:

• Complete user context - Combine location/network data with device characteristics
• Enhanced fraud detection - Cross-reference device properties with IP risk data
• Content delivery - Use device capabilities and geographic location to tailor content
• 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 Rust Node.js Python PHP

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/51degrees-go/ip-intelligence/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

Console applications🔗

1. Add the fiftyone-ip-intelligence crate from crates.io (for example with cargo add fiftyone-ip-intelligence).
2. Choose your deployment option:
   • On-premise Example - Local processing with a data file.
   • Cloud Example - The 51Degrees cloud service, no local data file.

Web integration🔗

For web applications, integrate IP Intelligence into your axum handlers:

• On-premise Web Example - Local processing.

Console applications🔗

1. Install the fiftyone.ipintelligence package from npm, for example with npm install fiftyone.ipintelligence.
2. Choose your deployment option:
   • On-premise Example - Local processing with a data file.
   • Cloud Example - The 51Degrees cloud service, no local data file.
   • Combined Example - Mix IP Intelligence with Device Detection.

Web integration🔗

For web applications, add the Pipeline to your HTTP server:

• On-premise Web Example - Local processing.
• Cloud Web Example - The 51Degrees cloud service.

Console applications🔗

1. Install the fiftyone_ipintelligence package from PyPI, for example with pip install fiftyone_ipintelligence. Building the on-premise engine's native extension from source needs a C++17 compiler.
2. Choose your deployment option:
   • On-premise Example - Local processing with a data file.
   • Cloud Example - The 51Degrees cloud service, no local data file.
   • Combined Example - Mix IP Intelligence with Device Detection.

Web integration (Flask)🔗

• On-premise Web Example - Local processing.
• Cloud Web Example - The 51Degrees cloud service.

Console applications🔗

The 51degrees/fiftyone.ipintelligence package is not on Packagist yet, so use it from a clone of the 51degrees-php repository through a Composer path repository.

1. Clone the repository with its submodules, using git clone --recurse-submodules https://github.com/51Degrees/51degrees-php.git.
2. For on-premise, build the FiftyOneDegreesIpIntelligenceEngine extension and enable it, as OnPremise.md describes. The IP Intelligence and Device Detection extensions can be loaded together in one PHP.
3. Choose your deployment option:
   • On-premise Example - Local processing with a data file.
   • Cloud Example - The 51Degrees cloud service, no local data file.
   • Combined Example - Mix IP Intelligence with Device Detection, which needs both extensions.

Web integration🔗

• On-premise Web Example - Local processing.
• Cloud Web Example - The 51Degrees cloud service.

Have a data or code question? Get in touch and explore subscription options.