utility

Quote the credit cost of a call or a plan

Quote what a call will cost before you make it: the exact credits the API holds up front (expected_max, the most it can cost), the lowest possible charge for a successful call (expected_min; unused hold is refunded), the formula, and the params that change the price (levers). The quote comes from the same pricing the API bills with, so it never differs from the real charge. Pass the endpoint as id and its params on this same URL as you would send them (id=tiktok/post/comments&url=...&label=spam), or URL-encoded in params (a query string or a JSON object), which wins on a conflict; a batch endpoint takes its JSON body as body. Add items=N to turn N rows into pages on an endpoint with a known page size. For several calls at once, pass plan: base64url JSON of {calls:[{id, params, repeat}], fan_out:[{from, each, to}]}, or the steps of a utility/plan answer as they are, for per-call and total holds. A request the API would reject comes back valid:false at 0 credits. Nothing is fetched. Free to call.

get/utility/estimate

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/utility/estimate
  • Auth: API key in header x-api-key

Query parameters

idstring

The endpoint to price, as platform/resource (tiktok/post/comments) or its /v1 path, optionally with its query string. Provide this or plan (one of: id, plan; at least one required)

method'GET' | 'POST' | 'PATCH' | 'DELETE'

HTTP method, when the endpoint takes more than one. Defaults to GET when offered

paramsstring

The endpoint's own params, as a URL-encoded query string (url=...&label=spam) or a JSON object. Optional: they may also be sent directly on this URL; these win on a conflict

bodystring

A batch endpoint's JSON body, as JSON or base64url JSON (for example {"urls":[...]} for prism/post-stats)

itemsinteger

Rows you want. Converted to pages with the endpoint's verified page size; warns pages_unknown when it has none

planstring

Several calls at once, as base64url JSON (or JSON): {calls:[{id, params, repeat?, items?}], fan_out?:[{from, each, to}]}, or a utility/plan answer's steps. Provide this or id (one of: id, plan; at least one required)

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": "utility",
  "endpoint": "/v1/utility/estimate",
  "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.