API ドキュメント

1. 認証

料金プランから購入すると、vivl_live_で始まるAPIキーが発行されます。Authorization: Bearerヘッダーで送ってください(x-api-key ヘッダーも可)。

curl -H "Authorization: Bearer vivl_live_..." \
  "https://<ドメイン>/v1/large-holdings?date=2026-10-01"

2. エンドポイント

# 今日の大量保有報告書
curl -H "Authorization: Bearer $VIVL_KEY" "https://<ドメイン>/v1/large-holdings"

# 特定銘柄に関するTOB書類(対象会社として)
curl -H "Authorization: Bearer $VIVL_KEY" "https://<ドメイン>/v1/tender-offers?date=2026-10-01&code=7203"

# 2025年3月期の有報から売上高・営業利益・平均年収だけ
curl -H "Authorization: Bearer $VIVL_KEY" \
  "https://<ドメイン>/v1/financials/7203?year=2025&metrics=sales,op,avgSalary"

# 法人名・法人番号・証券コードを検索(検索語2文字以上、最大100件)
curl -H "Authorization: Bearer $VIVL_KEY" \
  "https://<ドメイン>/v1/entities?q=7203&limit=20"

# 検索結果の entity_id を使って詳細を取得
curl -H "Authorization: Bearer $VIVL_KEY" \
  "https://<ドメイン>/v1/entities/jcn%3A1234567890123"

法人APIは、データ元の最新の利用条件で再配布が認められた行だけを返します。個人に関する行と、利用条件が不明または再配布不可の情報は除外します。 検索結果の sources に出典・必要な帰属表記・利用条件のURLが含まれます。法人データ用のCloudflare D1読み取り専用トークンが未設定の場合、503 not_configured になります。

3. レスポンス形式

成功時は data と meta、失敗時は error です。

{
  "data": [
    {
      "doc_id": "S100ABCD",
      "submitted_at": "2026-10-01T15:00:00+09:00",
      "doc_type": { "code": "350", "name": "大量保有報告書" },
      "category": "largeHolding",
      "report_kind": "change",
      "title": "変更報告書",
      "filer":  { "name": "〇〇アセットマネジメント株式会社", "edinet_code": "E00000", "stock_code": null, "corporate_number": "..." },
      "issuer": { "edinet_code": "E02144", "stock_code": "7203", "name": "トヨタ自動車株式会社" },
      "url": "https://disclosure2.edinet-fsa.go.jp/WZEK0040.aspx?S100ABCD"
    }
  ],
  "meta": { "source": "EDINET", "date": "2026-10-01", "count": 1, "finalized": true, "fetched_at": "2026-10-02T09:00:00.000Z" }
}

{ "error": { "code": "rate_limited", "message": "レート制限に達しました(Proプラン: 60リクエスト/分)。", "limit_per_minute": 60 } }

エラーコード — 分岐は message ではなく code で行ってください

4. レート制限

• Pro: 60回/分・月 10,000 回まで
• Ultra: 300回/分・月 100,000 回まで
• Mega: 600回/分・月 1,000,000 回まで

分間の上限を超えると 429 rate_limited、月間の上限を超えると 429 plan_limit が返ります(どちらも Retry-After ヘッダー付き)。 月間の上限は毎月1日0時(日本時間)にリセットされます。REST と MCP の呼び出しは合算されます。 成功したレスポンスには残り回数がヘッダーで付きます。

x-ratelimit-limit: 60                         # 1分あたりの上限
x-quota-limit: 10000                          # 今月の上限
x-quota-remaining: 9873                       # 今月の残り
x-quota-reset: 2026-10-31T15:00:00.000Z       # 次のリセット(= 11/1 0:00 JST)

5. MCPサーバー(Claude などのAIから使う)

同じAPIキーで、MCP(Model Context Protocol)サーバーも使えます。AIアシスタントに「今日の大量保有報告書をまとめて」と頼むと、 このAPIを直接呼んで一次情報から答えます。追加料金はかかりません。

# Claude Code
claude mcp add --transport http vivldatabase https://<ドメイン>/mcp \
  --header "Authorization: Bearer vivl_live_..."

# 設定ファイルに書く場合(Claude Desktop 等)
{
  "mcpServers": {
    "vivldatabase": {
      "type": "http",
      "url": "https://<ドメイン>/mcp",
      "headers": { "Authorization": "Bearer vivl_live_..." }
    }
  }
}

6. バージョニング

URLの /v1/ がAPIのバージョンです。v1 の中では、項目の追加は予告なく行うことがありますが、 既存の項目の削除・名前変更・型変更は行いません。互換性のない変更は /v2/ として別に提供します。