Piloterr

Starbucks Search

GET
/v2/starbucks/search

Nearest Starbucks cafés from coordinates or a store-locator URL. Returns address, hours, amenities, and the store number used by Menu and Product.

Credit cost: 3 credits per call

Authentification

ApiKeyAuth
headerx-api-key<token>

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

Paramètres de requête

query?string

Store-locator URL, or a lat,lng pair. Required when lat and lng are empty.

Example:

https://www.starbucks.com/store-locator?map=40.71391,-74.01121,12z
lat?number

Latitude. Send it with lng. If both are set, they replace any coordinates found in query.

lng?number

Longitude. Send it with lat.

place?string

Optional place label sent with the coordinates, for example New York, NY. Coordinates are still required.

features?string

Optional amenity filter. Separate codes with commas. ON keeps cafés that offer mobile order.

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

Corps de la réponse

Successful response

application/json
  1. response
results?array<>
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/starbucks/search'
Example Response
{  "results": [    {      "name": "DTLA Grand Park",      "open": false,      "phone": "+1 213-625-2205",      "address": {        "city": "Los Angeles",        "line1": "217 N. Hill Street",        "region": "CA",        "country": "US",        "formatted": "217 N. Hill Street, Los Angeles",        "postal_code": "90012"      },      "distance": 0.262,      "schedule": [        {          "day": "thursday",          "open": true,          "hours": "4:30 AM to 9:00 PM"        },        {          "day": "friday",          "open": true,          "hours": "4:30 AM to 9:00 PM"        },        {          "day": "saturday",          "open": true,          "hours": "5:00 AM to 5:00 PM"        },        {          "day": "sunday",          "open": true,          "hours": "5:00 AM to 5:00 PM"        },        {          "day": "monday",          "open": true,          "hours": "4:30 AM to 9:00 PM"        },        {          "day": "tuesday",          "open": true,          "hours": "4:30 AM to 9:00 PM"        },        {          "day": "wednesday",          "open": true,          "hours": "4:30 AM to 9:00 PM"        }      ],      "store_id": "69543",      "amenities": [        "In café",        "Mobile Order and Pay",        "MOP ASAP + Scheduled Ordering",        "Nitro Cold Brew",        "Oven-warmed Food",        "Redeem Rewards",        "Starbucks Wi-Fi"      ],      "time_zone": "GMT-07:00 America/Los_Angeles",      "coordinates": {        "latitude": 34.05612,        "longitude": -118.24698      },      "open_status": "Opens Thursday at 4:30 AM",      "hours_status": "Open 4:30 AM-9:00 PM",      "store_number": "9230-154245",      "ownership_type_code": "co",      "recommendation_reason": "nearby"    }  ],  "pagination": {    "next": null,    "page": 1,    "per_page": 50,    "total_pages": null,    "total_results": null  }}