ドキュメント

クイックスタート

APIキーはアカウント (購入完了メールのリンクから入ります) で作成できます｡ヘッダ X-API-Key に値を入れて呼び出してください｡

証券コードからIRページURLを1件取得する例 (1クレジット):

curl "https://api.irkumo.com/v1/companies/7203?fields=ir_url" \
  -H "X-API-Key: ir_live_xxxxxxxxxxxxxxxxxxxxxxxx"

社名から検索する例 (件数によらず1クレジット｡0件は0):

curl -G "https://api.irkumo.com/v1/search" \
  --data-urlencode "q=トヨタ" \
  -H "X-API-Key: ir_live_xxxxxxxxxxxxxxxxxxxxxxxx"

実際に課金せず見積りだけ確認する例 (dry_run=1｡課金0):

curl "https://api.irkumo.com/v1/companies?industry=銀行業&limit=10&fields=ir_url,tanshin_url&dry_run=1" \
  -H "X-API-Key: ir_live_xxxxxxxxxxxxxxxxxxxxxxxx"

残高不足 (402)

代金が残高を超える場合はHTTP 402が返り残高は変わりません｡本文は {"error": "insufficient_credits", "required": 必要数, "available": 残高} の形です｡応答ヘッダの X-Credits-Remaining で毎回の残高も確認できます｡

Idempotency-Key

ヘッダ Idempotency-Key (最大64文字) を付けると､同じ鍵で24時間以内に同じキーを再送したとき前回の応答をそのまま返し (24時間キャッシュ)､クレジットを二重に消費しません｡通信が不安定な環境からの再試行に使ってください｡

レート制限

課金とは別に基盤保護のためのレート制限があります｡APIキーごと20リクエスト/10秒 (無認証の /v1/meta と /v1/fields はIPごと10リクエスト/10秒)｡超えるとHTTP 429とRetry-Afterヘッダが返ります｡応答ヘッダの X-RateLimit-Limit / X-RateLimit-Remaining で残数を確認できます｡基盤保護のため､状況により鍵単位に加えてアカウント単位や全体で追加の制限を掛けることがあります (大量の鍵に分散して制限を回避する使い方は利用規約で禁止しています)｡

クレジットの数え方

応答に含めた行 x 列が1クレジット (例: 10社 x 3列 = 30クレジット)
fields= を省略すると code,name の2列 (既定)
/v1/search は結果件数によらず1回1クレジット (0件は0)｡fields= は属性列のみ指定可 (ir_url等の指定は422)
/v1/changes は1行1クレジット (列数によらない)
4xx/5xxと0件は課金しない
毎月1日に30クレジットを無料付与 (その月末まで有効)｡初回購入 (初回限定パック) のときも同時に30クレジットを付与します (購入した月の末まで有効)｡購入した月の翌月以降は毎月1日の付与から

API リファレンス

全エンドポイントの詳細な仕様は API リファレンス (OpenAPI定義の表示) を参照してください｡