Prism Reviews Bulk API
여러 Yelp 업체의 리뷰 전체를 폐업한 업체까지 한 번에 모으는 백그라운드 작업을 시작하고, 업체별 파일과 하나로 합친 gzip 데이터셋, 매니페스트를 전달합니다.
POST /v1/prism/reviews/bulkPrism Reviews Bulk API는 언제 쓰나요
한 도시의 모든 식당 리뷰를 2년치 받는 것처럼 시장 전체의 리뷰가 필요할 때, 또는 전에 받은 데이터셋을 refresh_of로 새로 고칠 때 사용하세요.
API 레퍼런스 영문 원문
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개 플랫폼을 하나의 API로 제공합니다
Reviews Bulk API로 무엇을 할 수 있을까요
Reviews Bulk 엔드포인트가 통합 스키마와 계산 필드를 담은 Prism 데이터를 한 번의 요청으로 보내드려요. 스크래핑 인프라를 직접 만들거나 유지할 필요가 없어요.
요청 예시
# 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);함께 보내면 좋은 파라미터
since=2024-11-20이 날짜 이후에 올라온 게시물만 반환합니다. 매일 조회할 때 새 게시물이 있는 페이지만 과금됩니다.
파라미터
| 파라미터 | 필수 | 설명 |
|---|---|---|
| platform | 예 | The review platform: `yelp`, `tripadvisor`, `app_store` or `google_play`. |
| items | 예 | 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 | 아니오 | Only reviews on or after this UTC day, as YYYY-MM-DD. |
| until | 아니오 | Only reviews on or before this UTC day, as YYYY-MM-DD. |
| languages | 아니오 | 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 | 아니오 | Stop each business after this many reviews, 1 to 100,000. |
| format | 아니오 | `jsonl` (the default: one JSON object a line, the business line first) or `csv`. (jsonl | csv) |
| include | 아니오 | `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 | 아니오 | An https URL that receives signed job events. The 202 returns the signing secret once as `webhook_secret`. |
| refresh_of | 아니오 | An earlier bulk job's id: the same items again, from the day it finished. The earlier job must still be kept (7 days). |
Prism Reviews Bulk API는 무엇을 돌려주나요
이 엔드포인트의 응답 구조와 필드를 보여 주는 예시예요. 값은 이해를 돕기 위한 것이며 실제 조회 결과는 아니에요.
응답 예시 보기
{
"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
}문서에 나온 응답 구조를 보여 주는 예시예요. 값은 이해를 돕기 위한 것이며 운영 환경에서 가져온 응답이 아니에요.
Prism Reviews Bulk API는 어떻게 동작하나요
API 키와 함께 GET 요청을 보내면, 통합 스키마와 계산 필드를 담은 깔끔한 JSON이 돌아와요.
메서드
POST
응답 형식
JSON
소셜 미디어 데이터를 몇 초 만에 수집하는 방법
개발자를 위한 가장 빠른 소셜 미디어 스크래핑 API. 월간 활성 사용자 100억 명 이상을 포괄하는 95개 플랫폼에서 프로필, 게시물, 댓글, 분석 데이터를 수집하세요.
모든 플랫폼을 하나의 스키마로
동일한 응답 구조로 95개 플랫폼을 조회하세요. 연동은 한 번이면 충분합니다.
단순 수집을 넘어 계산된 필드 제공
엔드포인트가 해당 지표를 지원하고 계산에 필요한 원본 값이 있을 때, 정규화된 레코드에 engagement_rate, estimated_reach, content_category, language를 함께 담아 바로 활용할 수 있습니다.
코드 한 줄 쓰기 전에, 데이터부터
Visual Data Explorer에 URL만 붙여넣으면 결과 카드와 정형화된 테이블, CSV 내보내기를 바로 사용할 수 있습니다.
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"
}
}
}자주 묻는 질문
API, 요금제, 기능에 대한 질문과 답변입니다.
문의하기Prism Reviews Bulk API는 어떤 데이터를 돌려주나요?
Prism Reviews Bulk 엔드포인트는 언제 쓰면 좋나요?
Prism Reviews Bulk API 비용은 얼마인가요?
Prism Reviews Bulk API에는 어떤 파라미터가 필요한가요?
Prism Reviews Bulk API는 어떻게 호출하나요?
AI에게 SocialCrawl을 물어보세요
Prism Reviews Bulk 데이터, 가져올 준비 되셨어요?
API 키 받고 60초 안에 Prism 데이터를 받아 가세요.
