Public API Documentation

Reference for endpoint methods, request samples, and response formats.

Base URL

http://127.0.0.1:8000/api

Endpoint

GET /ip-lookup

Returns IP location and provider details.

Query Parameters

Parameter	Type	Required	Description
`ip`	string	Yes	Valid IPv4 or IPv6 address. Example: `8.8.8.8`

Sample Request

curl --request GET \
  --url "http://127.0.0.1:8000/api/ip-lookup?ip=8.8.8.8" \
  --header "Accept: application/json"

Success Response (200)

{
  "ip": "8.8.8.8",
  "country": "United States",
  "country_code": "US",
  "region": "California",
  "city": "Mountain View",
  "provider": "Google LLC",
  "organization": "Google Public DNS",
  "asn": 15169,
  "timezone": "America/Los_Angeles"
}

Validation Error (422)

{
  "message": "The ip field must be a valid IP address.",
  "errors": {
    "ip": [
      "The ip field must be a valid IP address."
    ]
  }
}

Provider Error (503)

{
  "message": "IP lookup provider is temporarily unavailable. Please try again shortly."
}