🚧

Location Subscription API is deprecated

Please migrate to the Business Subscriptions API

❗️

Deprecated Version

This page describes the deprecated v1 Version of the Location Subscription API. It's deprecated and will be removed in the future.

Please start migrating your clients to use the new version. New Location Subscription API v2 Docs

Overview

Location Subscription is the system that generates data on Yelp businesses and stores it on Amazon S3 buckets. Partners can use the Location Subscription API to modify the list of businesses that appear in their subscription feed. The API has add, remove, list, and quota endpoints.

Authentication

Authentication uses basic HTTP authentication over SSL. Credentials are provided separately.

Endpoints

POST /syndication/feed/add

This endpoint is used to add business IDs to the subscription list. The post accepts a JSON list of business IDs mapped to the key 'biz_ids'.

Request Body Parameters

curl -H "Content-Type: application/json" \
     -X POST \
     -d '{"biz_ids":["bzRqPKp63X0u6fUtbg"]}' \
     --user "<user>:<password>" \
     "https://partner-api.yelp.com/syndication/feed/add"

Response Body Parameters

{
  "new": [], 
  "reactivated": [], 
  "already_active": []
}

POST /syndication/feed/remove

This endpoint is used to disable business IDs from the subscription list. The post accepts a list of business IDs mapped to the key "biz_ids".
Response Body Parameters

curl -H "Content-Type: application/json" \
     -X POST \
     -d '{"biz_ids":["VXi7gzRqPKp63X0u6fUtbg"]}' \
     --user "<user>:<password>" \
     "https://partner-api.yelp.com/syndication/feed/remove"

Response Params

{
  "status": "completed"
}

GET /syndication/feed/quota

This endpoint is gets quota information. Takes in no parameters.

Request Params
None

curl -X GET \
     -H "Accept: application/json" \
     -H "Content-type: application/json" \
     --user "<user>:<password>" \
     "https://partner-api.yelp.com/syndication/feed/quota"

Response Params

{
  "number_of_active_businesses": 17
}

GET /syndication/feed/list

This endpoint is used to get the list of subscription business IDs. The two query params have default values of 0.

Request Query Parameters

curl -X GET \
     -H "Accept: application/json" \
     -H "Content-type: application/json" \
     --user "<user>:<password>" \
     "https://partner-api.yelp.com/syndication/feed/list?limit=1&offset=1"

Response Parameters

{
  "biz_ids": ["VXi7gzRqPKp63X0u6fUtbg"]
}

Error Codes

Response Params

{
  "error": {
    "message": "The post body contains invalid business ids", 
    "code": "INVALID_IDS_IN_POST_BODY",
    "invalid_ids": ["VXi7gzRqPKp63X0"] 
  }
}