StarNama
API Access

API Documentation

StarNama API Documentation

StarNama Website Intelligence API

The StarNama API helps developers, SEO tools, SaaS platforms, AI agents, and automation systems check website uptime, HTTP status, response time, trust score, detected technologies, robots.txt, sitemap signals, and overall website health through a simple JSON endpoint.

Get your API key

What can you do with the StarNama API?

With StarNama API, you can integrate live website monitoring and website intelligence data directly into your own applications, dashboards, internal tools, GPTs, AI workflows, SEO reports, uptime monitors, and client portals.

  • Check whether a website is online or offline.
  • Retrieve HTTP status codes and response time.
  • Get a StarNama trust score and website grade.
  • Detect basic website technologies such as WordPress, Cloudflare, Next.js, Google Analytics, and more.
  • Check robots.txt and sitemap availability.
  • Use website status data inside AI tools, scripts, apps, and SaaS platforms.

API Endpoint

Use the following endpoint to analyze a domain:

GET https://starnama.com/wp-json/starnama-api/v1/analyze/{domain}

Example:

GET https://starnama.com/wp-json/starnama-api/v1/analyze/example.com

Do not include https://, http://, or trailing slashes in the domain parameter.

Authentication

All paid API requests require an API key. Send your key using the x-api-key request header.

x-api-key: YOUR_API_KEY

You can find your API key inside your StarNama API dashboard after creating an account or subscribing to a plan.

Example cURL Request

curl -H "x-api-key: YOUR_API_KEY" \
https://starnama.com/wp-json/starnama-api/v1/analyze/example.com

Example JSON Response

{
  "domain": "example.com",
  "url": "https://starnama.com/status/example-com/",
  "status": "UP",
  "http_code": 200,
  "response_time_ms": 284,
  "trust_score": 91,
  "grade": "A",
  "owner_verified": false,
  "technology": [
    "Server: cloudflare",
    "WordPress"
  ],
  "title": "Example Website",
  "description": "A short website description.",
  "cms": "WordPress",
  "category": "Business Website",
  "robots": "Detected",
  "sitemap": "Detected",
  "security_headers": {
    "strict-transport-security": "Detected",
    "content-security-policy": "Not detected",
    "x-frame-options": "Detected",
    "x-content-type-options": "Detected",
    "referrer-policy": "Detected"
  },
  "content_words": 1240,
  "last_check": 1778336025,
  "source": "starnama_api"
}

Response Fields Explained

Field Description
domain The domain that was analyzed.
status Shows whether the website is currently UP or DOWN.
http_code The HTTP response code returned by the website.
response_time_ms The measured response time in milliseconds.
trust_score A StarNama trust score based on availability, response, technical signals, and website health.
grade A simple website health grade such as A, B, C, or D.
technology Detected technologies, servers, analytics tools, frameworks, or CMS signals.
robots Indicates whether robots.txt was detected.
sitemap Indicates whether sitemap.xml was detected.
security_headers Basic security header signals detected during the website scan.

Common Use Cases

  • Build a website uptime checker.
  • Add website trust data to your SaaS dashboard.
  • Create AI agents that can analyze websites in real time.
  • Monitor client websites for SEO and technical issues.
  • Show uptime and trust signals inside browser extensions or internal tools.
  • Connect StarNama data with GPTs, automation workflows, and reporting systems.

Status Codes

HTTP Status Meaning
200 The request was successful.
400 The domain format is invalid.
403 The API key is missing, invalid, expired, or inactive.
402 The subscription is inactive, expired, or payment is required.
429 The monthly API quota or rate limit has been exceeded.
500 The server could not complete the analysis.

Rate Limits and Monthly Quota

Every StarNama API plan includes a monthly request quota and rate limit. Your dashboard shows your current plan, used requests, remaining requests, API key, and subscription status.

Cached results may be returned for repeated requests to the same domain in a short period. This helps improve speed and keeps the API stable for all users.

Best Practices

  • Keep your API key private and never expose it in public frontend JavaScript.
  • Send API requests from your server, backend, plugin, SaaS app, or trusted automation system.
  • Cache results on your side when possible.
  • Use clean domain names without protocol or trailing slash.
  • Handle quota errors and invalid key errors gracefully in your application.

JavaScript / Node.js Example

const domain = "example.com";

const response = await fetch(
  `https://starnama.com/wp-json/starnama-api/v1/analyze/${domain}`,
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);

PHP Example

<?php
$domain = "example.com";
$api_key = "YOUR_API_KEY";

$ch = curl_init("https://starnama.com/wp-json/starnama-api/v1/analyze/" . urlencode($domain));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: " . $api_key
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);
?>

FAQ

Do I need an API key?

Yes. StarNama API requires an API key for authenticated access.

Can I use the API inside a GPT or AI agent?

Yes. The StarNama API is designed to work well with GPTs, AI agents, automation tools, SEO workflows, and SaaS platforms.

Can I check new domains?

Yes. If a domain has not been checked before, StarNama can analyze it and return a fresh website intelligence report.

Should I expose my API key in browser JavaScript?

No. API keys should be used only from trusted server-side environments.

Where can I see my usage?

You can view your monthly quota, used requests, remaining requests, active plan, and API key inside your StarNama API dashboard.

Start using StarNama API today

Add live website intelligence, uptime status, trust score, and technical website signals to your apps, reports, dashboards, and AI tools.

Open API Dashboard