Referencia de la API

URL base

https://storelift.net/v1

Todas las rutas de esta página son relativas a ella. Envíe GET para las lecturas y POST solo en /actions.

Autenticación

Envíe la clave en Authorization: Bearer <key> o en x-api-key. Las claves se crean en Ajustes › API; cada clave lleva sus scopes y, de forma opcional, una lista de IP permitidas, una lista de apps y un presupuesto mensual de créditos. Una clave que alcanza su presupuesto responde 402 key_budget_reached hasta que cambia el mes; las demás claves siguen funcionando.

Las claves de producción (sl_live_) para la API REST están disponibles en Pro y en los planes superiores, o en cualquier plan con un pack de créditos. Free incluye una clave de producción que solo funciona en el servidor MCP. Las claves de prueba (sl_test_) devuelven los datos del sandbox en todos los planes. Los asistentes inician sesión con OAuth a través del servidor MCP en todos los planes.

Créditos y límites

Cada llamada cuesta los créditos que se indican en ella; /account y /usage cuestan 0, y la vista previa de una escritura cuesta 0. Todas las respuestas llevan x-credits-used, x-credits-limit, x-credits-remaining y x-credits-reset.

Las peticiones por segundo se fijan por plan; si las supera, recibe 429 rate_limited con retry-after. Los endpoints de Hive se abren con créditos de API comprados o con Hive Explorer y cuentan además para una cuota diaria: 500 llamadas con créditos de un pack y 10.000 con Hive Explorer. Créditos por llamada

Sandbox

https://storelift.net/v1/sandbox responde a todas las lecturas de esta página que tienen una respuesta de ejemplo, sin clave y sin créditos. Los datos son fijos y llevan fecha, así que las pruebas se mantienen estables.

Las claves de prueba (sl_test_) devuelven los mismos datos en la URL base de producción y nunca escriben.

Cómo leer una posición

Una posición tiene tres estados y no se mezclan: measured: false significa que la consulta no se midió ese día, rank: null significa que se midió y la app queda fuera de los resultados leídos, y un número es la posición.

Errores

Todos los errores tienen el mismo cuerpo: { "error": "<code>", "message": "…", "docs": "…" }. error es estable; base en él la lógica de su código, no en message. Algunos códigos añaden campos como scope, field o limit. Todos los códigos de error

Ejemplos paso a paso

Tres tareas, desde la primera llamada hasta el resultado que usted guarda. Todos los comandos se ejecutan contra el sandbox, así que no gastan créditos ni cambian nada, y cada respuesta es la que el sandbox devuelve para ese comando.

Con su propia clave, las rutas son las mismas sin /sandbox y cada llamada cuesta los créditos que se indican en ella. Una clave de prueba (sl_test_) responde también ahí con los datos del 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 comunes

Se interpretan igual en todos los endpoints que los admiten; cada endpoint indica cuáles admite.