Skip to main content
POST
/
api
/
yell
/
businesses
/
search
/yell/businesses/search
curl --request POST \
  --url https://api.anysite.io/api/yell/businesses/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300,
  "location": "",
  "sort": "relevance",
  "distance": "any"
}
'
[
  {
    "@type": "YellBusinessSearchResult",
    "id": "<string>",
    "name": "<string>",
    "rating": 123,
    "review_count": 123,
    "category": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "image": "<string>",
    "is_sponsored": false,
    "profile_url": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
keyword
string
required

Business name or category to search for

Minimum string length: 1
Example:

"plumbers"

​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
location
string
default:""

UK town or postcode to search near

Example:

"London"

​
sort
enum<string>
default:relevance

Result ordering

Available options:
relevance,
rating,
most_reviewed
​
distance
enum<string>
default:any

Search radius in miles around the location

Available options:
any,
2,
5,
10

Response

Successful Response

​
@type
string
default:YellBusinessSearchResult
​
id
string | null
​
name
string | null
​
rating
number | null
​
review_count
integer | null
​
category
string | null
​
phone
string | null
​
website
string | null
​
image
string | null
​
is_sponsored
boolean
default:false
​
profile_url
string | null