日本語 / 英語の扱い
ZENITH Code API は 1 つの API・1 つのドメインで日英両対応です。項目名は英語の camelCase、金額は円、日付は ISO 形式で統一し、企業名・業種名などの文字列は日本語と英語の両方の項目で返します。
両言語の項目(Jp / En などの接尾辞)
企業名は nameJa / nameEn、業種名は sectorJa / sectorEn(業種コードは sector または sectorCode)、事由などのラベルは labelJa / labelEn のように、両方の項目で返ります。言語ごとにリクエストを分ける必要はなく、照合には日本語名、表示には英語名、といった使い分けができます。
{
"symbol": "7203",
"nameJa": "トヨタ自動車",
"nameEn": "TOYOTA MOTOR CORPORATION",
"sector": "3700"
}
// /stable/available-sectors?lang=ja
{
"sectorCode": "3700",
"sectorJa": "輸送用機器",
"sectorEn": "Transportation Equipment",
"label": "輸送用機器"
}?lang=ja|en — label の言語
両言語の項目に加えて 1 つの値で返る label(業種の一覧の label、臨時報告書の事由の一覧の label など)は、言語を選べます。決める順は lang 引数(ja / en)→ Accept-Language ヘッダー(優先度の高い ja か en)→ 英語です。何も指定しなければ英語で、日本語にするには lang=ja を付けるか Accept-Language: ja を送ります。応答には Vary: Accept-Language が付きます。
# 英語ラベル(既定) curl "https://api.zenithcode.net/stable/available-sectors" \ -H "x-api-key: YOUR_API_KEY" # 日本語ラベル curl "https://api.zenithcode.net/stable/available-sectors?lang=ja" \ -H "x-api-key: YOUR_API_KEY"
lang が変えるのは label だけです。nameJa / nameEn・sectorJa / sectorEn のような両言語の項目は、lang に関わらず常に両方返ります。
ドキュメントの正本
OpenAPI(openapi.json)の説明文は英語が正本で、日本語説明は x-description-ja 拡張に併記されます。このDocsとAPI Viewerは表示言語に合わせてどちらかを表示します。
public
英語圏ユーザーの方へ
日本株データには、証券コード体系(4桁+英字)、3月決算が多い決算期、JP GAAP固有の科目(経常利益 = ordinaryIncome)、TDnet短信とEDINET有報の違いなど、日本固有の前提があります。別ページにまとめています。
日本株データの基礎を読む →
