Referência da API

URL base

https://storelift.net/v1

Todos os caminhos abaixo são relativos a ela. Envie GET para leituras e POST só em /actions.

Autenticação

Envie a chave em Authorization: Bearer <key> ou em x-api-key. Crie as chaves em Configurações › API; cada chave tem escopos, uma lista opcional de IPs permitidos, uma lista opcional de apps e um orçamento mensal opcional de créditos. Uma chave que atinge o orçamento responde 402 key_budget_reached até a virada do mês; as outras chaves continuam funcionando.

As chaves de produção (sl_live_) da API REST estão no Pro e acima, ou em qualquer plano com um pacote de créditos. O Free inclui uma chave de produção que funciona só no servidor MCP. As chaves de teste (sl_test_) devolvem os dados do sandbox em todos os planos. Os assistentes fazem login por OAuth pelo servidor MCP em todos os planos.

Créditos e limites

Cada chamada custa os créditos indicados nela; /account e /usage custam 0, e a prévia de uma escrita custa 0. Toda resposta traz x-credits-used, x-credits-limit, x-credits-remaining e x-credits-reset.

As requisições por segundo são definidas por plano; acima disso você recebe 429 rate_limited com retry-after. Os endpoints do Hive abrem com créditos de API comprados ou com o Hive Explorer e também contam para uma cota diária: 500 chamadas com créditos de pacote, 10.000 com o Hive Explorer. Créditos por chamada

Sandbox

https://storelift.net/v1/sandbox responde a todas as leituras abaixo que têm resposta de exemplo, sem chave e sem créditos. Os dados são fixos e datados, então os testes ficam estáveis.

As chaves de teste (sl_test_) devolvem os mesmos dados na URL base de produção e nunca escrevem.

Como ler uma posição

Uma posição tem três estados, e eles ficam separados: measured: false significa que a consulta não foi medida naquele dia, rank: null significa que ela foi medida e o app está fora dos resultados lidos, e um número é a posição.

Erros

Todo erro tem o mesmo corpo: { "error": "<code>", "message": "…", "docs": "…" }. error é estável; faça a ramificação por ele, não por message. Alguns códigos acrescentam campos como scope, field ou limit. Todos os códigos de erro

Exemplos passo a passo

Três trabalhos, da primeira chamada ao resultado que você guarda. Todos os comandos rodam no sandbox, então não gastam créditos nem mudam nada, e cada resposta é a que o sandbox devolve para o comando.

Com a sua própria chave, os caminhos são os mesmos sem /sandbox e cada chamada custa os créditos indicados nela. Uma chave de teste (sl_test_) também responde ali com os dados do sandbox, por 0 créditos.

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."
  }
}

Parâmetros comuns

Eles funcionam do mesmo jeito em todos os endpoints que os aceitam; cada endpoint lista os que aceita.