gxceed

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"
limit1〜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"
typeintegrated | sustainability | environmental | csr
yearpublication_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_topublication_year の範囲指定
include_raw1 で 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業種フィルタ
yearpublication_year
sbt_status1.5C | WB2C | committed | none

エラーレスポンス

400invalid_id / invalid_body / missing_field:* / invalid_email
401missing_bearer / invalid_api_key / key_expired
403key_not_approved
404not_found
409duplicate_pending_application（同 email 30日以内）
500internal_error

レート制限

プランごとの上限を超えると 429 Too Many Requests を返します。 Trial: 100 req/日 / Researcher: 10,000 req/月 / Paid: 個別契約。