Getting Started

DataBee SiteAtlas API turns any domain into clean traffic, SEO, audience, and competitor intelligence.

---

Global Specifications & Base URL

Base URL

https://api.databee.dev

60-second quickstart

1. Generate a free API key in the Developer Console.
2. Copy the request below and replace YOUR_DATABEE_API_KEY.
3. Start with GET /site-overview?url=github.com; successful requests cost 1 credit.

First response

The Site Overview response is a dated intelligence snapshot. Use meta.snapshot_date and traffic.period to show users which reporting period the values represent. Site Similar currently returns ranking and traffic data but does not include meta.snapshot_date.

Authentication Protocols

DataBee APIs require an API key passed via standard HTTP Bearer token authentication in the request headers (or optionally via X-API-Key). Users can generate their free API key from the DataBee Developer Console at https://console.databee.dev:

Authorization: Bearer YOUR_DATABEE_API_KEY

or

X-API-Key: YOUR_DATABEE_API_KEY

Authentication Requirement

Requests without a valid API key will receive an HTTP 401 Unauthorized response. You can generate a free API key at console.databee.dev.

---

Response Headers

Every API response returned by the DataBee Gateway includes standard metadata, usage, and security headers:

Header Name	Type	Description
Content-Type	string	Always application/json; charset=utf-8
X-Gateway-Service	string	The API service identifier (e.g. siteatlas)
X-Gateway-Credit-Cost	number	Credits deducted for this API call (typically 1)
X-Gateway-Remaining-Credits	number	Remaining credit balance in user wallet
X-Gateway-Latency-Ms	number	Response latency in milliseconds
X-RateLimit-Limit	number	Maximum allowed requests per second (RPS)
X-Content-Type-Options	string	Security header set to nosniff
X-Frame-Options	string	Security header set to SAMEORIGIN
X-XSS-Protection	string	Security header set to 1; mode=block

---

Quick Example Request

cURL

curl -X GET "https://api.databee.dev/siteatlas/site-overview?url=github.com" \
  -H "Authorization: Bearer YOUR_DATABEE_API_KEY"

JavaScript (Fetch)

const response = await fetch('https://api.databee.dev/siteatlas/site-overview?url=github.com', {
  headers: {
    'Authorization': 'Bearer YOUR_DATABEE_API_KEY'
  }
});
const data = await response.json();
console.log(data);

Python (Requests)

import requests

url = "https://api.databee.dev/siteatlas/site-overview"
params = {"url": "github.com"}
headers = {"Authorization": "Bearer YOUR_DATABEE_API_KEY"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

Data freshness and interpretation

SiteAtlas traffic and engagement values are estimates unless the response explicitly indicates first-party Google Analytics data. Treat the response metadata as part of the contract:

Field	Meaning
meta.snapshot_date	Date of the underlying data snapshot.
traffic.period	Reporting month for traffic metrics, when available.
traffic.is_data_from_ga	Whether traffic data came from connected Google Analytics data.
traffic.sources_share	Acquisition-channel shares represented as decimals; keys include direct, organic_search, paid_search, organic_social, paid_social, email, referrals, generative_ai, affiliate, and display_ads.
ai_referrals.platforms	AI referral platforms and their rank/share details, with optional monthly history entries.

The examples in this documentation use an illustrative July 2026 snapshot. Always display the returned dates and avoid presenting estimates as real-time measurements.