複数条件スクリーニング

財務指標・銘柄名・業種/セクターで上場銘柄をスクリーニングする。filters は field:op:value のカンマ区切り（最大 20 件、AND 結合。op は gte / lte / gt / lt / eq）。有効な指標キーは GET /screening/fields。しきい値と metrics[].value は GET /screening/fields の unit と同じスケール（金額は円。時価総額 1,000 億円は marketCap:gte）。金額指標のしきい値が 0 より大きく 100 万円未満の場合は、旧単位 (億円) の指定とみなして 400 を返す。

GET/screening

Authorization

AuthorizationBearer token · headerrequired

IRBANK Connect (app.irbank.net/mcp-api) で発行した API キー

Query parameters

namestring

銘柄名の部分一致

min length 1

filtersstring

指標フィルタ。field:op:value をカンマ区切りで最大 20 件（AND 結合）。op は gte / lte / gt / lt / eq。field は GET /screening/fields の type=numeric のキー（camelCase）

min length 1

sort_bystring

ソート対象の指標キー（GET /screening/fields の type=numeric のキー）

min length 1

sort_orderstring

ソート方向（既定 desc。sort_by 指定時のみ有効）

default: "desc"

Allowed:ascdesc

sectorstring

東証17業種名のカンマ区切り（in 絞り込み）

min length 1

industrystring

東証33業種名のカンマ区切り（in 絞り込み）

min length 1

as_ofstring

評価基準日（'now' または YYYY-MM-DD。未来日は不可。東証ライセンスにより 2005-01-01 以降のみ）

default: "now"

limitinteger

min 1 · max 100 · default: 30

cursorstring

前回レスポンスの next_cursor。cursor 以外の検索条件は前回リクエストと同一値を指定する

Responses

200OK

securitiesScreeningSecurity[]required

Show properties

Array of ScreeningSecurity

security_codestringrequired

証券コード (4 桁)。securities 系 API の入力キー

edinet_codestringrequired

namestringrequired

metricsScreeningSecurityMetric[]required

filters / sort_by で参照した指標の値

Show properties

Array of ScreeningSecurityMetric

fieldstringrequired

指標キー

valuenumberrequired

as_ofstringrequired

指標値の評価基準日 (YYYY-MM-DD)

total_countintegerrequired

条件に合致した銘柄の総数

next_cursorstring | nullrequired

次ページ取得用の不透明 cursor。null なら最終ページ

attributionAttributionrequired

Show properties

source_labelstringrequired

出典表示ラベル（第三者に表示する際はこの表記を使う）

license_notestringrequired

出典・再配信条件の注記

processed_bystringrequired

400パラメータまたは cursor が不正

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/screening" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.irbank.net/v1/screening", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.irbank.net/v1/screening",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "securities": [
    {
      "security_code": "7203",
      "edinet_code": "E02144",
      "name": "トヨタ自動車",
      "metrics": [
        {
          "field": "per",
          "value": 0,
          "as_of": "string"
        }
      ]
    }
  ],
  "total_count": 0,
  "next_cursor": "string",
  "attribution": {
    "source_label": "金融庁 EDINET / TDnet",
    "license_note": "string",
    "processed_by": "IRBANK"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Security not found",
    "details": [
      {
        "param": "years",
        "reason": "out_of_range",
        "expected": ">= 1"
      }
    ]
  }
}