Utility Search Docs API
질문과 가장 잘 맞는 문서 섹션을 순위대로 반환합니다. 제목, 앵커가 있는 마크다운 링크, 페이지 URL, 짧은 발췌문이 담깁니다.
GET /v1/utility/docs-searchUtility Search Docs API는 언제 쓰나요
인증, 크레딧, 에러, 레이트 리밋, 엔드포인트에 대한 질문의 답이 있는 문서 페이지를 찾을 때 무료로 사용하세요.
API 레퍼런스 영문 원문
Search the developer docs and endpoint reference for a question and get the best-matching sections, ranked, each with a title, a link to its Markdown twin with an anchor (fetch the .md to read just that page), the page URL and a short snippet. Covers authentication, credits and refunds, pagination, errors, rate limits, caching, monitors, universal search and every endpoint. Pass platform to scope it to one platform, and limit for how many sections (default 5, up to 10). Free to call.
75개 플랫폼을 하나의 API로 제공합니다
Search Docs API로 무엇을 할 수 있을까요
Search Docs 엔드포인트가 통합 스키마와 계산 필드를 담은 Utility 데이터를 한 번의 요청으로 보내드려요. 스크래핑 인프라를 직접 만들거나 유지할 필요가 없어요.
요청 예시
# GET /v1/utility/docs-search: Free: 0 credits per call.
# --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 \
-H "x-api-key: YOUR_API_KEY" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
"https://www.socialcrawl.dev/v1/utility/docs-search?query=how+does+cursor+pagination+work&limit=3" && cat response.json# GET /v1/utility/docs-search: Free: 0 credits per call.
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/utility/docs-search"
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(params):
# 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.get(
URL,
params=params,
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))
params = {
"query": "how does cursor pagination work",
"limit": "3",
}
body = socialcrawl(params)
if body is not None:
print(body["data"])// GET /v1/utility/docs-search: Free: 0 credits per call.
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: URL) {
// 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, {
headers: {
"x-api-key": API_KEY,
"Idempotency-Key": idempotencyKey,
},
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 url = new URL("https://www.socialcrawl.dev/v1/utility/docs-search");
url.searchParams.set("query", "how does cursor pagination work");
url.searchParams.set("limit", "3");
const body = await socialcrawl(url);
if (body) console.log(body.data);파라미터
| 파라미터 | 필수 | 설명 |
|---|---|---|
| query | 아니오 | What to look up, in a few words or a question. Provide this or q |
| q | 아니오 | Short alias for query. Provide this or query |
| platform | 아니오 | Scope the search to one platform slug |
| limit | 아니오 | Sections to return, 1 to 10 (default 5) |
Utility Search Docs API는 무엇을 돌려주나요
문서에 나온 응답 구조와 필드를 보여 주기 위해 만든 합성 예시예요. 값은 이해를 돕기 위한 것이며 실제 API 응답은 아니에요.
응답 예시 보기
{
"success": true,
"platform": "utility",
"endpoint": "/v1/utility/docs-search",
"data": {
"kind": "docs_search",
"version": 1,
"query": "how does cursor pagination work",
"count": 3,
"results": [
{
"title": "Pagination: Facebook",
"url": "https://www.socialcrawl.dev/docs/pagination.md#facebook",
"page_url": "https://www.socialcrawl.dev/docs/pagination",
"snippet": "...| `GET /v1/facebook/adlibrary/company/ads` | `cursor` | cursor | n/a | | [Search Facebook Ad Library](/platforms/facebook/adlibrary-search-ads) | `GET /v1/facebook/adlibrary/search/ads` | `cursor` | cursor | n/a | | [List Facebook events for a city](/platforms/facebook/events) | `GET /v1/facebook/events` | `cursor` | cursor | n/a | | [Search Facebook..."
},
{
"title": "Pagination: TikTok",
"url": "https://www.socialcrawl.dev/docs/pagination.md#tiktok",
"page_url": "https://www.socialcrawl.dev/docs/pagination",
"snippet": "...place](/platforms/tiktok/location-posts) | `GET /v1/tiktok/location/posts` | `cursor` | cursor | n/a | | [List videos in a TikTok playlist](/platforms/tiktok/playlist-videos) | `GET /v1/tiktok/playlist/videos` | `cursor` | cursor | n/a | | [List TikTok post comments](/platforms/tiktok/post-comments) | `GET /v1/tiktok/post/comments` | `cursor` | cursor..."
},
{
"title": "Pagination: Instagram",
"url": "https://www.socialcrawl.dev/docs/pagination.md#instagram",
"page_url": "https://www.socialcrawl.dev/docs/pagination",
"snippet": "...comment](/platforms/instagram/comment-likers) | `GET /v1/instagram/comment/likers` | `cursor` | cursor | n/a | | [List Instagram followers](/platforms/instagram/followers) | `GET /v1/instagram/followers` | `cursor` | cursor | n/a | | [List Instagram following](/platforms/instagram/following) | `GET /v1/instagram/following` | `cursor` | cursor | n/a | |..."
}
]
},
"credits_used": 0,
"request_id": "req_example000000",
"cached": false
}문서에 나온 응답 구조를 확인하기 위한 합성 예시예요. 값은 이해를 돕기 위한 것이며 운영 환경에서 가져온 응답이 아니에요.
Utility Search Docs API는 어떻게 동작하나요
API 키와 함께 GET 요청을 보내면, 통합 스키마와 계산 필드를 담은 깔끔한 JSON이 돌아와요.
메서드
GET
응답 형식
JSON
소셜 미디어 데이터를 몇 초 만에 수집하는 방법
개발자를 위한 가장 빠른 소셜 미디어 스크래핑 API. 월간 활성 사용자 100억 명 이상을 포괄하는 75개 플랫폼에서 프로필, 게시물, 댓글, 분석 데이터를 수집하세요.
모든 플랫폼을 하나의 스키마로
동일한 응답 구조로 75개 플랫폼을 조회하세요. 연동은 한 번이면 충분합니다.
단순 수집을 넘어 계산된 필드 제공
엔드포인트가 해당 지표를 지원하고 계산에 필요한 원본 값이 있을 때, 정규화된 레코드에 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, 요금제, 기능에 대한 질문과 답변입니다.
문의하기Search Docs API는 어떤 데이터를 돌려주나요?
Search Docs 엔드포인트는 언제 쓰면 좋나요?
Search Docs API 비용은 얼마인가요?
Search Docs API에는 어떤 파라미터가 필요한가요?
Search Docs API는 어떻게 호출하나요?
AI에게 SocialCrawl을 물어보세요
Utility Search Docs 데이터, 가져올 준비 되셨어요?
API 키 받고 60초 안에 Utility 데이터를 받아 가세요.
