[ docs ]Places & travel

Yelp

Measured Yelp data, one operation per call. Businesses are named by their yelp.com/biz/ URL or its slug. Every fetch adds rating and review count to the business's history. ops: businesses (full profiles for up to ten businesses — address and coordinates, phone, website, menu, rating with star breakdown, review insights by topic with sentiment, review highlights, popular dishes, attributes, hours today, health inspections, Q&A), search (a query and location with sort, price levels and Yelp feature filters; every hit a full profile), reviews (reviews for up to ten businesses — text, rating, date, reactions, reviewer profile, owner reply), history (stored rating/review-count series for businesses already held, free). Ops are independent — issue several as PARALLEL tool calls. Fresh fetches cost credits; anything already held is free.

POST https://api.zomler.com/api/v1/platforms/yelp

businesses
search
reviews
history

businesses

from 1 credit · fresh for 3 days

Full profiles for up to ten businesses by URL or slug — address, phone, website, rating and star breakdown, review insights by topic, popular dishes, attributes, hours, health inspections.

Request fields

Field	Type	Default	Values / limits
`subjects`required	list of string	—	1-10 items

Example

curl

curl -X POST https://api.zomler.com/api/v1/platforms/yelp \
  -H "X-API-Key: zk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "request": {
    "op": "businesses",
    "subjects": [
      "example"
    ]
  },
  "estimateOnly": false
}'

JavaScript

const res = await fetch("https://api.zomler.com/api/v1/platforms/yelp", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.ZOMLER_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "request": {
      "op": "businesses",
      "subjects": [
        "example"
      ]
    },
    "estimateOnly": false
  }),
});
const envelope = await res.json();
console.log(envelope.data, envelope.cost.creditsCharged);

Python

import os, httpx

res = httpx.post(
    "https://api.zomler.com/api/v1/platforms/yelp",
    headers={"X-API-Key": os.environ["ZOMLER_API_KEY"]},
    json={
      "request": {
        "op": "businesses",
        "subjects": [
          "example"
        ]
      },
      "estimateOnly": False
    },
    timeout=120,
)
envelope = res.json()
print(envelope["data"], envelope["cost"]["creditsCharged"])

search

from 5 credits for 10

Businesses for a place and keyword, with Yelp's own sort, price levels and feature filters — every hit a full profile.

Request fields

Field	Type	Default	Values / limits
`query`required	string	—	≤300 chars
`location`required	string	—	≤120 chars
`sort`	enum	`relevance`	`relevancerating_highmost_reviewed`
`priceLevels`◆	list of enum	`[]`	`1234`
`features`◆	list of string	`[]`	each ≤40 chars
`limit`	integer	`10`	1-100

Example

curl

curl -X POST https://api.zomler.com/api/v1/platforms/yelp \
  -H "X-API-Key: zk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "request": {
    "op": "search",
    "query": "example",
    "location": "New York"
  },
  "estimateOnly": false
}'

JavaScript

const res = await fetch("https://api.zomler.com/api/v1/platforms/yelp", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.ZOMLER_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "request": {
      "op": "search",
      "query": "example",
      "location": "New York"
    },
    "estimateOnly": false
  }),
});
const envelope = await res.json();
console.log(envelope.data, envelope.cost.creditsCharged);

Python

import os, httpx

res = httpx.post(
    "https://api.zomler.com/api/v1/platforms/yelp",
    headers={"X-API-Key": os.environ["ZOMLER_API_KEY"]},
    json={
      "request": {
        "op": "search",
        "query": "example",
        "location": "New York"
      },
      "estimateOnly": False
    },
    timeout=120,
)
envelope = res.json()
print(envelope["data"], envelope["cost"]["creditsCharged"])

reviews

from 7 credits for 25 · fresh for 3 days

Reviews for up to ten businesses — text, rating, date, reactions, reviewer profile, owner reply.

Request fields

Field	Type	Default	Values / limits
`subjects`required	list of string	—	1-10 items
`limit`	integer	`25`	1-100

Example

curl

curl -X POST https://api.zomler.com/api/v1/platforms/yelp \
  -H "X-API-Key: zk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "request": {
    "op": "reviews",
    "subjects": [
      "example"
    ]
  },
  "estimateOnly": false
}'

JavaScript

const res = await fetch("https://api.zomler.com/api/v1/platforms/yelp", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.ZOMLER_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "request": {
      "op": "reviews",
      "subjects": [
        "example"
      ]
    },
    "estimateOnly": false
  }),
});
const envelope = await res.json();
console.log(envelope.data, envelope.cost.creditsCharged);

Python

import os, httpx

res = httpx.post(
    "https://api.zomler.com/api/v1/platforms/yelp",
    headers={"X-API-Key": os.environ["ZOMLER_API_KEY"]},
    json={
      "request": {
        "op": "reviews",
        "subjects": [
          "example"
        ]
      },
      "estimateOnly": False
    },
    timeout=120,
)
envelope = res.json()
print(envelope["data"], envelope["cost"]["creditsCharged"])

history

free · reads what is held

Stored rating/review-count series of businesses already held — free.

Request fields

Field	Type	Default	Values / limits
`subjects`required	list of string	—	1-10 items
`metric`	enum	`rating`	`ratingtotal_reviews`
`days`	integer	`90`	1-730

Example

curl

curl -X POST https://api.zomler.com/api/v1/platforms/yelp \
  -H "X-API-Key: zk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "request": {
    "op": "history",
    "subjects": [
      "example"
    ]
  },
  "estimateOnly": false
}'

JavaScript

const res = await fetch("https://api.zomler.com/api/v1/platforms/yelp", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.ZOMLER_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "request": {
      "op": "history",
      "subjects": [
        "example"
      ]
    },
    "estimateOnly": false
  }),
});
const envelope = await res.json();
console.log(envelope.data, envelope.cost.creditsCharged);

Python

import os, httpx

res = httpx.post(
    "https://api.zomler.com/api/v1/platforms/yelp",
    headers={"X-API-Key": os.environ["ZOMLER_API_KEY"]},
    json={
      "request": {
        "op": "history",
        "subjects": [
          "example"
        ]
      },
      "estimateOnly": False
    },
    timeout=120,
)
envelope = res.json()
print(envelope["data"], envelope["cost"]["creditsCharged"])