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_keyword
0.1 credits per record

Parameters

FieldTypeRequiredDescription
search_querystringYesFuzzy keyword search.
location_querystringNoFuzzy location search.
limitintYesMaximum number of places to return (default is 25).

Example response

json
[
  {
    "url": "https://www.google.com/maps/search/?api=1&query=BUDDIES%20COFFEE&query_place_id=ChIJo20fEQpZwokRW7sSJjFierw",
    "city": "New York",
    "phone": "(212) 203-1918",
    "state": "New York",
    "title": "BUDDIES COFFEE",
    "street": "226 E 3rd St",
    "website": "http://buddiescoffeenyc.com/",
    "categories": [
      "Coffee shop",
      "Coffee roastery",
      "Coffee stand",
      "Coffee store",
      "Espresso bar"
    ],
    "totalScore": 5,
    "countryCode": "US",
    "categoryName": "Coffee shop",
    "reviewsCount": 1255
  },
  {
    "url": "https://www.google.com/maps/search/?api=1&query=Now%20or%20Never%20Coffee&query_place_id=ChIJcQM_C4FZwokR0xEGxV7HeVM",
    "city": "New York",
    "phone": "(347) 556-8312",
    "state": "New York",
    "title": "Now or Never Coffee",
    "street": "30 Grand St",
    "website": "http://nowornevercoffee.com/",
    "categories": [
      "Coffee shop"
    ],
    "totalScore": 4.6,
    "countryCode": "US",
    "categoryName": "Coffee shop",
    "reviewsCount": 416
  },
  {
    "url": "https://www.google.com/maps/search/?api=1&query=Coffee%20Project%20New%20York%20%7C%20East%20Village&query_place_id=ChIJ_dckWptZwokR_LkU9WxPNZ4",
    "city": "New York",
    "phone": "(212) 228-7888",
    "state": "New York",
    "title": "Coffee Project New York | East Village",
    "street": "239 E 5th St",
    "website": "https://coffeeprojectny.com/?utm_source=google&utm_medium=organic&utm_campaign=gmb_ev",
    "categories": [
      "Coffee shop",
      "Breakfast restaurant",
      "Cafe"
    ],
    "totalScore": 4.6,
    "countryCode": "US",
    "categoryName": "Coffee shop",
    "reviewsCount": 823
  },
  {
    "url": "https://www.google.com/maps/search/?api=1&query=Blackstone%20Coffee%20Roaster&query_place_id=ChIJMTPfU5NZwokRljkmneTlHNE",
    "city": "New York",
    "phone": "(212) 989-6131",
    "state": "New York",
    "title": "Blackstone Coffee Roaster",
    "street": "502 Hudson St",
    "categories": [
      "Coffee shop",
      "Cafe",
      "Deli"
    ],
    "totalScore": 4.7,
    "countryCode": "US",
    "categoryName": "Coffee shop",
    "reviewsCount": 316
  },
  {
    "url": "https://www.google.com/maps/search/?api=1&query=Urban%20Backyard&query_place_id=ChIJv6INkhtZwokR5Ol7iuc6TJc",
    "city": "New York",
    "phone": "(646) 692-9957",
    "state": "New York",
    "title": "Urban Backyard",
    "street": "180 Mulberry St",
    "website": "http://www.urbanbackyardnyc.com/",
    "categories": [
      "Coffee shop"
    ],
    "totalScore": 4.7,
    "countryCode": "US",
    "categoryName": "Coffee shop",
    "reviewsCount": 742
  }
]

Code

curl -X POST https://dev-api.richapi.ai/api/v1/google_maps_places_scraper_keyword \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "search_query": "cafe",
  "location_query": "Pune",
  "limit": 25
}'

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
0.1 credits per record

Parameters

FieldTypeRequiredDescription
google_map_search_urlstringYesGoogle Maps search results URL
limitintYesMax results to return (default 5, max 300)

Example response

json
{
  "url": "example",
  "title": "example",
  "address": "example",
  "totalScore": 1,
  "categoryName": "example",
  "reviewsCount": 1
}

Code

curl -X POST https://dev-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 '{
  "google_map_search_url": "https://www.google.com/maps/search/coffee+shop/@40.7128,-74.0060,14z",
  "limit": 1
}'

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
0.1 credits per record

Parameters

FieldTypeRequiredDescription
google_map_review_urlstringYesGoogle Maps place URL to scrape reviews for
limitintYesMaximum number of reviews to return (max 300)
review_sortstringNoSort order: relevant, newest, highest_rating, lowest_rating

Example response

json
{
  "text": "example",
  "stars": 1,
  "reviewId": "example",
  "publishAt": "example",
  "reviewerName": "example"
}

Code

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

Try it

Sign in to test this endpoint with your API key.

Sign in to try