DataBee API Hub — SiteAtlas API Reference & Error Catalog

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

1. Global Specifications & Authentication

Base URL

https://api.databee.dev

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:

http

Authorization: Bearer YOUR_DATABEE_API_KEY

http

X-API-Key: YOUR_DATABEE_API_KEY

NOTE

Requests without a valid API key will receive an HTTP 401 Unauthorized response. Users can generate their free API key from the DataBee Developer Console at https://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`

Direct Gateway & RapidAPI Access

DataBee APIs are accessible through the Direct Gateway (https://api.databee.dev) or via RapidAPI Hub.

Direct Gateway Access (Recommended)

Base URL: https://api.databee.dev
Developer Console: https://console.databee.dev
Authentication: Authorization: Bearer YOUR_DATABEE_API_KEY

RapidAPI Access (Recommended Listing)

For new RapidAPI integrations, use the trademark-free SiteAtlas listing:

Base URL: https://siteatlas.p.rapidapi.com
Host Header: x-rapidapi-host: siteatlas.p.rapidapi.com

WARNING

Migration note: The similarweb-api-pro.p.rapidapi.com listing is retained for existing integrations only and may be removed by RapidAPI because of trademark compliance policies. Similarweb has previously taken down API listings for trademark-related reasons, so users should migrate the listing to siteatlas.p.rapidapi.com even if they already use its v2 endpoints. New applications should use the SiteAtlas listing.

Legacy RapidAPI listing (migration only)

Existing integrations may continue using https://similarweb-api-pro.p.rapidapi.com with x-rapidapi-host: similarweb-api-pro.p.rapidapi.com while migrating. The response body is the same as the SiteAtlas listing.

Direct Portal vs RapidAPI Access Comparison

While both access methods connect to the same underlying APIs, we strongly encourage developers to use Direct Portal Access at databee.dev or generate free keys at console.databee.dev for better pricing, credit rollover, and support guarantees.

Comparison Matrix

Feature	Direct Portal (`databee.dev` / `console.databee.dev`)	RapidAPI Marketplace
Pricing & Cost	Save up to 40% on credit pricing	Standard marketplace pricing
Free Credits	500 Free Credits (100 recurring monthly + 400 trial credits on sign-up)	No free credits included
Credit Validity	Credits remain valid for up to 12 months	Monthly plan with no credit rollover
Billing Precision	Only successful requests are charged	Charged against plan & overage rules
On Cancellation	Credits remain active in your wallet for up to 12 months	Unused quota is deleted instantly
Support & Refunds	Direct 24/7 provider support & instant credit restoration	Support responses take 3–4 business days
Listing Risk	Permanent direct provider SLA	Listings can be removed due to marketplace policies

RapidAPI Specific Request Headers & Examples

Calling via RapidAPI requires passing the RapidAPI proxy headers (x-rapidapi-host, x-rapidapi-key) plus optional platform Authorization: Bearer <key> header:

Recommended Trademark-Free RapidAPI Listing (`siteatlas.p.rapidapi.com`)

bash

curl --request GET \
  --url 'https://siteatlas.p.rapidapi.com/site-overview?url=github.com' \
  --header 'Content-Type: application/json' \
  --header 'x-rapidapi-host: siteatlas.p.rapidapi.com' \
  --header 'x-rapidapi-key: YOUR_RAPIDAPI_KEY'

Legacy RapidAPI Listing — Migration Only (`similarweb-api-pro.p.rapidapi.com`)

bash

curl --location 'https://similarweb-api-pro.p.rapidapi.com/site-overview?url=microsoft.com' \
  --header 'x-rapidapi-host: similarweb-api-pro.p.rapidapi.com' \
  --header 'x-rapidapi-key: YOUR_RAPIDAPI_KEY' \
  --header 'Authorization: Bearer YOUR_DATABEE_API_KEY'

CAUTION

Bearer Token Requirement: On certain listings, omitting the Authorization: Bearer <key> header on RapidAPI requests will result in an HTTP 401 Unauthorized response:

json

{
  "error": "Unauthorized",
  "message": "This marketplace requires a valid API key in the Authorization: Bearer <key> header.",
  "service": "SiteAtlas"
}

RapidAPI Response Header Differences

When making requests through RapidAPI, the gateway attaches additional RapidAPI-specific response headers:

Header Name	Type	Description
`x-ratelimit-requests-limit`	`number`	RapidAPI monthly request quota limit
`x-ratelimit-requests-remaining`	`number`	RapidAPI remaining monthly request quota
`x-ratelimit-requests-reset`	`number`	Epoch timestamp when RapidAPI quota resets
`x-rapidapi-region`	`string`	AWS region handling the RapidAPI proxy edge
`x-rapidapi-request-id`	`string`	Unique RapidAPI request execution identifier

Note: The returned JSON response body payload is identical between direct DataBee API calls and RapidAPI proxy calls.

RapidAPI vs Direct Access Code Comparison

Direct Gateway Access (Recommended)

bash

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

RapidAPI Proxy Access

When routing requests through RapidAPI, pass the RapidAPI proxy headers:

bash

curl -X GET "https://siteatlas.p.rapidapi.com/site-overview?url=github.com" \
  -H "x-rapidapi-host: siteatlas.p.rapidapi.com" \
  -H "x-rapidapi-key: YOUR_RAPIDAPI_KEY"

javascript

// JavaScript (Fetch) via RapidAPI
const response = await fetch('https://siteatlas.p.rapidapi.com/site-overview?url=github.com', {
  headers: {
    'x-rapidapi-host': 'siteatlas.p.rapidapi.com',
    'x-rapidapi-key': 'YOUR_RAPIDAPI_KEY'
  }
});
const data = await response.json();

python

# Python (Requests) via RapidAPI
import requests

url = "https://siteatlas.p.rapidapi.com/site-overview"
headers = {
    "x-rapidapi-host": "siteatlas.p.rapidapi.com",
    "x-rapidapi-key": "YOUR_RAPIDAPI_KEY"
}
response = requests.get(url, params={"url": "github.com"}, headers=headers)
print(response.json())

2. API Endpoints

2.1 Site Overview (`GET /site-overview`)

Retrieves comprehensive domain metrics including visit history, engagement, bounce rate, pages per visit, global/country/category ranks, top traffic geography, SEO keywords, and AI referral traffic (ChatGPT, Gemini, Claude, etc.).

HTTP Method: GET
Path: /site-overview
Credit Cost: 1 Credit

Query Parameters

Parameter	Type	Required	Description	Example
`url`	`string`	Yes	Fully qualified domain name or domain string	`github.com`

Example Request

bash

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

Example 200 OK Response

json

{
  "status": "success",
  "meta": {
    "request": {
      "url": "github.com"
    },
    "snapshot_date": "2026-07-01",
    "data_coverage": "complete"
  },
  "website": {
    "domain": "github.com",
    "title": "GitHub · Change is constant. GitHub keeps you ahead.",
    "description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
    "category": {
      "slug": "computers_electronics_and_technology/programming_and_developer_software",
      "name": "Computers Electronics and Technology > Programming and Developer Software"
    },
    "images": {
      "favicon_url": "https://site-images.similarcdn.com/image?url=github.com&h=6525c30f1af9ea5ee8912788b611744e1debcba39a2d0dd3d410b2916169883b&t=2",
      "screenshot_desktop_url": "https://site-images.similarcdn.com/image?url=github.com&h=6525c30f1af9ea5ee8912788b611744e1debcba39a2d0dd3d410b2916169883b&t=1",
      "screenshot_mobile_url": "https://site-images.similarcdn.com/image?url=github.com&h=6525c30f1af9ea5ee8912788b611744e1debcba39a2d0dd3d410b2916169883b&t=4"
    },
    "flags": {
      "is_small_site": false,
      "is_from_google_analytics": false
    }
  },
  "rankings": {
    "global": {
      "rank": 49
    },
    "country": {
      "country_code": "US",
      "rank": 79
    },
    "category": {
      "category_slug": "computers_electronics_and_technology/programming_and_developer_software",
      "rank": 4
    },
    "global_category": null
  },
  "traffic": {
    "is_data_from_ga": false,
    "history": [
      { "month": "2026-05-01", "visits": 636075828 },
      { "month": "2026-06-01", "visits": 615239605 },
      { "month": "2026-07-01", "visits": 637885711 }
    ],
    "engagement": {
      "pages_per_visit": 5.87,
      "bounce_rate": 0.363,
      "average_visit_duration_seconds": 386.157
    },
    "sources_share": {
      "direct": 0.5233,
      "organic_search": 0.2511,
      "paid_search": 0.0002,
      "organic_social": 0.0916,
      "paid_social": 0.0013,
      "email": 0.0116,
      "referrals": 0.0974,
      "generative_ai": 0.0208,
      "affiliate": 0,
      "display_ads": 0.0026
    },
    "geography_share": [
      { "country_code": "US", "share": 0.1943 },
      { "country_code": "CN", "share": 0.1091 },
      { "country_code": "IN", "share": 0.1044 },
      { "country_code": "RU", "share": 0.0804 },
      { "country_code": "DE", "share": 0.0407 }
    ],
    "period": "2026-07"
  },
  "seo": {
    "top_keywords": [
      {
        "keyword": "github",
        "search_volume": 9503160,
        "cpc_usd": 1.66,
        "estimated_value_usd": 10930450
      },
      {
        "keyword": "zapret",
        "search_volume": 597690,
        "cpc_usd": 0.86,
        "estimated_value_usd": 702890
      },
      {
        "keyword": "github desktop",
        "search_volume": 306030,
        "cpc_usd": 2.09,
        "estimated_value_usd": 438200
      },
      {
        "keyword": "запрет дискорд ютуб",
        "search_volume": 139220,
        "cpc_usd": null,
        "estimated_value_usd": 437770
      },
      {
        "keyword": "запрет",
        "search_volume": 253170,
        "cpc_usd": null,
        "estimated_value_usd": 437690
      }
    ]
  },
  "ai_referrals": {
    "total_visits": 11619886,
    "global_traffic_share": 0.0187,
    "platforms": [
      {
        "name": "chatgpt.com",
        "rank": 1,
        "share": 58.6502,
        "history": [
          { "month": "2026-05", "share": 58.462 },
          { "month": "2026-06", "share": 55.4085 },
          { "month": "2026-07", "share": 58.6502 }
        ]
      },
      {
        "name": "gemini.google.com",
        "rank": 2,
        "share": 18.4489,
        "history": [
          { "month": "2026-05", "share": 14.314 },
          { "month": "2026-06", "share": 15.987 },
          { "month": "2026-07", "share": 18.4489 }
        ]
      },
      {
        "name": "claude.ai",
        "rank": 3,
        "share": 16.2959,
        "history": [
          { "month": "2026-05", "share": 13.5879 },
          { "month": "2026-06", "share": 15.3942 },
          { "month": "2026-07", "share": 16.2959 }
        ]
      },
      { "name": "perplexity.ai", "rank": 4, "share": 0, "history": [] },
      { "name": "chat.deepseek.com", "rank": 5, "share": 0, "history": [] },
      { "name": "grok.com", "rank": 6, "share": 0, "history": [] },
      { "name": "copilot.microsoft.com", "rank": 7, "share": 0, "history": [] }
    ],
    "top_prompts": [
      "How do I create a new remote repository, push an existing local project to it, and manage branches using a distributed version control platform?",
      "What are the key differences between using a hosted code repository service versus self-hosting for collaborative source control, and which is better for small teams?",
      "Can you provide a step-by-step guide to forking a project, making changes in a feature branch, and creating a pull request to propose those changes to the original repository?"
    ]
  }
}

2.2 Site Similar (`GET /site-similar`)

Finds related websites, competitor metadata, traffic totals, rankings, and images for a target domain.

HTTP Method: GET
Path: /site-similar
Credit Cost: 1 Credit

Query Parameters

Parameter	Type	Required	Description	Example
`url`	`string`	Yes	Target domain	`github.com`

Example Request

bash

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

Example 200 OK Response

json

{
  "status": "success",
  "meta": {
    "request": { "url": "github.com" },
    "website": "github.com",
    "data_coverage": "complete"
  },
  "website": {
    "domain": "github.com",
    "title": "GitHub · Build and ship software on a single, collaborative platform",
    "description": "Join the world's most widely adopted, AI-powered developer platform...",
    "category": {
      "slug": "Computers_Electronics_and_Technology/Programming_and_Developer_Software",
      "name": "Computers Electronics and Technology > Programming and Developer Software"
    },
    "tags": ["ruby", "ruby on rails", "github"],
    "images": {
      "favicon_url": "https://site-images.similarcdn.com/image?url=github.com&t=2",
      "screenshot_desktop_url": "https://site-images.similarcdn.com/image?url=github.com&t=1",
      "screenshot_mobile_url": "https://site-images.similarcdn.com/image?url=github.com&t=4"
    }
  },
  "rankings": {
    "global": { "rank": null },
    "country": {
      "country_code": "US",
      "country_name": "United States of America",
      "rank": 90
    },
    "category": {
      "category_slug": "Computers_Electronics_and_Technology/Programming_and_Developer_Software",
      "rank": 4
    }
  },
  "traffic": {
    "total_visits": 513197610.36
  },
  "similar_sites": [
    {
      "domain": "stackoverflow.com",
      "title": "Newest Questions",
      "description": "Stack Overflow | The World’s Largest Online Community for Developers",
      "rankings": {
        "global": { "rank": 978 },
        "country": {
          "country_code": "US",
          "country_name": "United States of America",
          "rank": 968
        },
        "category": { "category_slug": null, "rank": 39 }
      },
      "traffic": { "total_visits": 69124392.197 },
      "images": {
        "favicon_url": "https://site-images.similarcdn.com/image?url=stackoverflow.com&t=2&h=04179ebf8566da481b023bba12856a0748752b1e4a75d1b145220282ef93f21c",
        "screenshot_desktop_url": "https://site-images.similarcdn.com/image?url=stackoverflow.com&t=1&h=04179ebf8566da481b023bba12856a0748752b1e4a75d1b145220282ef93f21c",
        "screenshot_mobile_url": "https://site-images.similarcdn.com/image?url=stackoverflow.com&t=4&h=04179ebf8566da481b023bba12856a0748752b1e4a75d1b145220282ef93f21c"
      }
    }
  ]
}

2.3 Country Metadata (`GET /country-metadata`)

Returns standard ISO 3166-1 numeric, alpha-2, and alpha-3 country code mappings and geographic reference metadata used across SiteAtlas reports.

HTTP Method: GET
Path: /country-metadata
Credit Cost: 1 Credit

Query Parameters

None.

Example Request

bash

curl -X GET "https://api.databee.dev/siteatlas/country-metadata" \
  -H "Authorization: Bearer YOUR_DATABEE_API_KEY"

Example 200 OK Response

json

{
  "status": "success",
  "meta": {
    "count": 249,
    "standard": "ISO 3166-1"
  },
  "countries": [
    {
      "name": "United States",
      "alpha2": "US",
      "alpha3": "USA",
      "numeric": "840"
    },
    {
      "name": "India",
      "alpha2": "IN",
      "alpha3": "IND",
      "numeric": "356"
    }
  ]
}

2.4 Legacy / Deprecated Endpoints

WARNING

The endpoints below are maintained for backward compatibility. New applications should use site-overview and site-similar.

GET `/similar-sites` (Deprecated)

Alias For: /site-similar
Status Code: 200 OK
Response Format: Returns the current SiteAtlas v2 envelope with top-level website, rankings, traffic, and similar_sites objects.

GET `/website-overview` (Deprecated)

Alias For: /site-overview
Status Code: 200 OK
Response Format: Returns the same current SiteOverviewResponse envelope as /site-overview.

3. Exhaustive Error Status Codes & Response Catalog (4XX & 5XX)

This section documents every error status code, HTTP header, and JSON error response structure emitted by the API gateway and backend services.

Status Code	Error Title / Code	Cause
`400 Bad Request`	`MISSING_PARAMETER`	Required `url` query parameter was omitted or empty
`400 Bad Request`	`INVALID_DOMAIN`	`url` parameter cannot be parsed as a valid domain (IP, script tag, syntax error)
`401 Unauthorized`	`Unauthorized`	Missing or invalid API key, or bad Authorization header format
`402 Payment Required`	`Payment Required`	User credit balance is zero or insufficient to cover the endpoint cost
`404 Not Found`	`Not Found`	Non-existent route under service (`/siteatlas/foo`) or unknown API service (`/foo`)
`405 Method Not Allowed`	`Method Not Allowed`	Calling endpoint with unsupported HTTP verb (`POST`, `PUT`, `DELETE`, `PATCH`)
`413 Payload Too Large`	`Payload Too Large`	Request body exceeds gateway 10MB limit
`429 Too Many Requests`	`Too Many Requests`	Request rate exceeded allowable requests per second (RPS) limit
`500 Internal Error`	`Internal Server Error`	Unhandled gateway runtime error or database binding failure
`502 Bad Gateway`	`Bad Gateway`	Upstream backend service unreachable or returned connection refusal (Credits refunded)
`504 Gateway Timeout`	`Gateway Timeout`	Upstream backend service exceeded hard execution timeout (Credits refunded)

3.1 HTTP 400 Bad Request

Case A: Missing Parameter (`MISSING_PARAMETER`)

Triggered when the required url query parameter is missing or empty (?url=).

http

HTTP/2 400 Bad Request
Content-Type: application/json; charset=utf-8

json

{
  "status": "error",
  "error": {
    "code": "MISSING_PARAMETER",
    "message": "The 'website' query parameter is required.",
    "target": "url",
    "rejected_value": null,
    "timestamp": "2026-08-11T16:34:02Z"
  }
}

Case B: Invalid Domain Format (`INVALID_DOMAIN`)

Triggered when the domain input contains an IP address (1.1.1.1), invalid domain characters, or injection attempts (<script>).

http

HTTP/2 400 Bad Request
Content-Type: application/json; charset=utf-8

json

{
  "status": "error",
  "error": {
    "code": "INVALID_DOMAIN",
    "message": "The provided domain string cannot be parsed into a valid fully qualified domain name.",
    "target": "url",
    "rejected_value": "not_a_valid_domain",
    "timestamp": "2026-08-11T16:34:06Z"
  },
  "meta": {
    "request": {
      "url": "not_a_valid_domain"
    }
  }
}

3.2 HTTP 401 Unauthorized

Case A: Missing API Key Header

Triggered when no Authorization or X-API-Key header is supplied.

http

HTTP/2 401 Unauthorized
Content-Type: application/json; charset=utf-8

json

{
  "error": "Unauthorized",
  "message": "Missing API key. Provide API key via Bearer token or X-API-Key header.",
  "service": "SiteAtlas"
}

Case B: Invalid or Revoked API Key / Bad Header Format

Triggered when using Basic scheme, malformed key, or an invalid token string.

http

HTTP/2 401 Unauthorized
Content-Type: application/json; charset=utf-8

json

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "service": "SiteAtlas"
}

3.3 HTTP 402 Payment Required

Triggered when the API key belongs to an account with zero or negative credit balance.

http

HTTP/2 402 Payment Required
Content-Type: application/json; charset=utf-8
X-Gateway-Credit-Cost: 1

json

{
  "error": "Payment Required",
  "message": "Insufficient credits to perform this request.",
  "service": "SiteAtlas",
  "remainingBalance": 0
}

3.4 HTTP 404 Not Found

Case A: Unknown Route Under Known Service (`/siteatlas/unknown`)

http

HTTP/2 404 Not Found
Content-Type: application/json; charset=utf-8

json

{
  "detail": "Not Found"
}

Case B: Unknown Service Root (`/nonexistentservice/endpoint`)

http

HTTP/2 404 Not Found
Content-Type: application/json; charset=utf-8

json

{
  "error": "Not Found",
  "message": "The requested API endpoint was not found.",
  "documentation_url": "https://docs.databee.dev"
}

3.5 HTTP 405 Method Not Allowed

Triggered when issuing POST, PUT, DELETE, or PATCH requests to GET-only endpoints.

http

HTTP/2 405 Method Not Allowed
Content-Type: application/json; charset=utf-8

json

{
  "detail": "Not Found"
}

3.6 HTTP 413 Payload Too Large

Triggered when sending request body exceeding 10MB limit.

http

HTTP/2 413 Payload Too Large
Content-Type: application/json; charset=utf-8

json

{
  "error": "Payload Too Large",
  "message": "Request body exceeds 10MB limit."
}

3.7 HTTP 429 Too Many Requests

Triggered when request frequency exceeds maximum allowed requests per second (RPS).

http

HTTP/2 429 Too Many Requests
Content-Type: application/json; charset=utf-8
Retry-After: 1
X-RateLimit-Limit: 3
X-RateLimit-Remaining: 0

json

{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Maximum requests per second reached.",
  "service": "SiteAtlas"
}

3.8 HTTP 500 Internal Server Error

Triggered on internal gateway infrastructure or database execution errors.

http

HTTP/2 500 Internal Server Error
Content-Type: application/json; charset=utf-8

json

{
  "error": "Internal Server Error",
  "message": "Internal gateway failure."
}

3.9 HTTP 502 Bad Gateway

Triggered when backend service fails to connect or responds with network errors. Credits are automatically refunded.

http

HTTP/2 502 Bad Gateway
Content-Type: application/json; charset=utf-8

json

{
  "messages": "The API is unreachable, please contact the API provider",
  "info": "Your Client (working) ---> Gateway (working) ---> API (not working)"
}

3.10 HTTP 504 Gateway Timeout

Triggered when backend service exceeds execution timeout. Credits are automatically refunded.

http

HTTP/2 504 Gateway Timeout
Content-Type: application/json; charset=utf-8

json

{
  "messages": "The request to the API has timed out. Please try again later, or if the issue persists, please contact the API provider",
  "info": "Your Client (working) ---> Gateway (working) ---> API (took too long to respond)"
}

DataBee API Hub — SiteAtlas API Reference & Error Catalog ​

1. Global Specifications & Authentication ​

Base URL ​

Authentication Protocols ​

Response Headers ​

Direct Gateway & RapidAPI Access ​

Direct Gateway Access (Recommended) ​

RapidAPI Access (Recommended Listing) ​

Legacy RapidAPI listing (migration only) ​

Direct Portal vs RapidAPI Access Comparison ​

Comparison Matrix ​

RapidAPI Specific Request Headers & Examples ​

Recommended Trademark-Free RapidAPI Listing (siteatlas.p.rapidapi.com) ​

Legacy RapidAPI Listing — Migration Only (similarweb-api-pro.p.rapidapi.com) ​

RapidAPI Response Header Differences ​

RapidAPI vs Direct Access Code Comparison ​

Direct Gateway Access (Recommended) ​

RapidAPI Proxy Access ​

2. API Endpoints ​

2.1 Site Overview (GET /site-overview) ​

Query Parameters ​

Example Request ​

Example 200 OK Response ​

2.2 Site Similar (GET /site-similar) ​

Query Parameters ​

Example Request ​

Example 200 OK Response ​

2.3 Country Metadata (GET /country-metadata) ​

Query Parameters ​

Example Request ​

Example 200 OK Response ​

2.4 Legacy / Deprecated Endpoints ​

GET /similar-sites (Deprecated) ​

GET /website-overview (Deprecated) ​

3. Exhaustive Error Status Codes & Response Catalog (4XX & 5XX) ​

3.1 HTTP 400 Bad Request ​

Case A: Missing Parameter (MISSING_PARAMETER) ​

Case B: Invalid Domain Format (INVALID_DOMAIN) ​

3.2 HTTP 401 Unauthorized ​

Case A: Missing API Key Header ​

Case B: Invalid or Revoked API Key / Bad Header Format ​

3.3 HTTP 402 Payment Required ​

3.4 HTTP 404 Not Found ​

Case A: Unknown Route Under Known Service (/siteatlas/unknown) ​

Case B: Unknown Service Root (/nonexistentservice/endpoint) ​

3.5 HTTP 405 Method Not Allowed ​

3.6 HTTP 413 Payload Too Large ​

3.7 HTTP 429 Too Many Requests ​

3.8 HTTP 500 Internal Server Error ​

3.9 HTTP 502 Bad Gateway ​

3.10 HTTP 504 Gateway Timeout ​

DataBee API Hub — SiteAtlas API Reference & Error Catalog

1. Global Specifications & Authentication

Base URL

Authentication Protocols

Response Headers

Direct Gateway & RapidAPI Access

Direct Gateway Access (Recommended)

RapidAPI Access (Recommended Listing)

Legacy RapidAPI listing (migration only)

Direct Portal vs RapidAPI Access Comparison

Comparison Matrix

RapidAPI Specific Request Headers & Examples

Recommended Trademark-Free RapidAPI Listing (`siteatlas.p.rapidapi.com`)

Legacy RapidAPI Listing — Migration Only (`similarweb-api-pro.p.rapidapi.com`)

RapidAPI Response Header Differences

RapidAPI vs Direct Access Code Comparison

Direct Gateway Access (Recommended)

RapidAPI Proxy Access

2. API Endpoints

2.1 Site Overview (`GET /site-overview`)

Query Parameters

Example Request

Example 200 OK Response

2.2 Site Similar (`GET /site-similar`)

Query Parameters

Example Request

Example 200 OK Response

2.3 Country Metadata (`GET /country-metadata`)

Query Parameters

Example Request

Example 200 OK Response

2.4 Legacy / Deprecated Endpoints

GET `/similar-sites` (Deprecated)

GET `/website-overview` (Deprecated)

3. Exhaustive Error Status Codes & Response Catalog (4XX & 5XX)

3.1 HTTP 400 Bad Request

Case A: Missing Parameter (`MISSING_PARAMETER`)

Case B: Invalid Domain Format (`INVALID_DOMAIN`)

3.2 HTTP 401 Unauthorized

Case A: Missing API Key Header

Case B: Invalid or Revoked API Key / Bad Header Format

3.3 HTTP 402 Payment Required

3.4 HTTP 404 Not Found

Case A: Unknown Route Under Known Service (`/siteatlas/unknown`)

Case B: Unknown Service Root (`/nonexistentservice/endpoint`)

3.5 HTTP 405 Method Not Allowed

3.6 HTTP 413 Payload Too Large

3.7 HTTP 429 Too Many Requests

3.8 HTTP 500 Internal Server Error

3.9 HTTP 502 Bad Gateway

3.10 HTTP 504 Gateway Timeout