API de posiciones, CLI y SDK

ParaDesarrolladoresIngenieros de datos

Una API de posiciones con OpenAPI, CLI y SDK para TypeScript, Python y Go. Comprueba posiciones y lee el historial desde código.

Después crea una clave API en Settings / Developers

Las llamadas de pago usan tu cuenta de DataForSEO o SerpApi · Estimaciones gratuitas · Alojamiento propio (AGPL-3.0)

REST v1OpenAPI161 operaciones

POST /api/v1/keywords/{id}/checks

export BISIBILITY_BASE_URL=https://eu.bisibility.com/api/v1curl -sS -X POST \  "$BISIBILITY_BASE_URL/keywords/kw_a00000000000000000000000/checks" \  -H "Authorization: Bearer $BISIBILITY_API_KEY" \  -H "Idempotency-Key: run-check-001" \  -H "Content-Type: application/json" \  -d '{"max_cost_cents": 1}' \  | jq '{position, previous_position, ranking_url, cost_cents}'
SalidaHTTP 201
{  "position": 4,  "previous_position": 7,  "ranking_url": "https://example.com/rank-tracker",  "cost_cents": 0.06}

201 si la comprobación termina durante la solicitud; 202 con un ID de ejecución si queda en cola.

Llamada de ejemplo con datos de muestra.

API REST

API REST de posiciones con OpenAPI público

Cada operación REST de los SDK y CLI es una llamada HTTPS normal descrita en un documento público OpenAPI 3.1.

  • Claves con ámbito, mostradas una vez. Cada clave tiene ámbito, caducidad y gasto mensual; solo se guarda su hash.
  • Reintentos seguros. Envía una clave de idempotencia con cada escritura; repetir en 24 horas reproduce la respuesta original.
Claves de API

Claves para la API de bisibility, cada una con un ámbito y una fecha de caducidad.

Informe nocturno
bsb_key_live_7hq2******

creada el 20 sep 2026, 23:44 · último uso 28 sep 2026, 02:17

Gasto del mes: $0.42

caduca el 19 dic 2026, 23:44
Comprobaciones CI
bsb_key_live_k3m9******

creada el 22 sep 2026, 08:44 · nunca se ha usado

Gasto del mes: $0.00

no caduca nunca
Guía de inicio rápidoCrear clave
  • Limita cada llamada de pago. Posiciones y dominios estimados por encima del límite se rechazan; palabras y backlinks lo aplican en la medida de lo posible. investigación de palabras clave análisis de backlinks
  • Da a los scripts su propio presupuesto. El presupuesto mensual de API y agentes por proveedor es un límite estricto; la aplicación y las comprobaciones programadas siguen funcionando.

Presupuestos por proveedor

Establece un presupuesto mensual para cada proveedor. Al usar el saldo del proveedor, se incluye el gasto de este mes para que el presupuesto restante coincida con el saldo disponible.

Proveedor
App y tareas programadasComprobaciones que inicias en la aplicación y comprobaciones automáticas programadas.
API y agentesPeticiones desde la API, MCP, SDK y CLI. Defínelo para protegerte de agentes descontrolados.
DataForSEOPrincipal
Presupuesto / mes$20.003,12 US$ este mes · 4,05 US$ el mes pasadoUsar el saldo del proveedor
Presupuesto / mes$5.000,42 US$ este mes · 0,31 US$ el mes pasado

Cuando se alcanza un presupuesto, las solicitudes de esa superficie se detienen hasta el mes siguiente; la otra superficie sigue funcionando.

CancelarGuardar

SDK y CLI

SDK de TypeScript, Python y Go y una CLI

Tres SDK oficiales ofrecen solicitudes y respuestas tipadas. La CLI ejecuta comprobaciones, investigación y exportaciones desde terminal o CI.

  • Un asistente de espera por lenguaje. Cada SDK inicia una comprobación y lee resultados. La ejecución en cola depende del despliegue.
  • Acceso a la CLI desde el navegador. Inicia sesión una vez en el navegador, sin pegar una clave.
  • Para CI y scripts. Lee la clave del entorno y recibe JSON.
npm install @bisibility/sdkimport { BisibilityClient } from "@bisibility/sdk";const bisibility = new BisibilityClient({  apiKey: process.env.BISIBILITY_API_KEY,  baseUrl: "https://eu.bisibility.com/api/v1",});const check = await bisibility.rankChecks.runAndWait("kw_a00000000000000000000000");console.log(check.position, check.previous_position, check.ranking_url, check.cost_cents);Runtime      Node 18+Wait helper  rankChecks.runAndWait

Webhooks

Webhooks SEO firmados de salida y hooks de despliegue de entrada

Las reglas envían a hasta 10 endpoints HTTPS por proyecto. Los despliegues van en sentido contrario, desde tu CI a bisibility.

  • Cuatro tipos de eventos. Alertas activadas, resúmenes, aviso de límite diario y evento de prueba.
  • Verifica en pocas líneas. Cada entrega incluye firma y marca temporal para verificar antes de confiar en ella.
  • Recibe hooks de despliegue. Dirige Vercel, Netlify, Amplify o cualquier CI al hook y consulta cada despliegue mediante la API.
POST https://example.com/hooks/bisibilityX-Bisibility-Timestamp: 1784980803X-Bisibility-Signature: sha256=4f1c…e9a2{  "event": "alert.fired",  "schemaVersion": 3,  "created_at": "2026-07-25T12:00:03.000Z",  "data": {    "headline": "Rank tracker dropped from #4 to #11",    "keyword": "rank tracker",    "before_position": 4,    "after_position": 11,    "condition_type": "position_drop",    "rule_name": "Important position drops",    "project_domain": "example.com",    "keyword_id": "kw_a00000000000000000000000"  }}

Alojamiento propio

La misma API en tu servidor

La aplicación es de código abierto bajo AGPL-3.0 y CLI y SDK bajo Apache-2.0. Tu instancia sirve la misma API en su origen.

  • Cambia con un ajuste. Cambiar entre Cloud y tu servidor requiere cambiar la URL base en el SDK o CLI.
  • Trae tu historial. Exporta un paquete; la importación Cloud restaura palabras e historial con un token vinculado a un proyecto.
# Cloud (EU region)bisibility config set baseUrl https://eu.bisibility.com/api/v1# Your serverbisibility config set baseUrl https://rank.example.com/api/v1bisibility config set cloudUrl https://rank.example.combisibility auth loginbisibility export --format json --output dump.json

Lo que aún no hace

  • Las claves de proyecto permiten 600 solicitudes por minuto y los tokens personales 120, ajustable en alojamiento propio.
  • Las listas con cursor devuelven 50 filas por defecto y hasta 200 por página.
  • Los webhooks salen de reglas de alerta, sin filtros por evento.
  • La demo es de solo lectura y no crea claves API.

De una clave API a tu primera comprobación

Regístrate, crea una clave API y haz tu primera llamada con curl, CLI o SDK.

Gratis y de código abierto (AGPL-3.0). Exporta tus datos cuando quieras o aloja la misma aplicación.