API Documentation

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

Directory

Yellow Pages Search

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

POST
/api/v1/directory_yellowpages
1 credit per call

Parameters

FieldTypeRequiredDescription
querystringYesBusiness type or name to search for
locationstringYesCity, state, or ZIP code
pageintegerNoPage number for pagination (default 1)
max_pagesintegerNoMaximum number of pages to scrape
cachebooleanNoUse cached data if available

Response fields

FieldTypeDescription
resultsarrayList of matched business listings
results[].namestringBusiness name
results[].phonestringPhone number
results[].addressstringStreet address
results[].websitestringBusiness website URL
results[].categoriesarrayBusiness category tags
results[].ratingnumberAverage rating (if available)

Code

curl -X POST https://api.richapi.ai/api/v1/directory_yellowpages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "plumber",
  "location": "Austin, TX"
}'

Try it

Sign in to test this endpoint with your API key.

Sign in to try