API リファレンス

Base URL: https://api.gxceed.com

認証

すべての /api/v1/* エンドポイントは Bearer 認証が必要です。発行された API キーをリクエストヘッダーに付与してください:

Authorization: Bearer gxceed_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API キーは登録時に1度だけ表示されます。失念した場合は再発行が必要です（運営者まで連絡）。

GET /api/v1/companies

東証プライム企業のマスタ。証券コード昇順、最大 500 件 / リクエスト。

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.gxceed.com/api/v1/companies?industry=Chemicals&limit=20"

limit	1〜500（既定 500）
offset	ページング用オフセット
industry	業種コード or 業種名でフィルタ

GET /api/v1/companies/:code

1社の概要 + レポート種別ごとのカバレッジ。

curl -H "Authorization: Bearer $TOKEN" \
  https://api.gxceed.com/api/v1/companies/7203

GET /api/v1/companies/:code/reports

1社の収集済みレポート（最大4種別 × 複数年度）。

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.gxceed.com/api/v1/companies/7203/reports?type=integrated&year=2024"

type	integrated \| sustainability \| environmental \| csr
year	publication_year で絞り込み

GET /api/v1/companies/:code/gx-metrics

1社の脱炭素数値（時系列）。Scope 1/2/3、SBT、TCFD、CDP、再エネ比率等。

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.gxceed.com/api/v1/companies/7203/gx-metrics?year_from=2022&year_to=2024"

year_from / year_to	publication_year の範囲指定
include_raw	1 で raw_extraction（Sonnet/Opus 全文 JSON）を含める（重い）

GET /api/v1/reports/:report_id

レポート1件の詳細（メタデータ + 抽出済み数値）。

curl -H "Authorization: Bearer $TOKEN" \
  https://api.gxceed.com/api/v1/reports/123

GET /api/v1/gx-metrics

業種・年度・SBT認定状況等で横断検索。最大 1,000 件 / リクエスト。

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.gxceed.com/api/v1/gx-metrics?industry=Chemicals&year=2024&sbt_status=1.5C"

industry	業種フィルタ
year	publication_year
sbt_status	1.5C \| WB2C \| committed \| none

GET /api/v1/papers/search

gxceed コーパス（査読論文・preprint・政策資料）に対する 意味検索。自然文クエリを Workers AI @cf/baai/bge-m3（1024次元・多言語）で embed し、Vectorize インデックスで近傍検索した結果を返します。

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.gxceed.com/api/v1/papers/search?q=power%20electronics%20grid%20integration&mode=vector&limit=20"

q	クエリ文字列。2〜1000 文字。日本語・英語・混在可
mode	vector（既定）または keyword。vector はベクトル類似、keyword は AND-of-LIKE
topic	primary_topic でメタフィルタ（hydrogen / ccus / climate_finance / energy_transition / renewable / carbon_pricing 他）
limit	1〜50（既定 20）
min_score	draft_score の下限（既定 0。公開済み＝品質ゲート通過済み。上げると上位のみに絞れる）
lang	ja \| en \| all（既定 all）
shelf	curated \| japan_to_global \| global_to_japan \| all（既定 all）

返却フィールド: id, doi, title, title_ja, title_en, authors, abstract, ai_summary_ja, ai_summary_en, primary_topic, tags, venue, publication_date, lang, source_url, pdf_url, shelf, is_peer_reviewed, draft_score, vector_score（vector_score は keyword モードでは null）。

エラーレスポンス

400	invalid_id / invalid_body / missing_field:* / invalid_email / missing_query / invalid_mode / invalid_lang / invalid_shelf
401	missing_bearer / invalid_api_key / key_expired
403	key_not_approved
404	not_found
409	duplicate_pending_application（同 email 30日以内）
429	rate_limit_exceeded（X-RateLimit-* / Retry-After ヘッダー付）
502	embedding_failed（Workers AI 一時障害）
503	vector_unavailable（VECTORIZE/AI binding 未設定）
500	internal_error

レート制限

プランごとの上限を超えると 429 Too Many Requests を返します。

Trial	100 req/日（UTC リセット）
Demo	200 req/日（公開デモ用、daily_limit は個別調整）
Researcher	10,000 req/月（無料・申請承認制）
Paid	個別契約（daily/monthly どちらか or 両方）
Internal	無制限（社内ツール用、運営者が直接発行）

残量は X-RateLimit-Limit / X-RateLimit-Remaining / 月次は X-RateLimit-Limit-Month / X-RateLimit-Remaining-Monthヘッダーで返ります。429 時は Retry-After（秒）に従ってください。

Provenance / 帰属

全レスポンスに以下のヘッダーを付与しています。学術引用時は X-Dataset-Version とX-SNE-Framework-DOI をお使いください。

X-Dataset-Version	コーパスのリリース版（例: pre-release / 2026Q2）
X-SNE-Framework-DOI	https://doi.org/10.5281/zenodo.19889465 — gxceed 評価フレームワークの Zenodo DOI
X-Disclaimer	AI-assisted extraction; verify against source PDF — 本文抽出は AI 補助のため、引用前に原典 PDF で要確認