Getting Started

Follow this guide to get your API key and make your first request in under 2 minutes.

Prerequisites

  • A valid email address.
  • Basic knowledge of HTTP requests (curl, JavaScript, Python, etc.).

1. Create an Account

You need an account to generate an API key.

  1. Navigate to the Login Page.
  2. Click "Don't have an account? Sign Up".
  3. Enter your email and password.
  4. You will be automatically redirected to the Dashboard upon success.

2. Generate an API Key

Once in the dashboard, you will see your "API Access" card.

  • Click the Generate New Key button.
  • Your new API key (starting with `sk_...`) will appear.
  • Copy this key immediately. We do not store it in plain text.

3. Make Your First Request

Use your new API key to fetch enriched context for an IP address. Replace `YOUR_API_KEY` with your actual key.

cURL

curl -X GET "https://ultimate-context-api.vercel.app/v1/enrich?ip=8.8.8.8" \
     -H "x-api-key: YOUR_API_KEY"

JavaScript (Fetch)

const apiKey = 'YOUR_API_KEY';

fetch('https://ultimate-context-api.vercel.app/v1/enrich?ip=8.8.8.8', {
  headers: {
    'x-api-key': apiKey
  }
})
.then(response => response.json())
.then(data => console.log(data));

🎉 Success! You have made your first API call.

Explore Full API Reference