Get a key
- Open Settings → API in the dashboard.
- Click Create key and give it a name you’ll recognize later.
- Copy the key. It starts with
sg_live_and is shown once — we store only a hash, so if you lose it you’ll need to create another.
Your first call
Every endpoint is brand-scoped except search, so start by resolving a brand.id and ask what that brand is running:
What you can ask for
Full parameters and response schemas are in the
API reference.
Before you build
Three things worth knowing up front, because they shape how you write the client:- Calls cost credits, per row returned. Bound every call with
limitorcount. See Billing. - Nothing is paginated.
countis the number of rows in this response, not a total. See Conventions. - It’s server-to-server. There’s no CORS, so calls must come from your backend, not a browser.