順位追跡API・CLI・SDK

対象開発者データエンジニア

OpenAPI、CLI、TypeScript・Python・Go SDKで、コードから順位確認を実行し履歴を参照できます。

続いてSettings / DevelopersでAPIキーを作成

有料リクエストは自分のDataForSEOまたはSerpApiを使用 · 見積もりは無料 · セルフホスト (AGPL-3.0)

REST v1OpenAPI161操作

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}'
出力HTTP 201
{  "position": 4,  "previous_position": 7,  "ranking_url": "https://example.com/rank-tracker",  "cost_cents": 0.06}

リクエスト中にチェックが完了すると 201、キューに入ると実行 ID 付きの 202 を返します。

サンプルデータを使った呼び出し例。

REST API

公開OpenAPI仕様の順位追跡REST API

SDKとCLIの各REST操作は、公開OpenAPI 3.1文書で定義した通常のHTTPSリクエストです。

  • スコープ付きキーを1度だけ表示。 キーにスコープ、有効期限、月次消費を持たせ、保存するのはハッシュのみです。
  • 安全な再試行。 書き込み時に冪等性キーを送ると、24時間以内の再試行で元の応答を再現します。
API キー

bisibility API 用のキーです。それぞれにスコープと有効期限があります。

夜間レポート
bsb_key_live_7hq2******

作成:2026年9月20日 23:44 · 最終使用:2026年9月28日 02:17

今月の消費:$0.42

有効期限:2026年12月19日 23:44
CIの確認
bsb_key_live_k3m9******

作成:2026年9月22日 08:44 · 未使用

今月の消費:$0.00

無期限
クイックスタートキーを作成
  • 有料呼び出しごとに上限。 順位確認とドメイン概要は見積もりが上限を超える場合に拒否します。キーワードと被リンク調査は可能な範囲で上限に従います。 キーワード調査 被リンク分析
  • スクリプト専用の予算。 提供元ごとのAPI・エージェントの月次予算は厳格な上限です。アプリと予定された確認は引き続き動作します。

プロバイダー予算

プロバイダーごとに月次予算を設定します。プロバイダーの残高を使う場合は今月の使用額も含め、予算の残額と利用可能な残高を一致させます。

プロバイダー
アプリ・定期チェックアプリから開始したチェックと、自動の定期チェック。
API・エージェントAPI、MCP、SDK、CLIからのリクエスト。暴走したエージェントから保護するために設定します。
DataForSEOプライマリ
予算 / 月$20.00今月 $3.12 · 先月 $4.05プロバイダー残高を使用
予算 / 月$5.00今月 $0.42 · 先月 $0.31

予算に達すると、そのサーフェスのリクエストは翌月まで停止し、もう一方のサーフェスは継続します。

キャンセル保存

SDKとCLI

TypeScript・Python・Go SDKとCLI

3つの公式SDKで型付きリクエスト・レスポンスを利用できます。CLIはターミナルやCIから確認・調査・書き出しを実行します。

  • 言語ごとの待機ヘルパー。 各SDKで順位確認を開始し、結果を取得できます。キュー実行は導入環境によって異なります。
  • ブラウザからCLI認証。 ブラウザで1度ログインすれば、キーの貼り付けは不要です。
  • CIとスクリプト向け。 環境変数からキーを読み、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

Webhook

署名付きSEO webhookの送信とデプロイフックの受信

アラートルールはプロジェクトごとに最大10のHTTPSエンドポイントへ送信します。デプロイ情報はCIからbisibilityへ受信します。

  • 4種類のイベント。 発生したアラート、ダイジェスト、日次上限通知、テストイベント。
  • 少ないコードで検証。 各配信に署名とタイムスタンプがあり、利用前に検証できます。
  • デプロイフックを受信。 Vercel、Netlify、Amplifyや任意のCIをフックに接続し、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"  }}

セルフホスト

自分のサーバーでも同じAPI

アプリはAGPL-3.0、CLIとSDKはApache-2.0のオープンソースです。自分のインスタンスでも同じAPIを利用できます。

  • 1つの設定で切り替え。 Cloudと自分のサーバーは、SDKやCLIのベースURLで切り替えられます。
  • 履歴を移行。 プロジェクトパッケージを書き出せます。Cloudの取り込みでは、1プロジェクトに紐付くトークンでキーワードと順位履歴を復元します。
# 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

まだ対応していないこと

  • プロジェクトキーは毎分600、個人トークンは120リクエスト。セルフホストでは調整できます。
  • カーソルページングの一覧は既定50行、1ページ最大200行です。
  • アラートwebhookはルールから送信し、イベントごとのフィルターはありません。
  • デモは読み取り専用で、APIキーは作成できません。

APIキーから最初の順位確認へ

登録してAPIキーを作成し、curl・CLI・SDKから最初のリクエストを送れます。

無料のオープンソース(AGPL-3.0)。データはいつでもエクスポートでき、同じアプリをセルフホストすることもできます。