API Documentation

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

Maps

Google Maps Places (Keyword)

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

POST
/api/v1/google_maps_places_scraper_sync

Parameters

FieldTypeRequiredDescription
search_stringstringYesType of business to search for
location_querystringYesLocation to search within
max_crawled_place_per_searchnumberNoMax results to return (default 5)

Response fields

FieldTypeDescription
titlestringName of the business
categoryNamestringPrimary category (e.g. Cafe)
addressstringFull formatted address
citystringCity location
phonestringBusiness phone number
totalScorenumberAverage Google rating (0-5)
reviewsCountnumberTotal number of reviews
websitestringBusiness website URL
urlstringDirect Google Maps URL

Code

curl -X POST https://api.richapi.ai/api/v1/google_maps_places_scraper_sync \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "search_string": "cafe",
  "location_query": "Pune",
  "max_crawled_place_per_search": 5
}'

Try it

Sign in to test this endpoint with your API key.

Sign in to try

Google Maps Places (URL)

Scrape Google Maps places directly from a search results URL.

POST
/api/v1/google_maps_places_scraper_sync_using_url

Parameters

FieldTypeRequiredDescription
urlstringYesGoogle Maps search results URL
max_crawled_place_per_searchintegerNoMax places to return

Response fields

FieldTypeDescription
titlestringName of the business
categoryNamestringPrimary category
addressstringFull formatted address
totalScorenumberAverage rating
reviewsCountnumberTotal review count
urlstringDirect Google Maps URL

Code

curl -X POST https://api.richapi.ai/api/v1/google_maps_places_scraper_sync_using_url \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://www.google.com/maps/search/coffee+shop/@40.7128,-74.0060,14z"
}'

Try it

Sign in to test this endpoint with your API key.

Sign in to try

Google Maps Reviews

Scrape reviews for a specific Google Maps place synchronously.

POST
/api/v1/google_maps_reviews_scraper_sync

Parameters

FieldTypeRequiredDescription
start_urlstringYesGoogle Maps place URL to scrape reviews for
max_reviewintegerNoMaximum number of reviews to return
review_sortstringNoSort order: relevant, newest, highest_rating, lowest_rating

Response fields

FieldTypeDescription
textstringFull text of the review
publishAtstringReview date (e.g. 2 weeks ago)
starsnumberRating given by the reviewer (1-5)
reviewerNamestringName of the reviewer
reviewIdstringUnique ID of the review

Code

curl -X POST https://api.richapi.ai/api/v1/google_maps_reviews_scraper_sync \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_url": "https://www.google.com/maps/place/Starbucks/@40.7128,-74.0060,17z",
  "max_review": 10
}'

Try it

Sign in to test this endpoint with your API key.

Sign in to try