API Documentation

Everything you need to integrate the RichAPI API into your product.

Getting Started

Make your first API call in under 5 minutes

Base URL

https://api.richapi.ai/api/v1/

Authentication

Every request requires an API key passed via the <code>x-api-key</code> header.

curl https://api.richapi.ai/api/v1/health \
  -H "x-api-key: YOUR_API_KEY"

Your First API Call

Let's enrich a LinkedIn profile:

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

Response:

json
{
  "firstname": "Satya",
  "lastname": "Nadella",
  "headline": "Chairman and CEO at Microsoft",
  "summary": "...",
  "picture": "https://...",
  "industry": "Technology",
  "location": {
    "country": "United States",
    "city": "Redmond",
    "state": "Washington"
  }
}

Check Your Usage

Monitor your credit consumption anytime:

curl https://api.richapi.ai/api/v1/usage \
  -H "x-api-key: YOUR_API_KEY"

Available Endpoints

EndpointMethodCredits
Enrichment
/enrich_companies_bulkPOST
/enrich_profiles_bulkPOST
/company_enricherPOST2 credits
/enrich_companyPOST1 credit
/email_finderPOST5 credits
/find_linkedin_url_by_emailPOST4 credits
/find_linkedin_url_by_namePOST4 credits
/find_personal_emailPOST5 credits
/find_website_by_company_namePOST1 credit
/linkedin_job_detailPOST1 credit
/phone_finderPOST25 credits
/enrich_profilePOST1 credit
Search
/search_bingPOST1 credit
/geo_id_searchPOST0.01 credits
/search_google_trendsPOST1 credit
/lead_searchPOST
/linkedin_company_employees_searchPOST
/company_searchPOST
/linkedin_job_searchPOST
/profile_searchPOST
/people_searchPOST
/post_keyword_searchPOST6 credits
/search_reference_dataPOSTFree
Web Scraping
/google_search_scraper_syncPOST
/web_json_ldPOST1 credit
/web_meta_tagsPOST1 credit
/similarweb_scraper_syncPOST
/web_sitemapPOST1 credit
/web_social_linksPOST1 credit
/web_tech_stackPOST1 credit
/web_pixelsPOST1 credit
/web_scrapePOST1 credit
/web_emailsPOST2 credits
/website_intelligencePOST5 credits
YouTube
/youtube_channelPOST1 credit
/youtube_channel_videosPOST2 credits
/youtube_searchPOST1 credit
/youtube_videoPOST1 credit
Directory
/directory_yellowpagesPOST1 credit
Social
/slack_channel_membersPOST2 credits
Activity
/post_activitiesPOST3 credits
/post_detailsPOST1 credit
/profile_activitiesPOST2 credits
Email
/email_findingPOST
/email_finding_inquiry/{id}GETFree
/email_verificationPOST
/email_verification_inquiry/{id}GETFree
/email_verifierPOST2 credits
AI
/ai_enrichPOST2 credits
Ads
/google_ad_transparency_scraper_syncPOST
/ad_detailsPOST2 credits
/ad_searchPOST
/meta_ads_library_scraper_syncPOST
Utilities
/clean_domainPOST0.5 credits
/count_occurrencesPOST0.5 credits
/distribute_leadsPOST0.5 credits
/encode_uriPOST0.5 credits
/extract_urls_emailsPOST0.5 credits
/find_redirectPOST1 credit
/find_sitemap_urlsPOST1 credit
/format_datetimePOST0.5 credits
/identify_email_typePOST0.5 credits
/normalize_companyPOST0.5 credits
/normalize_listPOST0.5 credits
/normalize_phonePOST0.5 credits
/predict_genderPOST1 credit
/remove_whitespacePOST0.5 credits
Funding Data
/crunchbase_company_scraper_syncPOST
Maps
/google_maps_places_scraper_syncPOST
/google_maps_places_scraper_sync_using_urlPOST
/google_maps_reviews_scraper_syncPOST
Posts
/company_postsPOST