Yelp
Extract data from Yelp
Extract data from Yelp.
Base URL: /v1/yelp/...
Getting Started
Make your first request to any endpoint below.
3. Read computed fields
When an endpoint supports a computed field and the required source inputs are present, the unified response includes that optional field. Depending on the endpoint, optional fields can include engagement_rate, language, content_category, and estimated_reach. See Computed fields for formulas, clamping rules, and null semantics. Where an endpoint supports them, list rows also carry judged labels (computed.labels, computed.relevance) by default at no extra credits; see Labels.
Endpoints
5 endpoints available.
| Endpoint | Path | Credit Tier |
|---|---|---|
| Get a Yelp business by encid | /v1/yelp/business/info | standard (1cr) |
| Search Yelp businesses | /v1/yelp/search | standard (1cr) |
| Search Yelp businesses with full cards | /v1/yelp/search/full | standard (1cr) |
| Get Yelp search suggestions | /v1/yelp/search/suggestions | standard (1cr) |
| Get Yelp reviews for a business | /v1/yelp/business/reviews | advanced (5-9cr)metered |
Labels
/v1/yelp/business/reviews labels each review by default, at no extra credit: sentiment (read from the words, never the stars, with rating_mismatch when the two clearly disagree) and issue (the main problem the review reports) on computed.labels. Send judgments=off for the page without them. See Labels for the field shapes and the labels you can add with label=, such as label=reports&reports=the battery drains quickly.
Notes
- All endpoints use
GETmethod with query parameters - Authentication via
x-api-keyheader - Responses follow the unified SocialCrawl schema