Your Service API: Documentation and Code Examples

Our service provides a powerful and easy-to-use API for domain intelligence, monitoring, and automation. Whether you're integrating domain tracking into your application, building security tools, or simply analyzing domain data, our API is designed to be flexible and developer-friendly. In this guide, we'll walk through how to get your API key, explore code examples in multiple programming languages, and demonstrate how to use webhooks for real-time notifications.

How to Obtain an API Key

Access to our API begins with authentication. Each user must generate a unique API key, which is used to authorize requests and track usage. Here's how to get started:

• Log into your account on our service platform.
• Navigate to the API Access section in your user dashboard.
• Click Generate API Key. A key will be created and shown once.
• Copy and store your key securely. You’ll need it for every API request.

Your API key should be included in the request header using the following format:

Authorization: Bearer YOUR_API_KEY

Be sure to keep your key private. If it is compromised, you can revoke it and generate a new one at any time.

API Request Examples in Different Languages

To make integration simple, here are basic request examples in Python, JavaScript (Node.js), and cURL. These examples demonstrate how to fetch domain registration data using our /v1/domain endpoint.

Python (using requests)

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

params = {
    'domain': 'example.com'
}

response = requests.get('https://api.yourservice.com/v1/domain', headers=headers, params=params)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")

Node.js (using axios)

const axios = require('axios');

axios.get('https://api.yourservice.com/v1/domain', {
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    },
    params: {
        domain: 'example.com'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error('Error:', error.response.status);
});

cURL

curl -X GET "https://api.yourservice.com/v1/domain?domain=example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Webhook for Change Notifications

Our API also supports webhooks — automated HTTP callbacks that allow your application to receive real-time notifications when a domain’s data changes. This feature is especially useful for monitoring domain statuses, DNS updates, or changes in ownership.

To configure a webhook:

• Go to your dashboard and open the Webhooks section.
• Click Add Webhook.
• Enter the URL of your endpoint that will receive the POST requests.
• Choose the event types you want to subscribe to (e.g., domain_update, dns_change).
• Click Save. You will start receiving JSON payloads to your endpoint whenever changes are detected.

Example webhook payload:

{
  "event": "domain_update",
  "domain": "example.com",
  "changes": {
    "status": "clientTransferProhibited",
    "updatedAt": "2025-04-15T09:13:00Z"
  }
}

Make sure your webhook endpoint validates incoming requests and uses a secret or token for authentication. We also recommend responding with HTTP 200 to acknowledge receipt.

Reliable and Developer-Friendly Integration

Our API was built with developers in mind — with detailed documentation, predictable response structures, and support for both real-time and batch operations. Whether you're building internal tools or commercial platforms, our domain intelligence API provides the functionality and scalability you need.

Explore the full API documentation in your dashboard to discover advanced filtering, bulk queries, usage limits, and SDKs for faster integration. With the right setup, you can automate domain research, monitoring, and alerting — all from a single interface.