Prism Reviews Bulk API
Starts a background job that collects the review history of many Yelp businesses, closed ones included, and delivers a file per business plus one combined gzipped dataset and a manifest.
POST /v1/prism/reviews/bulkLast updated November 2026Maintained by the SocialCrawl team
When to use the Prism Reviews Bulk API
Use it for a whole market's reviews, such as every restaurant in a city over two years, or to refresh a dataset you delivered before with refresh_of.
From the API reference
Starts a background job (202) that collects the review history of many Yelp businesses (closed ones included), Tripadvisor places, App Store apps or Google Play apps at once, and delivers it as files: one per business and one combined gzipped dataset with a manifest. Tripadvisor yields each place's newest 10,020 reviews per locale (the source sorts newest first only). App Store reads one storefront newest first, up to 32,475 pages of 25 an app (about 812,000 reviews, the deepest app measured; the store states more pages than it serves). Google Play reads newest first per language, up to 5,000 pages of 199 a language; Google Play rows carry no developer replies (responses is null). The body takes platform (yelp, tripadvisor, app_store or google_play), items (1 to 20,000 Yelp business ids, aliases or yelp.com/biz/ links; Tripadvisor place ids or place page links that carry -d<id>-; App Store numeric app ids or apps.apple.com links; Google Play package names or play.google.com links; duplicates are collapsed), and optionally since and until (YYYY-MM-DD), languages (Yelp: all by default; Google Play: language codes, en by default; not taken for Tripadvisor, read in en-US with reviews translated, or the App Store), country (App Store and Google Play only: the two-letter storefront, us by default), max_reviews_per_item (1 to 100,000), format (jsonl, the default, or csv), include (business, the default, adds each business's summary; business_full, Yelp only, adds the business record from the bulk source, 1 more page an item; none), webhook_url (an https URL that receives signed reviews_bulk.paused, reviews_bulk.resumed and reviews_bulk.completed events; the 202 returns its webhook_secret once) and refresh_of (an earlier bulk job's id: its items again, from the day it finished). Any other field is a free 400. Credits are reserved 25 at a time (100 pages) before pages are read, never the whole job up front; when the balance cannot cover the next reservation the job pauses as paused_insufficient_credits, keeps what it has delivered, and resumes by itself once credits are added. A business that cannot be read after retries is unavailable and costs nothing. Read progress and download links, free, with GET /v1/prism/reviews/bulk/{job_id}?offset=&limit= (every link is minted fresh on each read and lives 1 hour); cancel with POST /v1/prism/reviews/bulk/{job_id}/cancel. Files and the job are kept 7 days. Send an Idempotency-Key header to make a retried submit return the same job without a second reservation.
95 platforms behind one API
What can you do with the Reviews Bulk API?
The Reviews Bulk endpoint gives you structured Prism data with computed fields in a single request. No scraping infrastructure to build or maintain.
Example Request
# POST /v1/prism/reviews/bulk: 25 credits per call. Cache hits are free and failed calls are refunded.
# Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
# --max-time 60: the API's own time limit for this endpoint.
# --retry 3: retries timeouts, 429 and 5xx, honoring Retry-After.
# -o response.json keeps only the final attempt's body.
# One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
IDEMPOTENCY_KEY=$(od -An -N16 -tx1 /dev/urandom | tr -d ' \n')
curl -sS --max-time 60 --retry 3 -o response.json -X POST \
-H "x-api-key: YOUR_API_KEY" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
-H "Content-Type: application/json" \
-d '{"platform":"yelp","items":["la-folie-san-francisco-2","fleur-de-lys-san-francisco"],"since":"2024-11-20"}' \
"https://www.socialcrawl.dev/v1/prism/reviews/bulk" && cat response.json# POST /v1/prism/reviews/bulk: 25 credits per call. Cache hits are free and failed calls are refunded.
# Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
import os
import random
import time
import uuid
import requests
API_KEY = os.environ.get("SOCIALCRAWL_API_KEY", "YOUR_API_KEY")
TIMEOUT_S = 60 # the API's own time limit for this endpoint.
MAX_RETRIES = 3
URL = "https://www.socialcrawl.dev/v1/prism/reviews/bulk"
def backoff(attempt):
# Exponential backoff with jitter: about 1 s, 2 s, then 4 s.
return 2 ** attempt * (0.5 + random.random() / 2)
def socialcrawl(payload):
# One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
idempotency_key = str(uuid.uuid4())
for attempt in range(MAX_RETRIES + 1):
try:
res = requests.post(
URL,
json=payload,
headers={"x-api-key": API_KEY, "Idempotency-Key": idempotency_key},
timeout=TIMEOUT_S,
)
body = res.json()
except (requests.RequestException, ValueError):
# A timeout, a dropped connection or a non-JSON gateway page: retry with the same key.
if attempt == MAX_RETRIES:
raise
time.sleep(backoff(attempt))
continue
if body["success"]:
return body
error = body["error"]
# Branch on error["type"], never on the message text.
if error["type"] == "RESOURCE_NOT_FOUND":
return None # refunded: nothing to read
retry_after = res.headers.get("Retry-After")
# SERVICE_UNAVAILABLE without Retry-After is a withdrawn endpoint: permanent.
permanent = error["type"] == "SERVICE_UNAVAILABLE" and retry_after is None
if not error.get("retryable") or permanent or attempt == MAX_RETRIES:
raise RuntimeError(f"{error['type']}: {error['message']} (request_id {body['request_id']})")
# Retry-After (seconds) wins; otherwise back off.
time.sleep(float(retry_after) if retry_after else backoff(attempt))
payload = {
"platform": "yelp",
"items": ["la-folie-san-francisco-2", "fleur-de-lys-san-francisco"],
"since": "2024-11-20",
}
body = socialcrawl(payload)
if body is not None:
print(body["data"])// POST /v1/prism/reviews/bulk: 25 credits per call. Cache hits are free and failed calls are refunded.
// Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
const API_KEY = process.env.SOCIALCRAWL_API_KEY ?? "YOUR_API_KEY";
const TIMEOUT_MS = 60_000; // the API's own time limit for this endpoint.
const MAX_RETRIES = 3;
type Page = { next_cursor: string | null; has_more: boolean };
type SocialCrawlResponse =
| { success: true; data: any; pagination?: Page; credits_used: number; request_id: string }
| { success: false; error: { type: string; message: string; retryable: boolean }; request_id: string };
const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
// Exponential backoff with jitter: about 1 s, 2 s, then 4 s.
const backoffMs = (attempt: number) => 2 ** attempt * 1000 * (0.5 + Math.random() / 2);
async function socialcrawl(url: string, payload: Record<string, unknown>) {
// One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
const idempotencyKey = crypto.randomUUID();
for (let attempt = 0; ; attempt++) {
let res: Response;
let body: SocialCrawlResponse;
try {
res = await fetch(url, {
method: "POST",
headers: {
"x-api-key": API_KEY,
"Content-Type": "application/json",
"Idempotency-Key": idempotencyKey,
},
body: JSON.stringify(payload),
signal: AbortSignal.timeout(TIMEOUT_MS),
});
body = (await res.json()) as SocialCrawlResponse;
} catch (error) {
// A timeout, a dropped connection or a non-JSON gateway page: retry with the same key.
if (attempt >= MAX_RETRIES) throw error;
await sleep(backoffMs(attempt));
continue;
}
if (body.success) return body;
// Branch on error.type, never on the message text.
if (body.error.type === "RESOURCE_NOT_FOUND") return null; // refunded: nothing to read
const retryAfter = res.headers.get("Retry-After");
// SERVICE_UNAVAILABLE without Retry-After is a withdrawn endpoint: permanent.
const permanent = body.error.type === "SERVICE_UNAVAILABLE" && retryAfter === null;
if (!body.error.retryable || permanent || attempt >= MAX_RETRIES) {
throw new Error(`${body.error.type}: ${body.error.message} (request_id ${body.request_id})`);
}
// Retry-After (seconds) wins; otherwise back off.
await sleep(retryAfter ? Number(retryAfter) * 1000 : backoffMs(attempt));
}
}
const body = await socialcrawl("https://www.socialcrawl.dev/v1/prism/reviews/bulk", {
platform: "yelp",
items: ["la-folie-san-francisco-2", "fleur-de-lys-san-francisco"],
since: "2024-11-20",
});
if (body) console.log(body.data);Parameters worth sending
since=2024-11-20Returns only posts after this date, so a daily poll pays only for the pages with new posts.
Parameters
| Parameter | Required | Description |
|---|---|---|
| platform | Yes | The review platform: `yelp`, `tripadvisor`, `app_store` or `google_play`. |
| items | Yes | JSON array of 1 to 20,000 businesses. Yelp: business ids, aliases or links, for example la-folie-san-francisco-2. Tripadvisor: place ids or place pages (a url_path or URL that carries -d<id>-), for example 93450. App Store: numeric app ids or apps.apple.com links, for example 324684580. Google Play: package names or play.google.com links, for example com.spotify.music. |
| since | No | Only reviews on or after this UTC day, as YYYY-MM-DD. |
| until | No | Only reviews on or before this UTC day, as YYYY-MM-DD. |
| languages | No | Yelp: `all` (the default) or a comma list of language codes, such as `en,fr`. Google Play: a comma list of language codes, `en` by default. Not taken for Tripadvisor (read in English, en-US, with reviews in other languages translated) or the App Store (read per storefront). |
| max_reviews_per_item | No | Stop each business after this many reviews, 1 to 100,000. |
| format | No | `jsonl` (the default: one JSON object a line, the business line first) or `csv`. (jsonl | csv) |
| include | No | `business` (the default) adds each business's summary (name, rating, total reviews); `none` leaves it out. `business_full` (Yelp only, 1 more page, 0.25 credits, an item) adds the business record from the bulk source on `place`: name, address, coordinates, phone, website, claimed, closed, rating, categories, hours, the business's own description, and a timezone derived from the coordinates. The menu link and amenity flags are not included; call GET /v1/yelp/business/info for those. A record that cannot be read is null and not billed. A business whose Yelp link has accented letters (such as café) can be read only by its business id: send the 22-character id from GET /v1/yelp/search as the item, for both its reviews and its record. (business | none) |
| webhook_url | No | An https URL that receives signed job events. The 202 returns the signing secret once as `webhook_secret`. |
| refresh_of | No | An earlier bulk job's id: the same items again, from the day it finished. The earlier job must still be kept (7 days). |
What does the Prism Reviews Bulk API return?
This example shows the endpoint's response shape and fields. Values are illustrative; this is not a live capture.
Example response
{
"success": true,
"platform": "prism",
"endpoint": "/v1/prism/reviews/bulk",
"data": {
"job_id": "job_4h7s2m9x1",
"status": "queued",
"platform": "yelp",
"items_total": 2,
"items_done": 0,
"items_unavailable": 0,
"pages_read": 0,
"reviews_collected": 0,
"credits_reserved": 25,
"credits_charged": null,
"expires_at": "2026-11-27T18:00:00.000Z",
"retention": "Files, the manifest and this job are kept 7 days from submit (see expires_at). Every download URL is minted fresh on each read and lives 60 minutes. refresh_of needs the earlier job still within its 7 days."
},
"credits_used": 25,
"credits_remaining": 9975,
"request_id": "req-a1b2c3d4e5f6",
"cached": false
}Illustrative fixture for the documented response shape. Values are examples, not a production capture.
How does the Prism Reviews Bulk API work?
Send a GET request with your API key and get back clean, structured JSON in our unified schema. Supported computed fields are populated when the source provides the required inputs.
Method
POST
Response
JSON
How do you scrape social media data in seconds?
The fastest social media scraping API for developers. Scrape profiles, posts, comments, and analytics from 95 platforms covering 10B+ monthly active users.
One schema, every platform
Query 95 platforms with identical response structures. Write your integration once.
Computed fields, not just scraped
When an endpoint supports these metrics and the source provides the required inputs, the normalized record includes engagement_rate, estimated_reach, content_category, and language. Ready to use.
See your data before you code
Visual Data Explorer. Paste any URL, get rich result cards, sortable tables, CSV export.
import requests
response = requests.get(
'https://www.socialcrawl.dev/v1/tiktok/profile',
params={'handle': 'charlidamelio'},
headers={'x-api-key': 'sc_YOUR_API_KEY'}
)
data = response.json(){
"success": true,
"platform": "tiktok",
"data": {
"author": {
"username": "charlidamelio",
"followers": 152400000
},
"engagement": {
"likes": 12400000000,
"engagement_rate": 0.087
},
"metadata": {
"language": "en",
"content_category": "lifestyle"
}
}
}Have a question? We got answers
Find answers to frequently asked questions about SocialCrawl's API, pricing, and capabilities.
Contact usWhat does the Prism Reviews Bulk API return?
When should I use the Prism Reviews Bulk endpoint?
How much does the Prism Reviews Bulk API cost?
What parameters does the Prism Reviews Bulk API need?
How do I call the Prism Reviews Bulk API?
Ask AI about SocialCrawl
Ready to scrape Prism Reviews Bulk data?
Get your API key and start pulling Prism data in under 60 seconds.
