API Documentation
Build with the IPRout IP geolocation API.
Start with one authenticated request, then use the focused guides for response fields, errors, usage, multiple active keys, CORS origin controls, Pro request caps, security, and production troubleshooting.
Last updated September 30, 2026
Build login activity
Turn a captured login IP into approximate location and network context for account history. The use-case guide includes an explicit IP lookup and a Laravel example.
Read the login activity use caseGetting Started
Make the first request, understand the public contract, and choose caller or explicit lookup.
/docs/quickstart
IP Geolocation API Quickstart
Make your first IPRout IP geolocation API request, authenticate it, and read the JSON response.
Open documentation →/docs/base-urls
API Base URL and Endpoints
Use the IPRout production API base URL and choose the correct IP lookup endpoint.
Open documentation →/docs/authentication
API Key Authentication
Authenticate IPRout requests with a Bearer token or X-API-Key header without exposing credentials.
Open documentation →/docs/request-and-response-format
API Request and Response Format
Understand IPRout HTTPS request construction, JSON responses, status handling, and field compatibility.
Open documentation →/docs/headers-and-content-types
HTTP Headers and Content Types
Configure IPRout authentication, Origin, Accept, and content-type handling correctly.
Open documentation →/docs/caller-ip-lookup
Look Up the Caller IP Address
Call GET /ip with no path parameter to geolocate the IP address making the request.
Open documentation →/docs/specific-ip-lookup
Look Up a Specific IP Address
Call GET /ip/{ip} to retrieve GeoIP and ASN data for a supplied IPv4 or IPv6 address.
Open documentation →API Reference
Validate addresses, parse lookup and usage responses, and handle every documented status.
/docs/response-fields
IP Geolocation Response Fields
Understand every field returned by the IPRout IP geolocation and ASN lookup response.
Open documentation →/docs/ip-address-validation
IPv4 and IPv6 Address Validation
Validate explicit IP input before calling IPRout and handle HTTP 422 correctly.
Open documentation →/docs/ipv6-url-encoding
IPv6 URL Encoding for IP Lookup
Construct safe explicit lookup URLs for compressed and full IPv6 addresses.
Open documentation →/docs/usage-endpoint
GET /usage Request Guide
Call GET /usage to inspect monthly request totals, remaining quota, and per-key usage.
Open documentation →/docs/usage-response-fields
GET /usage Response Schema
Interpret account totals, key-level usage, remaining capacity, and timestamps returned by GET /usage.
Open documentation →/docs/errors
HTTP Status Code Reference
Handle IPRout authentication, validation, rate-limit, and server status codes correctly.
Open documentation →/docs/error-response-format
JSON Error Response Schema
Parse IPRout JSON error bodies without confusing them with successful lookup or usage responses.
Open documentation →/docs/rate-limits
Rate Limits and HTTP 429
Understand how IPRout reports exhausted account quotas and per-key request caps.
Open documentation →/docs/quotas-and-plans
API Quotas and Plan Limits
Compare IPRout Free, Starter, and Pro request quotas and active API key allowances.
Open documentation →API Keys & Security
Protect credentials and configure multiple keys, CORS origins, caps, rotation, and privacy boundaries.
/docs/api-key-lifecycle
API Key Governance Lifecycle
Govern the creation, storage, review, rotation, and retirement of IPRout API keys.
Open documentation →/docs/multi-website-api-key-management
Multi-Website API Key Management
Design a multi-site IPRout setup with named active keys, per-key usage visibility, exact CORS origins, and configurable Pro request caps.
Open documentation →/docs/multiple-active-api-keys
Multiple Active Keys by Plan
Compare active-key allowances and separate credentials across applications and environments.
Open documentation →/docs/cors-origin-restrictions
CORS Origin Restrictions for API Keys
Restrict paid-plan API keys to approved browser origins and understand exact origin matching.
Open documentation →/docs/per-key-request-caps
Per-Key Request Caps
Set Pro API key request caps and understand Starter's fixed plan-level cap.
Open documentation →/docs/usage-and-shared-quotas
Shared Quotas Across API Keys
Understand how multiple IPRout keys consume one shared monthly account quota.
Open documentation →/docs/key-rotation-and-revocation
Rotate and Revoke API Keys
Rotate an IPRout API key without downtime and revoke exposed or retired credentials.
Open documentation →/docs/security-best-practices
API Key Security Best Practices
Protect IPRout API credentials with server-side storage, origin restrictions, caps, and rotation.
Open documentation →/docs/browser-integration-and-cors
Browser Integration and CORS
Understand when direct browser lookup is appropriate and how exact IPRout CORS origins constrain paid keys.
Open documentation →/docs/privacy-and-data-handling
Privacy and IP Data Handling
Minimize, protect, retain, and explain IP-derived location and network information responsibly.
Open documentation →Production Integration
Design server boundaries, retries, caching, tests, monitoring, compatibility, and operational configuration.
/docs/server-side-integration
Server-Side IP Lookup Integration
Keep IPRout keys private and integrate caller or explicit IP lookup from trusted application servers.
Open documentation →/docs/environment-configuration
Environment and Secret Configuration
Configure IPRout base URLs and API keys across local, staging, CI, and production environments.
Open documentation →/docs/http-timeouts-and-retries
HTTP Timeouts and Retry Strategy
Configure bounded IPRout request timeouts, backoff, and status-aware retries for production systems.
Open documentation →/docs/caching-strategies
Caching IP Geolocation Responses
Cache IPRout lookup results responsibly while accounting for routing changes, privacy, and quota usage.
Open documentation →/docs/monitoring-and-alerting
API Monitoring and Usage Alerts
Monitor IPRout latency, status codes, shared quota, key caps, and unexpected consumption.
Open documentation →/docs/testing-and-mocking
Testing and Mocking IP Lookup
Test IPRout clients with fixtures, mocked HTTP failures, and controlled integration checks.
Open documentation →/docs/migration-and-versioning
API Compatibility and Versioning
Design IPRout clients for additive response evolution and controlled application migrations.
Open documentation →/docs/data-accuracy-and-limitations
IP Geolocation Accuracy and Limitations
Understand network-location uncertainty, VPN effects, nullable fields, and responsible use of IPRout data.
Open documentation →/docs/troubleshooting
IP Geolocation API Troubleshooting
Diagnose IPRout authentication, invalid IP, CORS, quota, and response parsing problems.
Open documentation →Implementation Use Cases
Apply IP context responsibly to localization, analytics, security review, personalization, and operations.
/docs/localization
IP-Based Localization
Use IP country and timezone as editable localization defaults without treating them as confirmed preferences.
Open documentation →/docs/analytics-enrichment
GeoIP Analytics Enrichment
Add country, region, ASN, and organization context to server-side analytics events.
Open documentation →/docs/security-risk-context
IP Context for Security Review
Combine IPRout location and ASN data with stronger authentication and behavioral security signals.
Open documentation →/docs/fraud-review-context
IP Intelligence for Fraud Review
Use country, ASN, and network organization as explainable supporting signals in fraud workflows.
Open documentation →/docs/content-personalization
Regional Content Personalization
Personalize broad content defaults with IP country while retaining user choice and neutral fallbacks.
Open documentation →/docs/timezone-defaults
Timezone Defaults from IP Location
Suggest an editable IANA timezone from IP context and handle offsets and daylight saving correctly.
Open documentation →/docs/network-operations
ASN and Network Operations Context
Add ASN and organization information to support, outage, and network operations workflows.
Open documentation →/docs/saas-onboarding
GeoIP Defaults for SaaS Onboarding
Reduce onboarding friction with editable country, timezone, currency, and calling-code suggestions.
Open documentation →/docs/geoip-for-micro-saas
GeoIP API Infrastructure for Micro-SaaS
Build reliable, budget-aware IP lookup infrastructure for a micro-SaaS without operating and updating a GeoIP database.
Open documentation →/docs/geoip-for-solo-founders
IP Geolocation and GeoIP API for Solo Founders
Launch a secure, low-maintenance IP lookup API integration with predictable costs, graceful fallbacks, and a one-person runbook.
Open documentation →Tools & Specifications
Work with the OpenAPI contract and Postman documentation.