複数条件スクリーニング
財務指標・銘柄名・業種/セクターで上場銘柄をスクリーニングする。filters は field:op:value[:unit] のカンマ区切り(AND 結合。op は gte / lte / gt / lt / eq)。指定できる条件数(filters の各条件 + sector の指定 + industry の指定)の上限は会員区分によって変わり、いずれの区分でも 20 件を超えられない。有効な指標キーと単位は GET /screening/fields。unit を書くとその単位でしきい値を解釈する(時価総額 1,000 億円は marketCap:gte:1000)。unit を省略した場合のしきい値と metrics[].value は GET /screening/fields の unit と同じスケール(金額は円。marketCap:gte)で、金額指標のしきい値が 0 より大きく 100 万円未満なら旧単位 (億円) の指定とみなして 400 を返す。
GET
/screeningAuthorization
AuthorizationBearer token · headerrequiredIRBANK Connect (app.irbank.net/mcp-api) で発行した API キー
Query parameters
namestring銘柄名の部分一致
min length 1
filtersstring指標フィルタ。field:op:value[:unit] をカンマ区切り(AND 結合)。指定できる条件数の上限は会員区分によって変わり、いずれの区分でも 20 件を超えられない。この上限は filters の各条件だけでなく、sector を指定した場合・industry を指定した場合もそれぞれ 1 件として数える。op は gte / lte / gt / lt / eq。field は GET /screening/fields の type=numeric のキー(camelCase)。unit はしきい値の単位(例 marketCap:gte:1000:hundred_million_jpy / equityRatio:gte:70:percent)で、省略時は field 自身の単位(GET /screening/fields の unit。金額は円)とみなす
min length 1
sort_bystringソート対象の指標キー(GET /screening/fields の type=numeric のキー)
min length 1
sort_orderstringソート方向(既定 desc。sort_by 指定時のみ有効)
default: "desc"
Allowed:
ascdescsectorstring東証17業種名のカンマ区切り(in 絞り込み)。指定すると filters の条件数上限に 1 件として数えられる
min length 1
industrystring東証33業種名のカンマ区切り(in 絞り込み)。指定すると filters の条件数上限に 1 件として数えられる
min length 1
as_ofstring評価基準日('now' または YYYY-MM-DD。未来日は不可。東証ライセンスにより 2005-01-01 以降のみ)
default: "now"
limitintegermin 1 · max 100 · default: 30
cursorstring前回レスポンスの next_cursor。cursor 以外の検索条件は前回リクエストと同一値を指定する
Responses
200OK
securitiesScreeningSecurity[]requiredShow propertiesHide properties
Array of
ScreeningSecuritysecurity_codestringrequired証券コード (4 桁)。securities 系 API の入力キー
edinet_codestringrequirednamestringrequiredmetricsScreeningSecurityMetric[]requiredfilters / sort_by で参照した指標の値
Show propertiesHide properties
Array of
ScreeningSecurityMetricfieldstringrequired指標キー
valuenumberrequiredas_ofstringrequired指標値の評価基準日 (YYYY-MM-DD)
total_countintegerrequired条件に合致した銘柄の総数
next_cursorstring | nullrequired次ページ取得用の不透明 cursor。null なら最終ページ
attributionAttributionrequiredShow propertiesHide properties
source_labelstringrequired出典表示ラベル(第三者に表示する際はこの表記を使う)
license_notestringrequired出典・再配信条件の注記
processed_bystringrequired400パラメータまたは cursor が不正
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringrequireddetailsExternalErrorDetail[]Show propertiesHide properties
Array of
ExternalErrorDetailparamstringrequiredreasonstringrequiredAllowed:
missingconflictinvalid_typeinvalid_formatout_of_rangeunknown_valuetoo_many_itemsinvalidexpectedstring受理される値の要約(範囲・型・列挙値)。示せない場合は省略する
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"
}
]
}
}