Authentication
Every request carries a bearer token.unif_sk_test_ key hits the same endpoints against
sandbox fixtures and costs nothing. See
Authentication.
Conventions
No envelope
A
200 body is the object itself. Success and failure are carried by the HTTP status code.Cursor pagination
Lists return
has_more and next_cursor. Loop on has_more, never on page length.Self-describing records
Every object repeats the
period and currency it was measured under, plus a meta block.Ratios, not percentages
Every
*_rate and *_share field is a ratio. 0.25 is 25%.Search takes POST
The fivesearch endpoints use POST with a JSON body. Filter sets are nested and open-ended, and
a body keeps them readable and replayable — but the calls are read-only, safe to retry, and need no
Idempotency-Key. See Search.
Response headers
Errors
type and code; never parse message. Retry 429 and 5xx, nothing else. The full
taxonomy is in Errors.
Endpoint groups
Meta
Workspace, channel entitlements and field coverage. All free to call.
Entities
Search, detail and timeseries for shops, products, creators, videos, livestreams and
categories.
Resolution
Turn URLs, handles and native IDs into stable Unif IDs, with or without data attached.
Jobs
Bulk enrichment, deep search and exports, collected by webhook.
Lists and trackers
Saved sets and the scheduled re-checks that watch them.
Usage
Credit balance and the per-request ledger.