Guides / Conventions
データ規約
数値の読み違いを防ぐためのルールです。単位や基準はレスポンスのフィールドに含まれているため、数値だけを取り出して使う前に、以下のフィールドを確認してください。
単位
| 値 | 単位 | 確認するフィールド |
|---|---|---|
| 価格(現在値・終値・公募価格など) | 韓国株はウォン、米国株はドル | market |
| 財務諸表の金額(PRO API) | 韓国株は億ウォン、米国株は百万ドル | unit(行ごと) · meta.unit_note |
| 時価総額(PRO API) | 韓国株は億ウォン、米国株は百万ドル | market_cap_unit: KRW_EOK(億ウォン) · USD_MIL(百万ドル) |
| 比率(PRO API: 成長率・マージン・ROE・配当利回り・騰落率) | % の値(1.25 = 1.25%) | change_percent · *_pct · meta.unit_note |
| 騰落率(Data API) | 小数の比率(0.0101 = +1.01%) | change_rate |
騰落率の表記は API によって異なります
Data API の
change_rate は小数の比率で、PRO API の change_percent は % の値です。画面に表示する際は、100 を掛ける必要があるかを確認してください。通貨
- 韓国株はウォン(KRW)、米国株はドル(USD)で返します。相互の換算は行いません。
- 配当など通貨が混在しうる値には、
currencyフィールドを併せて返します。 - PRO API の業績差異表(
/earnings/{symbol}/variance)では、通貨や基準が異なる場合は差異(%)を計算せず、reasonsに理由を記載します。
会計期間と暦の期間
- 財務の値は各社の会計期間に従います。韓国の上場企業の多くは12月決算ですが、米国企業は会計年度が暦年と異なる場合があります(例: 9月に終わる会計年度)。
fiscal_yearとperiodを併せて確認してください。 - PRO API の期間パラメータは、
FY2027Q2、2026 3분기(第3四半期の韓国語表記)、2026(通期)のように指定します。 - 韓国株の第2〜第4四半期の値は、累計の報告書から直前の累計値を差し引いて算出する場合があります。その場合は、差し引いた報告書を
derived_fromに記載します。暫定業績の開示に基づく値はpreliminary: trueです。 - 連結・単体は
fsで区別します。韓国株の EPS・PER・ROE は親会社株主に帰属する当期純利益を基準とし、eps_basis(controlling·total)で示します。
日付と時刻
- 時刻(
as_of、published_atなど)は ISO 8601 形式の UTC 文字列です(末尾がZ)。韓国時間にするには9時間を足します。 - 日付のみの値(
YYYY-MM-DD)は、タイムゾーン変換をせずにそのまま読んでください。韓国のデータは韓国の日付、米国の開示・決算スケジュールは米国現地の日付です。日付文字列を0時の時刻に変換してからタイムゾーンを適用すると、1日ずれることがあります。 - 1日のクォータと使用量の日付(
X-Quota-Period、usage.day)は韓国時間基準です。 - PRO API の株価は、
sessionとregular.label(通常取引の現在値 · 通常取引の終値)で、どのセッションの値かを示します。プレマーケット・アフターマーケット・デイマーケットの約定価格はextendedに別途格納します。
出典と基準時点
PRO API のデータレスポンスは、すべて同じ構造です。
json
{
"data": { "...": "エンドポイントごとの値" },
"as_of": "2026-10-21T06:35:10.000Z",
"sources": [
{ "name": "DART", "url": "https://dart.fss.or.kr/dsaf001/main.do?rcpNo=20261021000123" }
],
"disclaimer": "…",
"meta": { "unit_note": "국내 억원 · 미국 백만달러" }
}as_of: 値の基準時点です。レスポンスを生成した時刻とは異なる場合があります(例: 株価の基準日)。sources: 原文へのリンクの一覧です。DART・SEC の原文と Phoenix AI のページへのリンクのみを含みます。- 財務の行には、
report(報告書名)、rcept_date(受付日)、source_url(原文リンク)が付きます。 - AI 開示要約は、
sourceで保存済みのもの(cache)か、今回のリクエストで生成したもの(generated)かを示します。 - Data API の開示レスポンスには受付番号と原文リンクが、ニュースには媒体名(
publisher)と原文を開くリンクが含まれます。
データ範囲(市場)
- 契約に応じて韓国(
KR)・米国(US)のデータを選んでご提供します。両方の契約も可能です。日本(JP)・中国(CN)のデータは準備中です。 - 契約中の市場は
GET /keyのmarkets(契約可能な市場markets_available、準備中markets_coming_soon)、すべてのレスポンスのX-Marketsヘッダー、開発者コンソールのデータ範囲カードで確認できます。 - 市場は銘柄コード(韓国6桁 =
KR、米国ティッカー =US)またはmarketパラメータで決まります。契約外の市場は403 MARKET_NOT_ENTITLED、日本・中国は400 MARKET_NOT_AVAILABLEです。 marketを選べる一覧で値を省略すると、1つの市場だけを契約しているアカウントではその市場が既定値になります。市場が混在するニュースフィードは契約中の市場の記事だけを返します。
Data API のレスポンスの形
- 単一ドキュメント:
{ data, meta }。リスト:{ data, next_cursor, has_more, meta }。次のページはnext_cursorを同じフィルターのまま送ります。 metaには常にas_of(レスポンス時刻)があり、企業エンドポイント(/companies/{symbol}/…)はdisclaimer・unit_note・page_urlも返します。- エラーは常に
{ error: { code, message, docs } }です。上の PRO API の形(sourcesを含む)とは異なります。
エンドポイント別の単位・通貨
| エンドポイント | 項目 | 韓国(KR) | 米国(US) |
|---|---|---|---|
/companies/{symbol}/financials | value | 1 億ウォン(KRW_EOK)、1 株あたりはウォン | 100 万ドル(USD_MIL)、EPS は 1 株あたりドル(USD)、株式数は 100 万株(SHARES_MIL) |
/companies/{symbol}/metrics | 金額(ratios・valuation) | 1 億ウォン(KRW_EOK) | 100 万ドル(USD_MIL) |
/companies/{symbol}/metrics | 比率・成長率 | % | % |
/companies/{symbol}/segments | amount · pct | 1 億ウォン・% | 100 万ドル・% |
/companies/{symbol}/dividends | 1 株あたり金額・利回り・配当性向 | ウォン・% | ドル・%(total_dividends_paid は 100 万ドル) |
/companies/{symbol}/consensus | consensus・actual など | ウォンそのまま(既定 unit=raw)・unit=eok 1 億ウォン・unit=million 100 万ウォン | ドルそのまま(既定)・unit=million 100 万ドル |
/companies/{symbol}/guidance | value・low・high | ウォンそのまま(unit = KRW、EPS は KRW_PER_SHARE) | ドルそのまま(USD、EPS は USD_PER_SHARE) |
/companies/{symbol}/net-income-split | 金額 | 1 億ウォン(連結) | — |
/quotes/{symbol} | data.valuation | 時価総額 1 億ウォン(KRW_EOK)、1 株あたりはウォン | — |
コンセンサスは財務諸表と単位が異なります(既定はウォン・ドルそのまま)。揃えるには
unit=eok(韓国)または unit=million を付けてください。値ごとに unit・unit_scale が付きます(元の金額 = 値 × unit_scale)。機械可読コード
period_code: 年度FY2025・四半期2026Q3・累計2025YTDQ2(上半期)・2025YTDQ3(第 1〜3 四半期)。企業の会計年度基準です(米国はperiod_endで実際の日付を確認してください)。account_code: 下の勘定科目コード。fs_code:CFS(連結)・OFS(個別)。unit_code:KRW_EOK・USD_MIL・USD・KRW・SHARES_MIL。report_code: 韓国annual_report(事業報告書)・half_year_report(半期報告書)・q1_report・q3_report(四半期報告書)、米国は SEC 様式(10-K・10-Q・20-F・8-K…)。- 韓国語の項目(
account・period・report・name)は表示用の文字列です。並べ替え・結合・絞り込みにはコード項目を使ってください。
勘定科目コード
/companies/{symbol}/financials の account パラメータとレスポンスの account_code です。英語コードはその科目だけに一致し、韓国語名は部分一致です(例: 순이익 → 当期純利益と親会社株主帰属純利益)。カンマで複数指定でき、不明な英単語は 400 BAD_REQUEST です。
| account_code | 元帳の科目名(表示) | English | 財務諸表 | 市場 |
|---|---|---|---|---|
revenue | 매출액 | Revenue | 損益 | KR · US |
cost_of_revenue | 매출원가 | Cost of revenue | 損益 | KR · US |
gross_profit | 매출총이익 | Gross profit | 損益 | KR · US |
sga_expense | 판매비와관리비 | Selling, general & administrative expense | 損益 | KR · US |
rnd_expense | 연구개발비 | Research & development expense | 損益 | KR · US |
operating_income | 영업이익 | Operating income | 損益 | KR · US |
finance_income | 금융수익 | Finance income | 損益 | KR |
finance_costs | 금융비용 | Finance costs | 損益 | KR |
interest_expense | 이자비용 | Interest expense | 損益 | US |
pretax_income | 법인세차감전순이익 | Income before income taxes | 損益 | KR |
income_tax_expense | 법인세비용 | Income tax expense | 損益 | KR · US |
discontinued_operations_income | 중단영업손익 | Profit (loss) from discontinued operations, net of tax | 損益 | KR |
net_income | 당기순이익 | Net income | 損益 | KR · US |
net_income_controlling | 지배주주순이익 | Net income attributable to owners of the parent | 損益 | KR |
eps | 주당순이익 | Earnings per share (diluted) | 損益 | US |
current_assets | 유동자산 | Current assets | 貸借対照表 | KR · US |
cash_and_equivalents | 현금및현금성자산 | Cash and cash equivalents | 貸借対照表 | KR |
trade_receivables | 매출채권 | Trade receivables | 貸借対照表 | KR |
inventories | 재고자산 | Inventories | 貸借対照表 | KR |
noncurrent_assets | 비유동자산 | Non-current assets | 貸借対照表 | KR · US |
property_plant_equipment | 유형자산 | Property, plant and equipment | 貸借対照表 | KR |
intangible_assets | 무형자산 | Intangible assets | 貸借対照表 | KR |
total_assets | 자산총계 | Total assets | 貸借対照表 | KR · US |
current_liabilities | 유동부채 | Current liabilities | 貸借対照表 | KR · US |
trade_payables | 매입채무 | Trade payables | 貸借対照表 | KR |
short_term_borrowings | 단기차입금 | Short-term borrowings | 貸借対照表 | KR |
current_portion_long_term_debt | 유동성장기부채 | Current portion of long-term debt | 貸借対照表 | KR |
noncurrent_liabilities | 비유동부채 | Non-current liabilities | 貸借対照表 | KR · US |
bonds_payable | 사채 | Bonds payable | 貸借対照表 | KR |
long_term_borrowings | 장기차입금 | Long-term borrowings | 貸借対照表 | KR |
total_liabilities | 부채총계 | Total liabilities | 貸借対照表 | KR · US |
share_capital | 자본금 | Share capital | 貸借対照表 | KR · US |
retained_earnings | 이익잉여금 | Retained earnings | 貸借対照表 | KR · US |
equity_controlling | 지배기업소유주지분 | Equity attributable to owners of the parent | 貸借対照表 | KR |
noncontrolling_interests | 비지배지분 | Non-controlling interests | 貸借対照表 | KR · US |
total_equity | 자본총계 | Total equity | 貸借対照表 | KR · US |
diluted_shares | 발행주식수 | Weighted-average diluted shares | 貸借対照表 | US |
shares_outstanding | 발행주식수(시점) | Shares outstanding (cover date) | 貸借対照表 | US |
operating_cash_flow | 영업활동현금흐름 | Cash flow from operating activities | キャッシュフロー | KR · US |
investing_cash_flow | 투자활동현금흐름 | Cash flow from investing activities | キャッシュフロー | KR · US |
financing_cash_flow | 재무활동현금흐름 | Cash flow from financing activities | キャッシュフロー | KR · US |
capex | 설비투자 | Capital expenditure | キャッシュフロー | KR · US |
amortization | 무형자산상각비 | Amortization of intangible assets | キャッシュフロー | KR |
depreciation_amortization | 감가상각비 | Depreciation & amortization | キャッシュフロー | US |
dividends_paid | 배당금지급 | Dividends paid | キャッシュフロー | US |
期間の指定(period)
- 財務諸表: 年度
FY2025・2025、四半期2026Q2・FY2026 Q2・Q2 2026、韓国のみの累計2025H1(=2025YTDQ2)・2025YTDQ3、さらにlatest_quarter・annual・quarterly。韓国語(2025 연간・2026 2분기・2025 반기 누적)も受け付けます。 - コンセンサス・ガイダンス:
2026Q3・FY2027Q2(四半期)、FY2026・2026(年度)、last・next(前・次の四半期)。 - それ以外は
400 BAD_PERIODです。レスポンスのperiod_codeをそのまま指定できます。
サムスン電子 · 005930
bash
curl -sG "https://api.chickstockfi.com/openapi/v1/companies/005930/financials" \
-H "Authorization: Bearer $PHOENIX_API_KEY" \
--data-urlencode "account=revenue,operating_income" \
--data-urlencode "period=2026Q2" \
--data-urlencode "fs=CFS"財務諸表の並び順とページ
- 並び順: 会計年度・四半期の新しい順(同じ年は年度 → 第 4 → 第 1 四半期、累計は同じ四半期の後)→ 勘定科目(財務諸表の順)→ 連結(CFS)優先 → 開示元帳優先。
- ページ:
limit(既定 100、最大 200)+cursor。科目・期間を省くと元帳全体を最新期間から返し、残りはnext_cursorで続けて受け取ります(meta.total= 全行数)。行はdata.rowsにあります。 fs=CFS・fs=OFSで連結・個別を選びます(韓国)。米国の行はCFSです。
企業 IR 資料で補った期間
- 開示元帳(DART・SEC)の値が優先です。元帳にない(科目・期間)だけを企業 IR 資料で補い、
sourceは기업 IR 자료(企業 IR 資料)になります。 - 補う科目は売上高・営業利益・当期純利益・負債合計・資本合計・流動資産・流動負債のみです。そのため補った期間には一部の科目だけがあります。対象は
meta.partner_filled_periods・partner_filled_accountsにあります。 - IR 資料の行は開示ではないため、
report・report_code・filed_date・source_url・period_endはnullです。
コンセンサスとガイダンス
- コンセンサスは韓国が売上高・営業利益、米国は売上高のみです。
meta.metricsがその市場で実際に返す指標です。 - 発表済み期間の
vs_consensus_pctは、発表日(reported_on)より前に観測したコンセンサス(consensus_at_report)がある場合だけ計算します。ない場合はnullで、理由はcomparison_statusで示します —compared・basis_unconfirmed・no_pre_report_estimate(発表前の値がない、または発表日が不明)・no_actual・upcoming。 - 米国の一部期間はソースが発表時刻を返さないため
reported_onがnullになり、発表直前の値を選びません。 - ガイダンス(
/companies/{symbol}/guidance)のvalue・low・highはウォン・ドルそのままで、unit・unit_scale(1)がその単位を表します。表示用の単位はdisplay_unit・display_scaleです(値 ÷display_scale=display_unit単位の数値)。
開示一覧の絞り込み(米国)
/companies/{symbol}/disclosuresでは米国銘柄をform=10-K,10-Q,8-K(その様式のみ、10-Kは訂正10-K/Aを含む)・exclude_forms=424B2,SC 13G(その様式を除く)で絞り込めます。カンマ区切りで最大 10 個です。- 絞り込まない場合、大量に繰り返される様式(424B2・SC 13G など)は一覧の一部に抑えます。韓国銘柄にこのフィルターを指定すると
400 BAD_REQUESTです。 - すべての開示行に
report_code(韓国の定期報告書コード・米国の様式)があります。
ニュースの範囲
market=KRは韓国メディアの韓国語記事、market=USは米国の記事(海外メディアの英語記事・企業プレスリリース・SEC 開示速報)です。省略すると両方です。Phoenix AI が収集済みの記事だけを返します。- 米国の英語記事は
titleが原文、title_koが Phoenix AI の韓国語訳(なければnull)です。langはtitleの言語です。 publisherは媒体名です。集約サービスの名前がその位置に来る場合は해외 언론(海外メディア)・뉴스(ニュース)と表示します。symbolフィルターは銘柄タグが検証された記事だけを返します。そのため 1 ページがlimitより短いことがあるので、has_more・next_cursorをたどってください。同じ記事の再配信(近似重複)は 1 ページで 1 件に絞ります。
株価(/quotes)
data.valuationは/companies/{symbol}/metricsのvaluationと同じ計算です(basis・eps_basis— 韓国の EPS・PER は親会社株主帰属純利益基準)。0 で届いた該当なしの値はnullです。- 最上位フィールド(
symbol・price・fundamentals…)は従来互換用(非推奨)で、値・単位は従来のままです(fundamentals.debt_ratioは比率 0.311 = 31.1%)。新しいコードはdataを読んでください。
空の値と銘柄コード
- 値を取得できない場合は
nullです。0とは区別してください。 - 韓国株は6桁のコード(例: サムスン電子 · 005930)、米国株はティッカー(例: アップル · AAPL)を使います。エンドポイントごとの対応市場はリファレンスに記載しています。
参考情報に関するご注意
API のデータと AI 要約は投資判断の参考情報であり、投資を勧誘するものではありません。数値は
sources の原文でご確認ください。