IP lookup

GET 
/lookup/:ip

Get basic information about an IP address including seen status, tags, actor, and classification

Authentication

This endpoint also accepts the API key in the X-API-Key header (recommended) instead of the apikey query parameter. See API keys for details.

Request

Responses

200

Success - Returns document with seen:true if IP is found, or seen:false if IP is not found

Response Headers

X-RateLimit-Limit-Minute

Maximum number of requests allowed per minute

X-RateLimit-Limit-Month

Maximum number of requests allowed per month

X-RateLimit-Remaining-Minute

Number of remaining requests for the current minute

X-RateLimit-Remaining-Month

Number of remaining requests for the current month

400

Bad request - Invalid parameters or IP format

401

Unauthorized - Invalid or missing API key

429

Too Many Requests - API rate limit exceeded

Response Headers

RateLimit-Limit

Maximum number of requests allowed for the current window

RateLimit-Remaining

Number of remaining requests (0 when limit exceeded)

RateLimit-Reset

Number of seconds until the rate limit resets

Retry-After

Number of seconds to wait before retrying the request

500

Server error - Internal server error