コンテンツにスキップ
IRBANK API はベータ提供中です。仕様は予告なく変更される場合があります。
IRBANK API ドキュメント
Esc
navigateopen⌘Jpreview

指標別ランキング

指定した指標の市場横断ランキング(順位・証券コード・銘柄名・指標値)を最新営業日基準で返す。該当データが 0 件のときは空配列とともに reason (code=no_results + 状況の説明) を返す。

GET/rankings/{metric}
Authorization
AuthorizationBearer token · headerrequired
IRBANK Connect (app.irbank.net/mcp-api) で発行した API キー
Path parameters
metricstringrequired
ランキング指標種別。gainers (値上がり率) / losers (値下がり率) / volume (出来高) / stop-high (ストップ高) / stop-low (ストップ安)
Allowed:gainerslosersvolumestop-highstop-low
Query parameters
limitinteger
取得件数 (1〜200)
min 1 · max 200 · default: 100
Responses
200OK
metricstringrequired
Allowed:gainerslosersvolumestop-highstop-low
target_datestringrequired
集計対象の営業日(YYYY-MM-DD)。価格データ皆無時は空文字
itemsRankingItem[]required
Show properties
Array of RankingItem
rankintegerrequired
順位(1 始まり)
security_codestringrequired
証券コード (4 桁)。securities 系 API の入力キー
namestringrequired
industry_namestringrequired
東証33業種名
close_pricenumber | nullrequired
当日終値(円)。データ欠損時は null
change_percentnumber | nullrequired
前日比騰落率(%)。前日終値が無い場合は null
volumeinteger | nullrequired
当日出来高(株)。データ欠損時は null
reasonEmptyReason | anyrequired
本体データが空のとき、その理由 (機械可読な code + 説明・対処ヒント)。本体データが 1 件以上のときは null
Show properties
One of:
EmptyReason
codestringrequired
no_results: このリクエストに該当するデータが 0 件。収録が無い場合と、指定した条件に合致しない場合の両方を含む (両者は現状の実装では区別できないため、機械可読な値としては区別しない)。TDnet 由来の値は開示から 24 時間は収録に反映されないため、直近開示分は後から追加され得る
Allowed:no_results
messagestringrequired
0 件になった状況の説明 (英語)。人間向けの補足であり、分岐は code で行うこと (文面は予告なく改善されうる)
any
any
attributionAttributionrequired
Show properties
source_labelstringrequired
出典表示ラベル(第三者に表示する際はこの表記を使う)
license_notestringrequired
出典・再配信条件の注記
processed_bystringrequired
400パラメータが不正
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
detailsExternalErrorDetail[]
Show properties
Array of ExternalErrorDetail
paramstringrequired
reasonstringrequired
Allowed:missingconflictinvalid_typeinvalid_formatout_of_rangeunknown_valuetoo_many_itemsinvalid
expectedstring
受理される値の要約(範囲・型・列挙値)。示せない場合は省略する
404metric が存在しない
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
detailsExternalErrorDetail[]
Show properties
Array of ExternalErrorDetail
paramstringrequired
reasonstringrequired
Allowed:missingconflictinvalid_typeinvalid_formatout_of_rangeunknown_valuetoo_many_itemsinvalid
expectedstring
受理される値の要約(範囲・型・列挙値)。示せない場合は省略する
503価格データが一時的に取得できず基準日を解決できない (code=data_unavailable)。時間をおいて再試行する
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
detailsExternalErrorDetail[]
Show properties
Array of ExternalErrorDetail
paramstringrequired
reasonstringrequired
Allowed:missingconflictinvalid_typeinvalid_formatout_of_rangeunknown_valuetoo_many_itemsinvalid
expectedstring
受理される値の要約(範囲・型・列挙値)。示せない場合は省略する
Request
curl -X GET "https://api.irbank.net/v1/rankings/gainers" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "metric": "gainers",
  "target_date": "2026-05-19",
  "items": [
    {
      "rank": 0,
      "security_code": "7203",
      "name": "トヨタ自動車",
      "industry_name": "輸送用機器",
      "close_price": 0,
      "change_percent": 0,
      "volume": 0
    }
  ],
  "reason": {
    "code": "no_results",
    "message": "No segment disclosure is currently recorded for this organization."
  },
  "attribution": {
    "source_label": "金融庁 EDINET / TDnet",
    "license_note": "string",
    "processed_by": "IRBANK"
  }
}