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://dev-api.richapi.ai/api/v1/

Authentication

Every request requires an API key passed via the x-api-key header.

curl https://dev-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://dev-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://dev-api.richapi.ai/api/v1/usage \
  -H "x-api-key: YOUR_API_KEY"

Available Endpoints

EndpointMethodCredits
Enrichment
/enrich_companies_bulkPOST1 credit per record
/enrich_profiles_bulkPOST1 credit per record
/enrich_companyPOST1 credit per call
/email_finderPOST5 credits per call
/find_linkedin_url_by_emailPOST4 credits per call
/find_linkedin_url_by_namePOST4 credits per call
/find_personal_emailPOST5 credits per call
/find_website_by_company_namePOST1 credit per call
/linkedin_job_detailPOST1 credit per call
/phone_finderPOST25 credits per call
/enrich_profilePOST1 credit per call
/profile_social_metricsPOST1 credit per call
Search
/search_bingPOST1 credit per call
/geo_id_searchPOST0.01 credits per call
/google_search_scraper_syncPOST1 credit per record
/search_google_trendsPOST1 credit per call
/linkedin_company_employees_searchPOST0.1 credits per record
/linkedin_company_searchPOST0.1 credits per record
/linkedin_job_searchPOST0.1 credits per record
/profile_searchPOST0.1 credits per record
/people_searchPOST0.1 credits per record
/post_activitiesPOST3 credits per call
/post_detailsPOST1 credit per call
/post_keyword_searchPOST6 credits per record
/search_reference_dataPOSTFree
Web Scraping
/web_json_ldPOST1 credit per call
/web_meta_tagsPOST1 credit per call
/similarweb_scraper_syncPOST2 credits per record
/web_sitemapPOST1 credit per record
/web_social_linksPOST1 credit per call
/web_tech_stackPOST1 credit per call
/web_pixelsPOST1 credit per call
/web_scrapePOST1 credit per call
/web_emailsPOST2 credits per call
/website_intelligencePOST5 credits per call
YouTube
/youtube_channelPOST1 credit per call
/youtube_channel_videosPOST2 credits per call
/youtube_searchPOST1 credit per call
/youtube_videoPOST1 credit per call
Directory
/directory_yellowpagesPOST0.01 credits per record
Social
/slack_channel_membersPOST2 credits per call
Activity
/profile_activitiesPOST2 credits per record
AI
/ai_enrichPOST2 credits per call
Ads
/google_ad_transparency_scraper_syncPOST3 credits per record
/linkedin_ad_detailsPOST2 credits per call
/linkedin_ad_searchPOST0.2 credits per record
/meta_ads_library_scraper_syncPOST1 credit per record
Utilities
/clean_domainPOST0.5 credits per call
/count_occurrencesPOST0.5 credits per call
/distribute_leadsPOST0.5 credits per call
/encode_uriPOST0.5 credits per call
/extract_urls_emailsPOST0.5 credits per call
/find_redirectPOST1 credit per call
/find_sitemap_urlsPOST1 credit per call
/format_datetimePOST0.5 credits per call
/identify_email_typePOST0.5 credits per call
/normalize_companyPOST0.5 credits per call
/normalize_listPOST0.5 credits per call
/normalize_phonePOST0.5 credits per call
/predict_genderPOST1 credit per call
/remove_whitespacePOST0.5 credits per call
Waterfall
/email_verifierPOST2 credits per call
Funding Data
/crunchbase_company_scraper_syncPOST3 credits per call
Maps
/google_maps_places_scraper_keywordPOST0.1 credits per record
/google_maps_places_scraper_sync_using_urlPOST0.1 credits per record
/google_maps_reviews_scraper_syncPOST0.1 credits per record
Leads
/lead_searchPOST10 credits per call + 0.5 credits per record
Posts
/linkedin_company_postsPOST0.2 credits per record