POST /website_intelligence • Credits: 5 credits per call

Website Intelligence analyzes one website URL and returns a combined report in a single call. The report holds meta tags, JSON-LD, tech stack, tracking pixels, social links, emails, DNS records, SSL details, response headers and an SEO score. Each call costs 5 credits.

What does Website Intelligence do?

A full picture of a website needs many different signals, and each signal normally needs its own request. Website Intelligence solves that problem. The endpoint fetches the page one time, then runs every analysis module in parallel against that one fetch. Each module is fault-isolated, so a failure in one module leaves the other modules intact. Website Intelligence is the flagship endpoint of the RichAPI web scraper family, and it costs five times a web_scrape call.

Which endpoint does Website Intelligence use?

Method:POST
URL:https://api.richapi.ai/api/v1/website_intelligence
Authentication:x-api-key header
Response: Synchronous JSON
Credits: 5 credits per call

How to send a Website Intelligence request

Copy your API key from the RichAPI dashboard.
Set the url parameter to the full website URL.
Set the modules parameter to an empty array to run every module.
Set the cache parameter to true to accept a cached report.
Send a POST request to https://api.richapi.ai/api/v1/website_intelligence.
Send the API key in the x-api-key header.
Read the report from the data object in the response.

CAUTION: Each Website Intelligence call costs 5 credits. A cached report also costs 5 credits.

cURL

curl -X POST https://api.richapi.ai/api/v1/website_intelligence   
  -H "x-api-key: YOUR_API_KEY"   
  -H "Content-Type: application/json"   
  -d '{
    "url": "https://hubspot.com",
    "modules": [],
    "cache": true
  }'

Python

import requests

response = requests.post(
    "https://api.richapi.ai/api/v1/website_intelligence",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "url": "https://hubspot.com",
        "modules": [],
        "cache": True,
    },
    timeout=60,
)
response.raise_for_status()
print(response.json()["data"])

Node.js

const response = await fetch("https://api.richapi.ai/api/v1/website_intelligence", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://hubspot.com",
    modules: [],
    cache: true,
  }),
});

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

Which parameters does Website Intelligence accept?

Parameter	Type	Required	Default	Description
`url`	string	Yes	None	The full HTTP or HTTPS URL of the website to analyze.
`modules`	array of strings	No	`[]`	The modules to run. An empty array runs every module.
`cache`	boolean	No	`false`	Set to `true` to accept a cached report.

Which modules can Website Intelligence run?

The modules parameter takes an array of module names. Each module adds one block to the data object. Today every call runs all nine modules, whatever the modules value. The ssl block appears only for a site that serves HTTPS.

Module	What the module adds to `data`
`meta_tags`	The `meta_tags` block, plus the `seo_score` value and the `seo_issues` list.
`json_ld`	The `json_ld` block with the structured data items and their count.
`pixels`	The `pixels` block with the tracking pixel identifiers per provider.
`tech_stack`	The `tech_stack` block with the technologies, the category counts and the GTM signals.
`social_links`	The `social_links` block with the social profile URLs per platform.
`emails`	The `emails` block with the email addresses found on the fetched page.
`ssl`	The `ssl` block with the certificate issuer, the expiry date and a grade.
`headers`	The `headers` block with the security header analysis and a security score.
`dns`	The `dns` block with the A records, the MX records and the email provider.

What does Website Intelligence return?

Website Intelligence returns a data object and a meta object. The example below shows the shape of a report for https://hubspot.com. The values are illustrative.

{
  "data": {
    "url": "https://hubspot.com",
    "final_url": "https://www.hubspot.com/",
    "http_status": 200,
    "redirect_chain": ["https://hubspot.com -> https://www.hubspot.com/"],
    "page_load_time_ms": 812.4,
    "content_length_bytes": 486213,
    "meta_tags": {
      "og": {
        "title": "HubSpot | Software & Tools for your Business",
        "description": "HubSpot is a customer platform with marketing, sales and service software.",
        "image": "https://www.hubspot.com/hubfs/og-image.png",
        "url": "https://www.hubspot.com/",
        "type": "website",
        "site_name": "HubSpot",
        "locale": "en_US",
        "extra": {}
      },
      "twitter": {
        "card": "summary_large_image",
        "site": "@HubSpot",
        "creator": "@HubSpot",
        "title": "HubSpot | Software & Tools for your Business",
        "description": "HubSpot is a customer platform with marketing, sales and service software.",
        "image": "https://www.hubspot.com/hubfs/og-image.png",
        "extra": {}
      },
      "seo": {
        "title": "HubSpot | Software & Tools for your Business",
        "description": "HubSpot is a customer platform with marketing, sales and service software.",
        "canonical": "https://www.hubspot.com/",
        "robots": "index, follow",
        "viewport": "width=device-width, initial-scale=1",
        "charset": "utf-8",
        "author": null,
        "keywords": null,
        "language": "en"
      },
      "favicon": "https://www.hubspot.com/favicon.ico",
      "hreflang": [{ "lang": "es", "url": "https://www.hubspot.es/" }],
      "other": {}
    },
    "seo_score": 82,
    "seo_issues": ["Missing hreflang tags"],
    "tech_stack": {
      "technologies": [
        { "name": "HubSpot", "category": "Marketing Automation", "confidence": 1.0 },
        { "name": "Cloudflare", "category": "CDN", "confidence": 0.9 },
        { "name": "Google Analytics", "category": "Analytics", "confidence": 0.95 }
      ],
      "categories_count": { "Marketing Automation": 1, "CDN": 1, "Analytics": 1 },
      "gtm_signals": {
        "company_stage": "growth",
        "estimated_monthly_tech_spend": 1200,
        "tools_by_function": { "marketing": ["HubSpot"], "analytics": ["Google Analytics"] },
        "buying_signals": ["Marketing automation in place - invests in lead gen"]
      }
    },
    "pixels": {
      "pixels": {
        "google_tag_manager": ["GTM-ABC1234"],
        "google_analytics_ga4": ["G-1AB2C3D4E5"],
        "linkedin_insight": ["1234567"]
      },
      "total_pixels_found": 3
    },
    "social_links": {
      "links": {
        "linkedin": ["https://www.linkedin.com/company/hubspot"],
        "twitter": ["https://twitter.com/HubSpot"],
        "youtube": ["https://www.youtube.com/user/HubSpot"]
      },
      "total_links_found": 3
    },
    "emails": {
      "emails": ["[email protected]", "[email protected]"]
    },
    "json_ld": {
      "items": [
        { "@type": "Organization", "name": "HubSpot", "url": "https://www.hubspot.com/" }
      ],
      "count": 1
    },
    "headers": {
      "security_score": 85,
      "hsts": true,
      "csp": true,
      "x_frame_options": "SAMEORIGIN",
      "x_content_type_options": "nosniff",
      "x_xss_protection": null,
      "referrer_policy": "strict-origin-when-cross-origin",
      "permissions_policy": true
    },
    "dns": {
      "a_records": ["104.16.249.5"],
      "mx_records": ["aspmx.l.google.com"],
      "email_provider": "Google Workspace"
    },
    "ssl": {
      "issuer": "Let's Encrypt",
      "expires": "2026-11-02",
      "days_until_expiry": 84,
      "grade": "A"
    }
  },
  "meta": {
    "cache_hit": false,
    "execution_time_ms": 4210,
    "modules_run": [
      "meta_tags",
      "tech_stack",
      "emails",
      "social_links",
      "pixels",
      "json_ld",
      "headers",
      "dns",
      "ssl"
    ],
    "modules_failed": []
  }
}

Which fields does the Website Intelligence response hold?

Every field below sits inside the data object of the Website Intelligence response.

Field	Type	Description
`url`	string	The URL that the request sent.
`final_url`	string	The URL after the last redirect.
`http_status`	integer	The HTTP status code that the target site returned.
`redirect_chain`	array of strings	The redirect path, from the first URL to the final URL.
`page_load_time_ms`	number	The duration of the page fetch, in milliseconds.
`content_length_bytes`	integer	The size of the fetched page, in bytes.
`meta_tags`	object	The OpenGraph tags, the Twitter Card tags, the SEO tags, the favicon and the hreflang entries.
`seo_score`	integer	The SEO score of the page, from 0 to 100.
`seo_issues`	array of strings	The SEO problems found on the page.
`tech_stack`	object	The detected technologies, the count per category and the GTM signals.
`pixels`	object	The tracking pixel identifiers per provider and the total pixel count.
`social_links`	object	The social profile URLs per platform and the total link count.
`emails`	object	The email addresses found on the fetched page.
`json_ld`	object	The JSON-LD structured data items and their count.
`headers`	object	The security header analysis and a security score from 0 to 100.
`dns`	object	The A records, the MX records and the email provider behind the MX records.
`ssl`	object	The certificate issuer, the expiry date, the days until expiry and a grade.

The meta object of the Website Intelligence response holds the run report.

Field	Type	Description
`cache_hit`	boolean	The value is `true` for a cached report.
`execution_time_ms`	integer	The total time of the call, in milliseconds.
`modules_run`	array of strings	The modules that returned a result.
`modules_failed`	array of strings	The modules that failed.

How much does Website Intelligence cost?

Website Intelligence costs 5 credits per call. At $0.02 a credit, the rate on the 1,000 and 5,000 credit packs, one call costs $0.10. Larger packs cost less per credit. The credit count stays at 5 for every call, and the modules parameter does not change it.

Calls	Credits	Cost
1	5	$0.10
100	500	$10.00
1,000	5,000	$100.00
10,000	50,000	$1,000.00

When do you call Website Intelligence instead of the single-purpose endpoints?

Website Intelligence covers six signals that the single-purpose endpoints also cover: meta tags, JSON-LD, tech stack, pixels, social links and emails. It adds four signals that no single-purpose endpoint returns: SSL, response headers, DNS and the SEO score.

Each single-purpose endpoint costs less than one Website Intelligence call. Six separate calls cost 7 credits in total, and one Website Intelligence call costs 5 credits.

Endpoint	Credits
`web_scrape`	1 per call
`web_meta_tags`	1 per call
`web_json_ld`	1 per call
`web_emails`	2 per call
`web_social_links`	1 per call
`web_tech_stack`	1 per call
`web_pixels`	1 per call
`web_sitemap`	1 per URL returned
`website_intelligence`	5 per call

The table below shows the credit arithmetic for both paths. The break-even point sits at five signals.

What you need for one domain	Single-purpose path	Credits	Website Intelligence	Cheaper path
Meta tags	`web_meta_tags`	1	5	Single-purpose
Tech stack and pixels	`web_tech_stack` + `web_pixels`	2	5	Single-purpose
Meta tags, tech stack, social links	3 calls	3	5	Single-purpose
Meta tags, tech stack, pixels, social links	4 calls	4	5	Single-purpose
The same four signals plus emails	5 calls, `web_emails` costs 2	6	5	Website Intelligence
All six shared signals	6 calls, `web_emails` costs 2	7	5	Website Intelligence
Any set with SSL, headers, DNS or the SEO score	No single-purpose endpoint exists	Not available	5	Website Intelligence

Two facts change the arithmetic beyond the credit count:

Website Intelligence fetches the target page one time. Six single-purpose calls fetch the same page six times, which costs more wall-clock time.
web_emails crawls several pages of the website and reports pages_crawled. The emails module of Website Intelligence reads only the one fetched page, so it finds fewer addresses.

For 1,000 domains, the six single-purpose calls cost 7,000 credits, or $140.00. One Website Intelligence call per domain costs 5,000 credits, or $100.00.

Which errors can Website Intelligence return?

Status	Meaning	What to do
`400`	The request body failed validation: a missing `url`, an unknown parameter name or a wrong value type.	Correct the parameter that the message names.
`401`	The API key is missing, wrong or revoked.	Send a valid key in the `x-api-key` header.
`402`	The organization has no credits left, or the team reached its monthly spend limit.	Buy credits in the RichAPI dashboard.
`403`	`Endpoint not available on your plan`: this API key has no access to this endpoint.	Call `GET /api/v1/my-endpoints` to list the endpoints this key can use. For access, write to [email protected].
`404`	The endpoint name is wrong.	Send the request to `/website_intelligence`.
`405`	The request used a method other than `POST`.	Send the request again with the `POST` method.
`422`	The analysis service refused the `url`: it does not start with `http://` or `https://`, it is longer than 2,048 characters, or it points to a private network address.	Send a full public HTTP or HTTPS URL.
`429`	The request rate is over the limit.	Wait, then send the request again. For a higher limit, write to [email protected].
`500`	The API failed.	Send the request again. If the failure repeats, write to [email protected].
`502`	The target website did not return the page.	Check that the URL opens in a browser. Then send the request again.
`504`	The target website took too long.	Send the request again.

RichAPI charges no credit for any response outside the 200 range.

Frequently asked questions

Does Website Intelligence replace the single-purpose web endpoints?

For five or more signals on one domain, Website Intelligence replaces the single-purpose web endpoints. Five separate calls cost 6 credits, and one Website Intelligence call costs 5 credits. For one or two signals, the single-purpose endpoints cost less.

Does the modules parameter change the credit cost of Website Intelligence?

No. Website Intelligence costs 5 credits per call for every module set. A request for one module costs the same 5 credits as a request for every module.

What happens after one Website Intelligence module fails?

Each module is fault-isolated, so one failure leaves the rest of the report intact. Website Intelligence returns status 200, lists the failed module in meta.modules_failed and charges the full 5 credits.

How long does Website Intelligence cache a report?

Website Intelligence caches each report for 24 hours. If cache is true and a report for the same URL exists inside that window, the response returns it with meta.cache_hit set to true. A cached report costs the same 5 credits.

How many pages does Website Intelligence read?

Website Intelligence reads one page: the URL that you send. Every text-based module runs against that single fetch, so the emails module finds fewer addresses than a web_emails call, which crawls several pages.

Can Website Intelligence analyze a page behind a login?

No. Website Intelligence accepts no login credentials and no cookies. It reads only a page that a public visitor can open, and it rejects a URL that points to a private network address.

Which signals does Website Intelligence return that no other endpoint returns?

Website Intelligence returns four signals with no single-purpose equivalent. The first two are the SSL certificate details and the response header security analysis. The other two are the DNS records with the email provider, and the SEO score with its issue list.

Website Intelligence API