prism

Buyer leads from the comments under the posts a keyword search returns, opening only the posts worth opening.

Searches TikTok for query, decides which posts are worth opening, fetches the comments of those posts only, and returns the commenters who want to buy what you sell. Every searched post that reports comments is judged for whether people who want offer would plausibly comment under it; posts judged clearly off-offer are skipped, and the busiest of the rest (by reported comment count) are opened, up to open. Each fetched comment is then labelled for purchase intent (says they bought or want to buy, or asks for a link, a price or where to get it), for being a real question, for spam, and for whether offer would help its author; a comment is a lead when purchase intent is at least 0.5, spam below 0.5 and offer fit at least 0.5. Each lead carries the comment id and text, the commenter's public username and display name as the platform shows them, the post it came from and every probability. posts_opened gives per-post stats, skipped_posts lists every post not opened with its reason (no_comments, no_url, below_gate, over_open_limit) and its judgment, and economics reports posts searched and opened, comments fetched and judged, credits by leg, the credits held and refunded, an estimate of what opening every post would have cost at the same prices, and credits per lead. Measured on 15 real searches (5 Korean): with the default open=12 it found 88% of the leads that opening every post found, at 0.96 credits a lead against 1.39. Posts that report no comments are never opened. If the post judgment is unavailable the busiest posts are opened instead (_warnings: ['post_gate_unavailable']); a comment that could not be labelled is never a lead and is not billed. include=askers adds comments that ask a question the offer would answer, as kind: 'asker'. Leads are labels for your own review: nothing is contacted.

get/prism/comment-leads

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/prism/comment-leads
  • Auth: API key in header x-api-key

Query parameters

querystring required

The keyword search to run (max 100 chars).

offerstring

What you sell, in one or two plain sentences (max 300 chars). Used to judge which posts would draw your buyers and whether each commenter would be helped by it. Default: the query itself.

platform'tiktok'

Platform to search. tiktok (default and, for now, only).

postsinteger

How many posts to search (1-90, default 30; 30 posts a search page).

openinteger

The most posts whose comments are fetched (1-20, default 12).

comments_per_postinteger

The most comments read from each opened post (1-200, default 50; 50 comments a page).

includestring

Set askers to also return comments that ask a question the offer would answer, marked kind: 'asker'.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/comment-leads",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.