API referansı

Temel adres

https://storelift.net/v1

Aşağıdaki her yol bu adrese görelidir. Okumalar için GET gönder; POST yalnız /actions içindir.

Kimlik doğrulama

Anahtarı Authorization: Bearer <key> ya da x-api-key başlığında gönder. Anahtarları Ayarlar › API altında üret; her anahtar kapsamlarını, isteğe bağlı olarak da izinli IP listesini, uygulama listesini ve aylık kredi bütçesini taşır. Bütçesine ulaşan anahtar, ay dönene kadar 402 key_budget_reached yanıtı verir; öbür anahtarlar çalışmaya devam eder.

REST API için canlı anahtarlar (sl_live_) Pro ve üstü planlardadır ya da kredi paketiyle her planda açılır. Free planda yalnız MCP sunucusunda çalışan tek canlı anahtar vardır. Test anahtarları (sl_test_) her planda kum havuzu verisini döndürür. Asistanlar her planda MCP sunucusu üzerinden OAuth ile giriş yapar.

Kredi ve sınırlar

Her çağrı, üzerinde yazan kadar kredi harcar; /account ve /usage 0 kredidir, bir yazmanın önizlemesi de 0 kredidir. Her yanıt x-credits-used, x-credits-limit, x-credits-remaining ve x-credits-reset başlıklarını taşır.

Saniyedeki istek sayısı plana göre belirlenir; aşınca retry-after ile birlikte 429 rate_limited alırsın. Hive uçları satın alınmış API kredisiyle ya da Hive Explorer ile açılır ve ayrıca günlük bir haktan düşer: paket kredisiyle 500 çağrı, Hive Explorer ile 10.000. Çağrı başına kredi

Kum havuzu

https://storelift.net/v1/sandbox, aşağıda örnek yanıtı olan her okumayı anahtarsız ve kredisiz yanıtlar. Veri sabit ve tarihlidir; bu sayede testler kararlı kalır.

Test anahtarları (sl_test_) aynı veriyi canlı temel adreste döndürür ve hiçbir zaman yazmaz.

Sıra nasıl okunur

Bir sıranın üç hâli vardır ve bunlar birbirine karışmaz: measured: false sorgunun o gün ölçülmediğini, rank: null ölçüldüğünü ama uygulamanın okunan sonuçların dışında kaldığını gösterir; sayı ise sıranın kendisidir.

Hatalar

Her hata aynı gövdeyle döner: { "error": "<code>", "message": "…", "docs": "…" }. error değişmez; kodunda message değerine değil ona göre karar ver. Bazı kodlar scope, field ya da limit gibi alanlar ekler. Bütün hata kodları

Örnek işler

Üç iş; ilk çağrıdan saklayacağın sonuca kadar. Her komut kum havuzunda çalışır; bu yüzden kredi harcamaz ve hiçbir şeyi değiştirmez, her yanıt da kum havuzunun o komuta verdiği yanıttır.

Kendi anahtarınla yollar /sandbox olmadan aynıdır ve her çağrı üzerinde yazan kadar kredi harcar. Test anahtarı (sl_test_) orada da kum havuzu verisiyle, 0 krediyle yanıt verir.

function weeklyRow(body) {
  const ranked = body.keywords.filter((k) => k.measured && k.rank !== null);
  const best = ranked.reduce((a, b) => (a && a.rank <= b.rank ? a : b), null);
  return {
    measuredAt: body.measuredAt,
    country: body.country,
    platform: body.platform,
    keywords: body.keywords.length,
    ranked: ranked.length,
    absent: body.keywords.filter((k) => k.measured && k.rank === null).length,
    notMeasured: body.keywords.filter((k) => !k.measured).length,
    best: best && { term: best.term, rank: best.rank },
  };
}

{
  "measuredAt": "2026-09-27T02:10:00.000Z",
  "country": "us",
  "platform": "ios",
  "keywords": 8,
  "ranked": 6,
  "absent": 2,
  "notMeasured": 0,
  "best": {
    "term": "nature sounds",
    "rank": 29
  }
}

curl "https://storelift.net/v1/sandbox/apps/sbx-unknown/keywords?country=us"

{
  "error": "not_found",
  "message": "No such app in this workspace.",
  "docs": "https://storelift.net/docs/api/errors#not_found"
}

function rivalsAhead(body) {
  return body.rivals.map((r) => ({
    name: r.name,
    ratings: r.ratings,
    aheadOn: r.terms.length,
    absentOn: r.terms.filter((t) => t.ourRank === null).length,
  }));
}

[
  {
    "name": "Calm Rain",
    "ratings": 57046,
    "aheadOn": 8,
    "absentOn": 2
  },
  {
    "name": "Noisli",
    "ratings": 16114,
    "aheadOn": 8,
    "absentOn": 2
  },
  {
    "name": "Deep Sleep Tones",
    "ratings": 64683,
    "aheadOn": 8,
    "absentOn": 2
  }
]

curl "https://storelift.net/mcp" \
  -H "Authorization: Bearer $STORELIFT_TEST_KEY" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":9,"method":"tools/call","params":{"name":"get_rivals","arguments":{"appId":"sbx-unknown","country":"us"}}}'

ERROR: No such app in this workspace.

function allowance(body) {
  return {
    plan: body.plan,
    auth: body.auth,
    scopes: body.scopes,
    apps: body.apps.map((a) => a.id),
    creditsLeft: body.credits.limit - body.credits.used,
    ratePerSecond: body.ratePerSecond,
  };
}

{
  "plan": "studio",
  "auth": "test_key",
  "scopes": [
    "apps:read",
    "reviews:read",
    "ai:read",
    "revenue:read",
    "hive:read",
    "hive:spy",
    "hive:estimate",
    "ads:read"
  ],
  "apps": [
    "sbx-lumen",
    "sbx-quill"
  ],
  "creditsLeft": 50000,
  "ratePerSecond": 10
}

curl "https://storelift.net/mcp" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":9,"method":"tools/call","params":{"name":"whoami","arguments":{}}}'

{
  "jsonrpc": "2.0",
  "id": 9,
  "error": {
    "code": -32001,
    "message": "No credentials were sent. Sign in with OAuth on any plan, or add Authorization: Bearer <your Storelift API key>. Live keys require Pro, Studio, Enterprise, or an eligible Free account with purchased API credits or active Explorer. Tool access still depends on plan, scopes and credits. Generate a key at Storelift → Settings → API keys."
  }
}

Ortak parametreler

Bunlar, kabul eden her uçta aynı anlama gelir; her uç kabul ettiklerini kendi listesinde gösterir.