API Documentation

Web Scraping

Website Intelligence

Flagship: comprehensive website report — meta tags, tech stack, pixels, social links, emails, SSL, headers in one call.

POST

/api/v1/website_intelligence

5 credits per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Website URL to analyze
`modules`	array	No	Specific modules to run (defaults to all). Options: meta_tags, json_ld, pixels, tech_stack, social_links, emails, ssl, headers
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`metaTags`	object	OpenGraph, Twitter Card, and SEO meta tags
`techStack`	array	Detected technologies with name, category, version
`pixels`	array	Tracking pixels and analytics tags detected
`socialLinks`	object	Social media profile links (linkedin, twitter, facebook, etc.)
`emails`	array	Email addresses found on the homepage
`ssl`	object	SSL certificate info (valid, issuer, expiresAt)
`headers`	object	Notable HTTP response headers
`jsonLd`	array	JSON-LD structured data objects

Code

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"
}'

Try it

Tech Stack Detector

Detect 100+ technologies (CMS, analytics, CDN, frameworks, payments) + GTM intelligence signals.

POST

/api/v1/web_tech_stack

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Website URL to analyze
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`technologies`	array	List of detected technologies (name, category, version where available)
`categories`	object	Technologies grouped by category (CMS, Analytics, CDN, Framework, etc.)
`gtmSignals`	object	GTM intelligence signals (ad pixels, CRM tools, chat widgets, etc.)

Code

curl -X POST https://api.richapi.ai/api/v1/web_tech_stack \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://hubspot.com"
}'

Try it

Google Search Scraper

Scrape Google Search results synchronously.

POST

/api/v1/google_search_scraper_sync

Parameters

Field	Type	Required	Description
`query`	string	Yes	Search query string
`max_pages_per_query`	integer	No	Maximum number of result pages to fetch

Response fields

Field	Type	Description
`title`	string	Title of the search result
`url`	string	URL of the search result
`description`	string	Snippet/description of the search result

Code

curl -X POST https://api.richapi.ai/api/v1/google_search_scraper_sync \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "best CRM software 2025",
  "max_pages_per_query": 2
}'

Try it

Meta Tags Extractor

Extract OpenGraph, Twitter Card, and SEO meta tags from any URL. Returns title, description, images, favicon.

POST

/api/v1/web_meta_tags

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Page URL to extract meta tags from
`cache`	boolean	No	Use cached data if available
`cache_bust`	boolean	No	Force fresh fetch, ignoring cache

Response fields

Field	Type	Description
`title`	string	Page title
`description`	string	Meta description
`og`	object	OpenGraph tags (og:title, og:description, og:image, og:url, etc.)
`twitter`	object	Twitter Card tags (twitter:title, twitter:description, twitter:image, etc.)
`favicon`	string	Favicon URL
`canonical`	string	Canonical URL

Code

curl -X POST https://api.richapi.ai/api/v1/web_meta_tags \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://stripe.com"
}'

Try it

Tracking Pixel Detector

Detect Google Tag Manager, GA4, Facebook Pixel, LinkedIn Insight, TikTok Pixel and more on any site.

POST

/api/v1/web_pixels

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Website URL to scan for tracking pixels
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`pixels`	array	List of detected pixels/tags (name, id where available)
`gtm`	array	Google Tag Manager container IDs
`ga4`	array	GA4 measurement IDs
`facebookPixel`	array	Facebook Pixel IDs
`linkedinInsight`	boolean	Whether LinkedIn Insight Tag was detected
`tiktokPixel`	boolean	Whether TikTok Pixel was detected

Code

curl -X POST https://api.richapi.ai/api/v1/web_pixels \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://hubspot.com"
}'

Try it

Social Links Finder

Find all social media profile links (Facebook, Twitter, LinkedIn, Instagram, YouTube, TikTok, etc).

POST

/api/v1/web_social_links

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Website URL to scan for social links
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`linkedin`	string	LinkedIn page URL
`twitter`	string	Twitter / X profile URL
`facebook`	string	Facebook page URL
`instagram`	string	Instagram profile URL
`youtube`	string	YouTube channel URL
`tiktok`	string	TikTok profile URL
`github`	string	GitHub profile/org URL
`all`	array	All detected social links as a flat list

Code

curl -X POST https://api.richapi.ai/api/v1/web_social_links \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://hubspot.com"
}'

Try it

Website Email Extractor

Extract email addresses by crawling multiple pages of a website.

POST

/api/v1/web_emails

2 credits per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Root URL to start crawling from
`max_pages`	integer	No	Maximum number of pages to crawl (default 5)
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`emails`	array	Deduplicated list of email addresses found across crawled pages
`pagesCrawled`	integer	Number of pages actually crawled

Code

curl -X POST https://api.richapi.ai/api/v1/web_emails \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://stripe.com",
  "max_pages": 5
}'

Try it

Web Scraper

Scrape full page HTML and markdown with anti-bot protection via Firecrawl.

POST

/api/v1/web_scrape

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	URL of the page to scrape
`formats`	array	No	Output formats to include (e.g. html, markdown, links)
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`html`	string	Full page HTML
`markdown`	string	Page content converted to Markdown
`title`	string	Page title
`statusCode`	integer	HTTP status code returned by the target page

Code

curl -X POST https://api.richapi.ai/api/v1/web_scrape \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "formats": [
    "markdown"
  ]
}'

Try it

Similarweb Scraper

Scrape Similarweb overview data for one or more domains.

POST

/api/v1/similarweb_scraper_sync

Parameters

Field	Type	Required	Description
`domain`	string	Yes	Domain of the website to analyze (e.g. stripe.com)

Response fields

Field	Type	Description
`domain`	string	Domain name
`category`	string	Website category
`rankGlobal`	number	Global rank
`totalVisits`	number	Total visits
`engagement`	object	Engagement metrics
`topKeywords`	array	Top keywords
`similarSites`	array	Similar sites

Code

curl -X POST https://api.richapi.ai/api/v1/similarweb_scraper_sync \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "stripe.com"
}'

Try it

JSON-LD Extractor

Extract structured JSON-LD data (Schema.org) from any web page — products, articles, organizations.

POST

/api/v1/web_json_ld

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Page URL to extract JSON-LD from
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`items`	array	List of JSON-LD objects found on the page (each is a Schema.org entity)
`items[][@type]`	string	Schema.org type (e.g. Article, Product, Organization, BreadcrumbList)

Code

curl -X POST https://api.richapi.ai/api/v1/web_json_ld \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://www.bbc.com/news"
}'

Try it

Sitemap Extractor

Extract all URLs from a website's sitemap (XML, robots.txt, or crawl discovery).

POST

/api/v1/web_sitemap

1 credit per call

Parameters

Field	Type	Required	Description
`url`	string	Yes	Website root URL or direct sitemap URL
`max_urls`	integer	No	Maximum number of URLs to return
`cache`	boolean	No	Use cached data if available

Response fields

Field	Type	Description
`urls`	array	List of discovered URLs from the sitemap
`count`	integer	Total number of URLs found

Code

curl -X POST https://api.richapi.ai/api/v1/web_sitemap \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://stripe.com"
}'

Try it