📖 BrowserIP ドキュメント
🌐 日本語

API リファレンス

Base URL:https://browserip.com。認証:まず POST /api/auth/login でログインすると、サーバーから sid cookie が発行され、以降のリクエストは cookie 付きで送信します。コンソールの「API Keys」ページで生成した Key も利用できます。リクエストヘッダー Authorization: Bearer <redacted>… で、cookie は不要です(Key は一度だけ表示されます。大切に保管してください)。

起動 POST /api/sessions/

curl -b cookies.txt -X POST https://browserip.com/api/sessions/ \
  -H 'Content-Type: application/json' -d '{}'

成功(空きスロットあり)→ 200:

{
  "session": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "ready",
    "region": "default",
    "token": "…",
    "cdp_url": "https://browserip.com/s/123e4567-e89b-12d3-a456-426614174000/…",
    "view_url": "/view/123e4567-e89b-12d3-a456-426614174000/…",
    "created_at": "2026-10-19T00:00:00.000Z",
    "last_activity": "2026-10-19T00:00:00.000Z"
  }
}

空きスロットがなく、スケールアウトがトリガーされた場合 → 202 {"session": {...}, "queue_position": 1}(GET /api/sessions/:id をポーリングし、status が ready になるのを待ちます)。エラー:402 insufficient_credits(残高不足)、429 too_many_sessions、503 no_capacity。

セッション確認 GET /api/sessions/:id

{"session": {"id": "123e4567-e89b-12d3-a456-426614174000", "status": "ready", "cdp_url": "https://browserip.com/s/123e4567-e89b-12d3-a456-426614174000/…", …}}

停止 DELETE /api/sessions/:id

curl -b cookies.txt -X DELETE https://browserip.com/api/sessions/123e4567-e89b-12d3-a456-426614174000
→ {"ok": true}

ユーザー情報の確認 GET /api/auth/me

{"user": {"id": "u_x", "email": "you@example.com", "hours": 4.5, "credits": 0, "account_type": "personal", "credit_rate_per_hour": null, "is_admin": false, "created_at": "…"}} 

残高の確認 GET /api/billing/balance

現在の残高を返します。個人ユーザーは hours(時間)、企業/管理者は credits で、account_type と企業レート credit_rate_per_hour も併せて返されます。