Skip to main content
API docs by Redocly

LimesIndex API (1.0.0)

Download OpenAPI specification:Download

License: Proprietary

IP Intelligence and Registry API

LimesIndex provides comprehensive IP address intelligence including ASN information, geolocation, datacenter detection, threat scoring, and AI crawler identification.

IP Lookup

IP address intelligence operations

Single IP lookup

Look up intelligence data for a single IP address. Returns ASN information, geolocation, detection flags (datacenter, VPN, proxy, Tor, AI crawler), and threat scoring.

Authorizations:
ApiKeyAuth
path Parameters
ip
required
string
Example: 8.8.8.8

IPv4 or IPv6 address to look up

Responses

Response Headers
X-Request-ID
string <uuid>
Example: "550e8400-e29b-41d4-a716-446655440000"

Unique identifier for the request, useful for debugging and support

X-RateLimit-Limit
integer
Example: "1000"

Maximum number of requests allowed per time window

X-RateLimit-Remaining
integer
Example: "999"

Number of requests remaining in the current time window

X-RateLimit-Reset
integer <int64>
Example: "1704067200"

Unix timestamp when the rate limit window resets

X-Cache-Status
string
Enum: "HIT" "MISS"
Example: "HIT"

Cache status for the request (HIT or MISS)

Response Schema: application/json
required
object (IPLookupResult)

IP address intelligence data

required
object (Meta)

Response metadata

Response samples

Content type
application/json
{
  • "data": {
    • "ip": "8.8.8.8",
    • "prefix": "8.8.8.0/24",
    • "asn": 15169,
    • "asn_name": "Google LLC",
    • "country": "US",
    • "rir": "ARIN",
    • "connection_type": "datacenter",
    • "detection": {
      },
    • "threat": {
      }
    },
  • "meta": {
    • "request_id": "550e8400-e29b-41d4-a716-446655440000",
    • "processing_time_ms": 5,
    • "cache_status": "HIT",
    • "dataset_version": 1
    }
}

Batch IP lookup

Look up intelligence data for multiple IP addresses in a single request. Maximum batch size is 1000 IPs. Returns a map of IP addresses to their lookup results.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
ips
required
Array of strings [ 1 .. 1000 ] items

Array of IP addresses to look up (maximum 1000)

Responses

Response Headers
X-Request-ID
string <uuid>
Example: "550e8400-e29b-41d4-a716-446655440000"

Unique identifier for the request, useful for debugging and support

X-RateLimit-Limit
integer
Example: "1000"

Maximum number of requests allowed per time window

X-RateLimit-Remaining
integer
Example: "999"

Number of requests remaining in the current time window

X-RateLimit-Reset
integer <int64>
Example: "1704067200"

Unix timestamp when the rate limit window resets

Response Schema: application/json
required
object

Map of IP addresses to their lookup results

required
object (Meta)

Response metadata

Request samples

Content type
application/json
{
  • "ips": [
    • "8.8.8.8",
    • "1.1.1.1",
    • "208.67.222.222"
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "8.8.8.8": {
      },
    • "1.1.1.1": {
      }
    },
  • "meta": {
    • "request_id": "550e8400-e29b-41d4-a716-446655440001",
    • "processing_time_ms": 15,
    • "dataset_version": 1
    }
}

ASN Lookup

Autonomous System Number lookup operations

ASN lookup

Look up information for an Autonomous System Number (ASN). Returns the organization name, country, RIR, and optionally associated IP prefixes.

Authorizations:
ApiKeyAuth
path Parameters
asn
required
integer [ 1 .. 4294967295 ]
Example: 15169

Autonomous System Number to look up

query Parameters
include_prefixes
boolean
Default: false

Include associated IP prefixes in the response

prefix_limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of prefixes to return (max 1000)

Responses

Response Headers
X-Request-ID
string <uuid>
Example: "550e8400-e29b-41d4-a716-446655440000"

Unique identifier for the request, useful for debugging and support

X-RateLimit-Limit
integer
Example: "1000"

Maximum number of requests allowed per time window

X-RateLimit-Remaining
integer
Example: "999"

Number of requests remaining in the current time window

Response Schema: application/json
required
ASNInfo (object) or ASNInfoWithPrefixes (object)
required
object (Meta)

Response metadata

Response samples

Content type
application/json
{
  • "data": {
    • "asn": 15169,
    • "name": "Google LLC",
    • "country": "US",
    • "rir": "ARIN",
    • "allocation_date": "2000-03-30"
    },
  • "meta": {
    • "request_id": "550e8400-e29b-41d4-a716-446655440003",
    • "processing_time_ms": 2
    }
}

Search ASNs by name

Search for Autonomous System Numbers by organization name. Uses full-text search for matching.

Authorizations:
ApiKeyAuth
query Parameters
q
required
string >= 2 characters
Example: q=Google

Search query (minimum 2 characters)

limit
integer [ 1 .. 100 ]
Default: 20

Maximum number of results to return (max 100)

Responses

Response Headers
X-Request-ID
string <uuid>
Example: "550e8400-e29b-41d4-a716-446655440000"

Unique identifier for the request, useful for debugging and support

Response Schema: application/json
required
object
required
object (Meta)

Response metadata

Response samples

Content type
application/json
{
  • "data": {
    • "results": [
      ],
    • "count": 2
    },
  • "meta": {
    • "processing_time_ms": 5
    }
}

ASN registry statistics

Get statistics about the ASN registry including total count and breakdown by RIR.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
required
object
required
object (Meta)

Response metadata

Response samples

Content type
application/json
{
  • "data": {
    • "total_asns": 75000,
    • "by_rir": {
      }
    },
  • "meta": {
    • "processing_time_ms": 10
    }
}

Statistics

API usage and dataset statistics

API statistics

Retrieve API cache statistics and dataset information including cache size, dataset version, and feature availability.

Authorizations:
ApiKeyAuth

Responses

Response Headers
X-Request-ID
string <uuid>
Example: "550e8400-e29b-41d4-a716-446655440000"

Unique identifier for the request, useful for debugging and support

Response Schema: application/json
required
object (Stats)

API and dataset statistics

required
object (Meta)

Response metadata

Response samples

Content type
application/json
{
  • "data": {
    • "size": 1000,
    • "version": 1,
    • "geo_enabled": true,
    • "redis_enabled": false
    },
  • "meta": {
    • "processing_time_ms": 0,
    • "dataset_version": 1
    }
}

Dataset version

Returns the current active dataset version. This endpoint is used by edge workers to coordinate cache keys without requiring manual configuration.

Responses

Response Headers
X-Dataset-Version
integer

Dataset version number

Response Schema: application/json
required
object
required
object (Meta)

Response metadata

Response samples

Content type
application/json
{
  • "data": {
    • "version": 42
    },
  • "meta": {
    • "processing_time_ms": 0,
    • "dataset_version": 42
    }
}

Health

Service health and readiness checks

Health check

Liveness probe endpoint. Returns 200 OK if the service is running. This endpoint does not check downstream dependencies.

Responses

Response Schema: text/plain
string

Readiness check

Readiness probe endpoint. Returns 200 OK if the service is ready to accept traffic. Checks database connectivity.

Responses

Response Schema: text/plain
string