Piloterr

Yelp Business

GET
/v2/yelp/business

Fetch a Yelp business profile from a full business URL with phone, address, website, logo, hours, and claim status.

Credit cost: 2 credits per call

Autorización

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parámetros de consulta

query*string

Full Yelp business URL.

Example:

https://www.yelp.com/biz/novela-san-francisco-2

Use an organic /biz/ link from Yelp Search results.

fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Cuerpo de la respuesta

Successful response

application/json
  1. response
url?string
logo?string
name?string
phone?string
address?string
website?string
open_hours?
business_id?string
claim_status?string
Example Request
curl -X GET 'https://api.piloterr.com/v2/yelp/business?query=string'
Example Response
{  "url": "https://www.yelp.com/biz/novela-san-francisco-2?osq=bars+open&rr=4",  "logo": "https://s3-media0.fl.yelpcdn.com/businessregularlogo/dkB_F32_r_PfLpQLAuNsFA/ms.jpg",  "name": "Novela",  "phone": "(415) 896-6500",  "address": "662 Mission St San Francisco, CA 94105",  "website": "novelasf.com",  "open_hours": {    "fri": "4:00 PM - 2:00 AM (Next day)",    "mon": "4:00 PM - 12:00 AM (Next day)",    "sat": "5:00 PM - 2:00 AM (Next day)",    "sun": "Closed",    "thu": "4:00 PM - 2:00 AM (Next day)",    "tue": "4:00 PM - 1:00 AM (Next day)",    "wed": "4:00 PM - 1:00 AM (Next day)"  },  "business_id": "cX5dOMkwZ5rqWbeIJpw_Ig",  "claim_status": "claimed"}