API Documentation

Web-Scraping

Similarweb Scraper

Scrape Similarweb overview data for one or more domains.

POST

/api/v1/similarweb_scraper_sync

2 credits per record

Parameters

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

Example response

json

{
  "category": "example",
  "domain": "example",
  "engagement": {},
  "rankGlobal": 1,
  "similarSites": [],
  "topKeywords": [],
  "totalVisits": 1
}

Code

curl -X POST https://dev-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

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`	int	No	Maximum number of pages to crawl (default 5)
`cache`	bool	No	Use cached data if available

Example response

json

{
  "emails": [],
  "pagesCrawled": 1
}

Code

curl -X POST https://dev-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,
  "cache": true
}'

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`	bool	No	Use cached data if available

Example response

json

{
  "items": [],
  "items[][@type]": "example"
}

Code

curl -X POST https://dev-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",
  "cache": true
}'

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`	bool	No	Use cached data if available
`cache_bust`	bool	No	Force fresh fetch, ignoring cache

Example response

json

{
  "canonical": "example",
  "description": "example",
  "favicon": "example",
  "og": {},
  "title": "example",
  "twitter": {}
}

Code

curl -X POST https://dev-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",
  "cache": true,
  "cache_bust": true
}'

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`	bool	No	Use cached data if available

Example response

json

{
  "facebookPixel": [],
  "ga4": [],
  "gtm": [],
  "linkedinInsight": true,
  "pixels": [],
  "tiktokPixel": true
}

Code

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

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`	bool	No	Use cached data if available

Example response

json

{
  "html": "example",
  "markdown": "example",
  "statusCode": 1,
  "title": "example"
}

Code

curl -X POST https://dev-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"
  ],
  "cache": true
}'

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 record

Parameters

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

Example response

json

{
  "count": 1,
  "urls": []
}

Code

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

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`	bool	No	Use cached data if available

Example response

json

{
  "all": [],
  "facebook": "example",
  "github": "example",
  "instagram": "example",
  "linkedin": "example",
  "tiktok": "example",
  "twitter": "example",
  "youtube": "example"
}

Code

curl -X POST https://dev-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",
  "cache": true
}'

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`	bool	No	Use cached data if available

Example response

json

{
  "categories": {},
  "gtmSignals": {},
  "technologies": []
}

Code

curl -X POST https://dev-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",
  "cache": true
}'

Try it

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`	bool	No	Use cached data if available

Example response

json

{
  "emails": [],
  "headers": {},
  "jsonLd": [],
  "metaTags": {},
  "pixels": [],
  "socialLinks": {},
  "ssl": {},
  "techStack": []
}

Code

curl -X POST https://dev-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
}'

Try it