Endpoint
GET/v1/yelp/searchlimited capacity1 creditLimited capacity: this operation currently relies on small shared monthly allowances. Availability can end before your account credits are used. Contact support before scheduling or bulk use. Allowances are shared across customers and related operations; this is not a per-account entitlement.
Parameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | What to look for | Cheese Curds |
location | yes | City, address or postcode | Madison, WI |
page | no | Page number (20 per page) | 1 |
sort | no | Result ordering | recommended |
Examples
Make the request
curl
curl "https://www.monocrawl.com/v1/yelp/search?query=Cheese%20Curds&location=Madison%2C%20WI" \ -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/yelp/search?query=Cheese%20Curds&location=Madison%2C%20WI",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/yelp/search?query=Cheese%20Curds&location=Madison%2C%20WI",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
One envelope across every endpoint
This illustrative envelope is not a live response or a payload schema. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
200 · application/json
{
"success": true,
"platform": "yelp",
"endpoint": "/v1/yelp/search",
"data": { "…": "platform-specific fields" },
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}Failures return the shared typed error envelope and cost nothing. Response contract · Error reference