Skip to content

Handbook

Quickstart

Get from sign-up to your first IP lookup in a few minutes.

1. Create an account

  1. Open Register and create your iplyt account.
  2. Sign in and open the Dashboard.
  3. Your account starts with a trial — see Billing for plan limits.

2. Create an API key

  1. Go to API keys in the dashboard.
  2. Click New key, enter a name, and save.
  3. Copy the key when it is shown — it is displayed once and cannot be retrieved later.

See API keys for rotation, expiry, and disabling keys.

3. Run your first lookup

Replace YOUR_API_KEY and YOUR_PLATFORM_HOST with your key and iplyt host (for example app.example.com).

curl -s \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://YOUR_PLATFORM_HOST/api/v1/lookup?ip=8.8.8.8"

Example response:

{
  "ip": "8.8.8.8",
  "asn": {
    "number": "15169",
    "name": "GOOGLE",
    "domain": "google.com"
  },
  "location": {
    "city": "Mountain View",
    "state": "California",
    "country_code": "US",
    "continent": "North America",
    "continent_code": "NA",
    "latitude": 37.386,
    "longitude": -122.0838,
    "timezone": "America/Los_Angeles"
  },
  "network": {
    "is_hosting": false
  },
  "organization": {
    "name": "Google LLC"
  }
}

You can also send the key in the X-API-Key header instead of Authorization: Bearer.

Demo on the homepage vs. your API

The live lookup preview on the marketing homepage is powered by an internal server-side proxy. It shows what a lookup returns but does not use your API key and is not the integration endpoint.

For production, always call the platform API at /api/v1/lookup with your API key as shown above.

Next steps