Developer docs › API reference
Account endpoints
The key's own plan, scopes and usage, the account search and the alert feed. Reading plan and usage costs 0 credits.
Authentication · Credits · Common parameters · Error codes · openapi.json
GET /alerts
The alert feed of this workspace — rank drops and rises, keywords entering or leaving the results, rivals passing you or being passed, rival listing changes, Apple Ads rule and management-fee steps, finished keyword discovery runs — newest first, with the unread count. Same feed as the bell in the dashboard.
| Parameter | In | Type | Description |
|---|---|---|---|
limit | query | number | rows, up to 500 (default 50) |
curl "https://storelift.net/v1/alerts" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /portfolio
Today across every app in the workspace, one row per app: live users, users and new users, ad revenue, subscription revenue and trials, plus portfolio totals, hourly and country cards and the subscription event feed. Same numbers as the Today screen of the dashboard. Pass day for a past day.
| Parameter | In | Type | Description |
|---|---|---|---|
tz | query | string | IANA time zone for the day boundary, e.g. Europe/Istanbul (defaults to UTC) |
day | query | string | past day as YYYY-MM-DD (defaults to today) |
curl "https://storelift.net/v1/portfolio" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /account
Who this key or session belongs to: plan, how it authenticated, the scopes it carries, the apps it may read and the credit balance. Costs no credits. Call it when a call was refused for plan, scope or app reasons.
curl "https://storelift.net/v1/account" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Sample response
GET /usage
Every quota of the workspace with what is used and the reset time: tracked keywords, apps, discovery, AI questions, review AI, AI visibility, spy, API credits, today's Hive allowance and the per-second rate. Costs no credits. used=null means the quota is not metered on this plan, not zero.
curl "https://storelift.net/v1/usage" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Sample response
GET /search
Search this account's own records — app names and store ids, tracked keywords, and the rival apps that rank above the user — and get a list of ids to pass to fetch. Use it to locate a record; to discover new apps across the store, use find_apps.
| Parameter | In | Type | Description |
|---|---|---|---|
qrequired | query | string | free text: an app name, a keyword, a rival's name or a store id |
curl "https://storelift.net/v1/search?q=sleep" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Sample response
GET /fetch
The full record behind one id from search: an app card, one tracked keyword with its current state and rank history, or one rival with the keywords it beats the user on. Returns id, title, url, a one-line text and metadata.
| Parameter | In | Type | Description |
|---|---|---|---|
idrequired | query | string | an id exactly as search returned it (app:…, kw:…, rival:…) |
curl "https://storelift.net/v1/fetch?id=kw%3Asbx-lumen%3Aus%3Asleep%2520sounds" \
-H "Authorization: Bearer $STORELIFT_API_KEY"