# RichAPI API

Public endpoint reference.

## AI

### AI Enrich

`POST /ai_enrich`

Enrich, classify, extract, or summarize text using OpenAI, Anthropic, Gemini, or Perplexity.

**Body parameters:**

- `context` (object)
- `max_tokens` (integer)
- `model` (string)
- `output_schema` (object)
- `output_type` (string)
- `prompt` (string)
- `provider` (string)
- `search_domain_filter` (array)
- `search_recency_filter` (string)
- `system_prompt` (string)
- `temperature` (number)
- `use_web_search` (boolean)

**Pricing:** credits_per_call: 2

## Utilities

### Clean Domain

`POST /clean_domain`

Normalize a messy URL or domain string to a clean root domain.

**Body parameters:**

- `messy_url` (string)

**Pricing:** credits_per_call: 0.5

### Count Occurrences

`POST /count_occurrences`

Count how many times a substring appears in a string, with optional case-insensitive matching.

**Body parameters:**

- `case_insensitive` (boolean)
- `input` (string)
- `limit` (integer)
- `separator` (string)

**Pricing:** credits_per_call: 0.5

### Distribute Leads

`POST /distribute_leads`

Round-robin distribute leads across a set of assignment labels (e.g. sales reps).

**Body parameters:**

- `assignment_labels` (string)
- `current_index` (integer)
- `values_associated_with_labels` (string)

**Pricing:** credits_per_call: 0.5

### Encode URI

`POST /encode_uri`

URL-encode a string for safe use in query parameters or path segments.

**Body parameters:**

- `value` (string)

**Pricing:** credits_per_call: 0.5

### Extract URLs & Emails

`POST /extract_urls_emails`

Extract all URLs and email addresses from a block of text.

**Body parameters:**

- `text` (string)

**Pricing:** credits_per_call: 0.5

### Find Redirect

`POST /find_redirect`

Follow a URL through all redirects and return the final destination URL.

**Body parameters:**

- `link` (string)

**Pricing:** credits_per_call: 1

### Find Sitemap URLs

`POST /find_sitemap_urls`

Discover and filter URLs from a domain's sitemap by keyword.

**Body parameters:**

- `domain` (string)
- `exact_match` (boolean)
- `keywords` (string)

**Pricing:** credits_per_call: 1

### Format Datetime

`POST /format_datetime`

Parse and reformat a date/time string with optional timezone conversion and locale.

**Body parameters:**

- `date` (string)
- `format` (string)
- `locale` (string)
- `new_timezone` (string)
- `original_timezone` (string)

**Pricing:** credits_per_call: 0.5

### Identify Email Type

`POST /identify_email_type`

Classify an email address as personal, business, role-based, or disposable.

**Body parameters:**

- `email` (string)

**Pricing:** credits_per_call: 0.5

### Normalize Company

`POST /normalize_company`

Clean and normalize a company name by removing legal suffixes, extra whitespace, and punctuation.

**Body parameters:**

- `company_name` (string)
- `normalize_case` (boolean)

**Pricing:** credits_per_call: 0.5

### Normalize List

`POST /normalize_list`

Split a delimited string into a clean list, optionally removing empty values.

**Body parameters:**

- `input` (string)
- `remove_empty_values` (boolean)

**Pricing:** credits_per_call: 0.5

### Normalize Phone

`POST /normalize_phone`

Parse and normalize a phone number to E.164 format with optional country code hint.

**Body parameters:**

- `country_code` (string)
- `phone_number` (string)

**Pricing:** credits_per_call: 0.5

### Predict Gender

`POST /predict_gender`

Predict the gender of a person from their first name.

**Body parameters:**

- `name` (string)

**Pricing:** credits_per_call: 1

### Remove Whitespace

`POST /remove_whitespace`

Strip and collapse extra whitespace from a string.

**Body parameters:**

- `input_text` (string)

**Pricing:** credits_per_call: 0.5

## Funding Data

### Crunchbase Company Scraper

`POST /crunchbase_company_scraper_sync`

Scrape Crunchbase company profiles — funding rounds, investors, employee count, and more.

**Body parameters:**

- `crunchbase_company_url` (string)

**Pricing:** credits_per_call: 3

## Directory

### Yellow Pages Search

`POST /directory_yellowpages`

Search Yellow Pages for businesses with name, phone, address, website, and categories.

**Body parameters:**

- `location` (string)
- `max_pages` (integer)
- `page` (integer)
- `search_query` (string)

**Pricing:** base_credits_per_call: 0, credits_per_result: 0.01, result_count_field: _list_count

## Enrichment

### Email Finder

`POST /email_finder`

Find a verified work email using name, domain, or LinkedIn URL. Tries multiple providers automatically.

**Body parameters:**

- `company_domain` (string)
- `company_name` (string)
- `first_name` (string)
- `last_name` (string)
- `linkedin_url` (string)

**Pricing:** credits_per_call: 5

### Bulk Company Enrichment

`POST /enrich_companies_bulk`

Fetch up to 50 LinkedIn company profiles in a single call using company IDs.

**Body parameters:**

- `urns` (array)

**Pricing:** credits_per_result: 1, result_count_field: _list_count

### Company Enrichment

`POST /enrich_company`

Get company data from LinkedIn including size, industry, specialties and employee insights.

**Body parameters:**

- `url` (string)
- `useCache` (boolean)

**Pricing:** credits_per_call: 1

### Profile Enrichment

`POST /enrich_profile`

Get LinkedIn profile data including name, headline, location, experience, education and more. Base price is 1 credits per call. When `include_social_metrics` is `True`, the optional component adds 1 credits; it is not charged when unavailable.

**Body parameters:**

- `include_social_metrics` (boolean)
- `url` (string)
- `useCache` (boolean)

**Pricing:** conditional_components: [object Object], credits_per_call: 1, max_credits_per_call: 2, min_credits_per_call: 1

### Bulk Profile Enrichment

`POST /enrich_profiles_bulk`

Fetch up to 50 LinkedIn profiles in a single call using entity URNs.

**Body parameters:**

- `urns` (array)

**Pricing:** credits_per_result: 1, result_count_field: _list_count

### Find Crunchbase URL

`POST /find_crunchbase_url`

Find the Crunchbase organization URL for a company from its name.

**Body parameters:**

- `company_domain` (string)
- `company_name` (string)

**Pricing:** credits_per_call: 0.25

### Find LinkedIn Company URL

`POST /find_linkedin_company_url`

Find the LinkedIn company page URL for a company from its name.

**Body parameters:**

- `company_domain` (string)
- `company_name` (string)

**Pricing:** credits_per_call: 0.25

### Find LinkedIn URL by Email

`POST /find_linkedin_url_by_email`

Finds a LinkedIn profile URL using an email address.

**Body parameters:**

- `email` (string)

**Pricing:** credits_per_call: 4

### Find LinkedIn URL by Name

`POST /find_linkedin_url_by_name`

Finds a LinkedIn profile URL using full name and company name.

**Body parameters:**

- `company_name` (string)
- `full_name` (string)

**Pricing:** credits_per_call: 4

### Find Personal Email

`POST /find_personal_email`

Finds a person's personal email addresses using their LinkedIn profile URL.

**Body parameters:**

- `linkedin_url` (string)

**Pricing:** credits_per_call: 5

### Find Website by Company Name

`POST /find_website_by_company_name`

Finds a company website URL using its name.

**Body parameters:**

- `company_domain` (string)
- `company_name` (string)

**Pricing:** credits_per_call: 1

### LinkedIn Job Details

`POST /linkedin_job_detail`

Get full LinkedIn job details including description, workplace type, and employment type.

**Body parameters:**

- `job_id` (string)
- `url` (string)

**Pricing:** credits_per_call: 1

### Phone Finder

`POST /phone_finder`

Find a mobile phone number using a LinkedIn URL or name and company. Tries multiple providers automatically.

**Body parameters:**

- `domain` (string)
- `first_name` (string)
- `last_name` (string)
- `linkedin_url` (string)

**Pricing:** credits_per_call: 25

### Profile Social Metrics

`POST /profile_social_metrics`

Get LinkedIn profile verification status, follower count, and connection count.

**Body parameters:**

- `url` (string)
- `useCache` (boolean)

**Pricing:** credits_per_call: 1

## Waterfall

### Email Verifier

`POST /email_verifier`

Verify email deliverability and validity via multi-provider waterfall.

**Body parameters:**

- `email` (string)

**Pricing:** credits_per_call: 2

## Social

### Enrich

`POST /enrich`

Public page for a LinkedIn person, a LinkedIn company, or an Instagram, X, Facebook, or TikTok profile URL. LinkedIn costs 1 credit. Instagram, X, Facebook, and TikTok cost 0.6 credits. The response body is the matched page's body.

**Body parameters:**

- `url` (string)

**Pricing:** credits_per_call: 1

### Slack Channel Members

`POST /slack_channel_members`

Extract Slack channel members with names, emails, titles, timezones, admin status. Requires your Slack cookie.

**Body parameters:**

- `cache` (boolean)
- `channel_id` (string)
- `cookie` (string)
- `max_members` (integer)
- `token` (string)
- `workspace` (string)

**Pricing:** credits_per_call: 2

## Search

### Geo ID Search

`POST /geo_id_search`

Resolve a location name to a LinkedIn Geo ID for use with profile and lead search filters.

**Body parameters:**

- `search` (string)

**Pricing:** credits_per_call: 0.01

### Google Search Scraper

`POST /google_search_scraper_sync`

Scrape Google Search results synchronously.

**Body parameters:**

- `limit` (integer)
- `search_query` (string)

**Pricing:** credits_per_result: 1, result_count_field: _list_count

### LinkedIn Company Employees Search

`POST /linkedin_company_employees_search`

Search for employees of a specific company using its LinkedIn URL.

**Body parameters:**

- `company_linkedin_url` (string)
- `page` (integer)

**Pricing:** credits_per_result: 0.1, result_count_field: elements

### LinkedIn Company Search

`POST /linkedin_company_search`

Search LinkedIn companies by name, location, size, and industry. Returns company profiles with follower counts and summaries.

**Body parameters:**

- `company_size` (string)
- `geo_id` (string)
- `linkedin_industry_id` (string)
- `location` (string)
- `page` (integer)
- `search_query` (string)

**Pricing:** base_credits_per_call: 0, credits_per_result: 0.1, result_count_field: elements

### LinkedIn Job Search

`POST /linkedin_job_search`

Search LinkedIn jobs by title, company, location, and more.

**Body parameters:**

- `company` (string)
- `experienceLevel` (string)
- `geoId` (string)
- `jobType` (string)
- `location` (string)
- `page` (integer)
- `title` (string)

**Pricing:** credits_per_result: 0.1, result_count_field: elements

### People Search

`POST /people_search`

Search LinkedIn profiles by company/account and contact filters such as domain, industry, employee size, job title, and location.

**Body parameters:**

- `domain` (array)
- `employee_size_end` (integer)
- `employee_size_start` (integer)
- `industry` (array)
- `job_title` (array)
- `limit` (integer)
- `linkedin` (array)
- `location` (array)
- `page` (integer)

**Pricing:** credits_per_result: 0.1, result_count_field: numberOfElements

### Post Activities

`POST /post_activities`

Get likes, comments and reactions on a specific LinkedIn post.

**Body parameters:**

- `limit` (integer)
- `page` (integer)
- `type` (string)
- `urn` (string)

**Pricing:** credits_per_call: 3

### Post Keyword Search

`POST /post_keyword_search`

Search LinkedIn posts by keyword to discover trending content and engagement opportunities.

**Body parameters:**

- `authorIndustry` (array)
- `authorKeyword` (array)
- `contentType` (string)
- `datePosted` (string)
- `fromCompany` (array)
- `fromPerson` (array)
- `keyword` (string)
- `limit` (integer)
- `page` (integer)
- `sort` (string)

**Pricing:** credits_per_result: 0.1, result_count_field: numberOfElements

### LinkedIn Profile Search

`POST /profile_search`

Search LinkedIn profiles by name, title, company, location and more.

**Body parameters:**

- `current_company` (string)
- `first_name` (string)
- `follower_of` (string)
- `geo_id` (string)
- `industry_id` (string)
- `keywords_company` (string)
- `keywords_school` (string)
- `last_name` (string)
- `location` (string)
- `page` (integer)
- `past_company` (string)
- `school` (string)
- `search` (string)
- `title` (string)

**Pricing:** credits_per_result: 0.1, result_count_field: elements

### Bing Search

`POST /search_bing`

Search Bing and get structured SERP results with titles, URLs, and descriptions.

**Body parameters:**

- `limit` (integer)
- `page` (integer)
- `query` (string)

**Pricing:** credits_per_call: 1

### Google Trends

`POST /search_google_trends`

Get Google Trends data: interest over time, related queries, and rising queries for any keyword.

**Body parameters:**

- `geo` (string)
- `keyword` (string)
- `timeframe` (string)

**Pricing:** credits_per_call: 1

### Search Reference Data

`POST /search_reference_data`

Returns all valid filter labels (seniority levels, industries, functions, etc.) for use with Lead Search.

**Pricing:** credits_per_call: 0

## Ads

### Google Ad Transparency Scraper (deprecated)

`POST /google_ad_transparency_scraper_sync`

Scrape Google Ad Transparency reports — see active ads, creative formats, and geographic targeting.

**Body parameters:**

- `google_ad_url` (string)
- `limit` (integer)

**Pricing:** credits_per_result: 3, result_count_field: _list_count

### LinkedIn Ad Details

`POST /linkedin_ad_details`

Get full details of a specific LinkedIn ad including variants, impressions by country, and targeting.

**Body parameters:**

- `ad_url` (string)

**Pricing:** credits_per_call: 2

### LinkedIn Ad Search

`POST /linkedin_ad_search`

Search LinkedIn Ad Library for active ads by advertiser, keyword, or country.

**Body parameters:**

- `account_owner` (string)
- `countries` (string)
- `date_option` (string)
- `end_date` (string)
- `keyword` (string)
- `pagination_token` (string)
- `search_url` (string)
- `start_date` (string)

**Pricing:** credits_per_result: 0.2, result_count_field: elements

### Meta Ads Library Scraper

`POST /meta_ads_library_scraper_sync`

Scrape Meta (Facebook/Instagram) Ad Library — get active ads, creatives, spend ranges, and targeting.

**Body parameters:**

- `limit` (integer)
- `meta_ad_url` (string)

**Pricing:** credits_per_result: 1, result_count_field: _list_count

## Maps

### Google Maps Places (Keyword)

`POST /google_maps_places_scraper_keyword`

Search for business places on Google Maps by keyword and location (e.g., 'cafe' in 'Pune').

**Body parameters:**

- `limit` (integer)
- `location_query` (string)
- `search_query` (string)

**Pricing:** base_credits_per_call: 0, credits_per_result: 0.1, result_count_field: _list_count

### Google Maps Places (URL)

`POST /google_maps_places_scraper_sync_using_url`

Scrape Google Maps places directly from a search results URL.

**Body parameters:**

- `google_map_search_url` (string)
- `limit` (integer)

**Pricing:** credits_per_result: 0.1, result_count_field: _list_count

### Google Maps Reviews

`POST /google_maps_reviews_scraper_sync`

Scrape reviews for a specific Google Maps place synchronously.

**Body parameters:**

- `google_map_review_url` (string)
- `limit` (integer)
- `review_sort` (string)

**Pricing:** credits_per_result: 0.1, result_count_field: _list_count

## Leads

### Lead Search

`POST /lead_search`

Advanced LinkedIn lead search with 30+ filters including seniority, function, geography, company, title, Sales Navigator URL, and exclusion filter support.

**Body parameters:**

- `company_headquarter_locations` (array)
- `company_size` (array)
- `current_companies` (array)
- `current_job_titles` (array)
- `exclude_company_headquarter_locations` (array)
- `exclude_current_companies` (array)
- `exclude_current_job_titles` (array)
- `exclude_functions` (array)
- `exclude_geo_ids` (array)
- `exclude_industries` (array)
- `exclude_locations` (array)
- `exclude_past_companies` (array)
- `exclude_past_job_titles` (array)
- `exclude_schools` (array)
- `exclude_seniority` (array)
- `first_names` (array)
- `functions` (array)
- `geo_ids` (array)
- `industries` (array)
- `last_names` (array)
- `locations` (array)
- `page` (integer)
- `past_companies` (array)
- `past_job_titles` (array)
- `profile_languages` (array)
- `recently_changed_jobs` (boolean)
- `sales_nav_url` (string)
- `schools` (array)
- `search_query` (string)
- `seniority` (array)
- `session_id` (string)
- `years_at_current_company` (array)
- `years_of_experience` (array)

**Pricing:** base_credits_per_call: 10, credits_per_result: 0.5, result_count_field: elements

## Posts

### LinkedIn Company Posts

`POST /linkedin_company_posts`

Get recent posts published by a LinkedIn company. Supports filtering by date recency and cursor-based pagination.

**Body parameters:**

- `linkedin_company_id` (string)
- `linkedin_company_universal_name` (string)
- `linkedin_company_url` (string)
- `page` (integer)
- `posted_limit` (string)
- `scrape_posted_limit` (string)

**Pricing:** base_credits_per_call: 0, credits_per_result: 0.2, result_count_field: elements

## Getting Started

### My endpoints

`GET /my-endpoints`

List the endpoints available to the supplied API key.

## Activity

### Post Details

`POST /post_details`

Get full post details including text, media, comments and reaction counts.

**Body parameters:**

- `comments` (boolean)
- `reactions` (boolean)
- `urn` (string)

**Pricing:** credits_per_call: 1

### Profile Activities

`POST /profile_activities`

Get a profile's recent posts, comments and reactions for engagement analysis.

**Body parameters:**

- `limit` (integer)
- `pagination_token` (string)
- `type` (string)
- `urn` (string)

**Pricing:** credits_per_result: 2, result_count_field: content

## Web Scraping

### Similarweb Scraper

`POST /similarweb_scraper_sync`

Scrape Similarweb overview data for one or more domains.

**Body parameters:**

- `domain` (string)

**Pricing:** credits_per_result: 2, result_count_field: _list_count

### Website Email Extractor

`POST /web_emails`

Extract email addresses by crawling multiple pages of a website.

**Body parameters:**

- `cache` (boolean)
- `max_pages` (integer)
- `url` (string)

**Pricing:** credits_per_call: 2

### JSON-LD Extractor

`POST /web_json_ld`

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

**Body parameters:**

- `cache` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1

### Meta Tags Extractor

`POST /web_meta_tags`

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

**Body parameters:**

- `cache` (boolean)
- `cache_bust` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1

### Tracking Pixel Detector

`POST /web_pixels`

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

**Body parameters:**

- `cache` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1

### Web Scraper

`POST /web_scrape`

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

**Body parameters:**

- `cache` (boolean)
- `formats` (array)
- `url` (string)

**Pricing:** credits_per_call: 1

### Sitemap Extractor

`POST /web_sitemap`

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

**Body parameters:**

- `cache` (boolean)
- `limit` (integer)
- `url` (string)

**Pricing:** credits_per_result: 1, result_count_field: data.urls

### Social Links Finder

`POST /web_social_links`

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

**Body parameters:**

- `cache` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1

### Tech Stack Detector

`POST /web_tech_stack`

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

**Body parameters:**

- `cache` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1

### Website Intelligence

`POST /website_intelligence`

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

**Body parameters:**

- `cache` (boolean)
- `modules` (array)
- `url` (string)

**Pricing:** credits_per_call: 5

## Credits & Pricing

### Usage

`GET /usage`

Return the supplied API key's team-wide credit consumption and current balance.

## YouTube

### YouTube Channel Info

`POST /youtube_channel`

Get channel info: name, subscriber count, description, avatar, banner, external links.

**Body parameters:**

- `cache` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1

### YouTube Channel Videos

`POST /youtube_channel_videos`

List up to 50 most recent videos from a YouTube channel with titles, view counts, and durations per call.

**Body parameters:**

- `cache` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 2

### YouTube Search

`POST /youtube_search`

Search YouTube videos — returns up to 20 video IDs, titles, channels, view counts, and thumbnails per call.

**Body parameters:**

- `cache` (boolean)
- `query` (string)

**Pricing:** credits_per_call: 1

### YouTube Video Details

`POST /youtube_video`

Get full video details: title, description, view/like counts, duration, tags, thumbnails, chapters.

**Body parameters:**

- `cache` (boolean)
- `include_captions` (boolean)
- `url` (string)

**Pricing:** credits_per_call: 1