API 一 覧 ユーザー 認 証 API No 名 称 Method URL 1ユーザー 認 証 API POST データ 取 得 API No 名 称 Method URL 1 株 式 現 物 日 次 四 本 値 GET h

Transcription

1 JPXデータクラウド API 仕 様 書 2015 年 2 月 東 京 証 券 取 引 所 1

2 API 一 覧 ユーザー 認 証 API No 名 称 Method URL 1ユーザー 認 証 API POST データ 取 得 API No 名 称 Method URL 1 株 式 現 物 日 次 四 本 値 GET 2 株 式 現 物 歩 み 値 GET 3 株 式 現 物 気 配 GET 4CB 日 次 四 本 値 GET 5CB 歩 み 値 GET 6CB 気 配 GET 7 指 数 日 次 四 本 値 GET 8 指 数 歩 み 値 GET 9インディカティブNAV 歩 み 値 GET 2

3 1.ユーザー 認 証 API 3

4 API 概 要 No 名 称 Method URL 1ユーザー 認 証 API POST OAuth2.0に 準 拠 したユーザー 認 証 APIです 4

5 リクエストパラメータ No. パラメータ 名 物 理 名 内 容 P1 クライアントID client_id jpx-data-cloud( 固 定 値 ) P2 認 証 タイプ grant_type password ( 固 定 値 ) P3 ユーザー 名 username API 用 ID P4 パスワード password API 用 パスワード すべて 必 須 のパラメータです 5

6 レスポンスフィールド 検 索 処 理 の 状 態 ヘッダ 処 理 結 果 Http Status error error_ discription レスポンス(JSON) access_ token token_type expires_in scope 認 証 成 功 200 認 証 失 敗 400 要 素 名 error error_discription access_token token_type expires_in scope 説 明 エラー 種 別 エラーメッセージ アクセストークン これをデータ 取 得 APIで 利 用 します bearer 固 定 認 証 切 れまでの 秒 数 trust 固 定 6

7 サンプル 以 下 は API 用 ID 名 user の 認 証 リクエストに 対 するレスポンスです リクエストURL POSTパラメータ client_id=jpx-data-cloud grant_type=password username=user password=password123 レスポンス { } access_token: " XXXX-XXXX-XXXX-XXXXXXXXXX" token_type: "bearer" expires_in: 899 scope: "trust" 7

8 エラーメッセージ エラーメッセージ エラー 種 別 エラーの 原 因 There is no client authentication. Try adding an appropriate authentication filter. unauthorized アクセスメソッドが 不 正 Unsupported grant type: <ユーザーが 指 定 したgrant_type> unsupported_ grant_type 認 証 タイプが 不 正 Missing grant type invalid_request 認 証 タイプの 指 定 がない No client with requested id: <ユーザーが 指 定 したクライアントID> unauthorized クライアントIDが 不 正 There is no client authentication. Try adding an appropriate authentication filter. Bad credentials unauthorized invalid_grant クライアントIDの 指 定 がない ID,PASSWORDの 組 み 合 わせが ない 8

9 2.データ 取 得 API 9

10 API 概 要 No 名 称 Method URL 1 株 式 現 物 日 次 四 本 値 GET 2 株 式 現 物 歩 み 値 GET 3 株 式 現 物 気 配 GET 4CB 日 次 四 本 値 GET 5CB 歩 み 値 GET 6CB 気 配 GET 7 指 数 日 次 四 本 値 GET 8 指 数 歩 み 値 GET 9インディカティブNAV 歩 み 値 GET データの 検 索 取 得 を 目 的 としたAPIで JSON 形 式 でデータを 返 します 取 得 情 報 ごとに APIは9 種 ございます 10

11 リクエストパラメータ No. パラメータ 名 物 理 名 内 容 P1 執 行 市 場 market 執 行 市 場 を 表 すコード 値 東 証 :1/ 旧 大 証 :2 P2 コード code 銘 柄 コードまたは 指 数 コードの 単 一 指 定 株 式 :5 桁 (4 桁 の 場 合 末 尾 に0を 補 完 )CB:9 桁 指 数 インディカティブNAV:4 桁 P3 取 得 開 始 日 from P4 取 得 終 了 日 to P5 アクセストークン ー P6 次 ページキー nextkey 年 月 日 時 分 秒 ミリ 秒 を 数 値 で 表 したもの 年 月 日 は 必 須 桁 が 足 りない 場 合 は 末 尾 ゼロ 埋 めします ( 年 月 日 年 月 日 時 分 秒 年 月 日 時 分 秒 ミリ 秒 の3パ ターンの 何 れかを 入 力 ) 年 月 日 時 分 秒 ミリ 秒 を 数 値 で 表 したもの 年 月 日 は 必 須 時 分 秒 ミリ 秒 は で 埋 めます ( 年 月 日 年 月 日 時 分 秒 年 月 日 時 分 秒 ミリ 秒 の3パ ターンの 何 れかを 入 力 ) Aurhorizationリクエストヘッダーフィールド 中 で 送 信 すること Bearer 認 証 スキームを 用 います 前 回 の 取 得 データにnextkeyがある 場 合 に 入 力 します 初 回 は 空 でOK 11

12 各 APIで 使 用 するパラメータ データ 取 得 API No. パラメータ 名 株 式 現 物 日 次 四 本 値 株 式 現 物 歩 み 値 株 式 現 物 CB 日 次 気 配 四 本 値 CB CB 歩 み 値 気 配 指 数 日 次 四 本 値 指 数 歩 み 値 INAV 歩 み 値 P1 執 行 市 場 P2 コード P3 取 得 開 始 日 A B B A B B A B B P4 取 得 終 了 日 A B B A B B A B B P5 アクセス トークン P6 次 ページキー : 必 須 : 任 意 [ 空 白 ]: 不 要 A: 年 月 日 指 定 (YYYYMMDD) B: 年 月 日 時 分 秒 ミリ 秒 (YYYYMMDDHHMMSSFFF) 12

13 レスポンスフィールド 処 理 結 果 検 索 処 理 の 状 態 ヘッダ レスポンス(JSON) データ 次 ページ Http Status error_ message nextkey count data 正 常 あり なし 200 正 常 あり あり 200 正 常 なし なし 200 備 考 異 常 400 パラメータエラー 認 証 切 れ 401 この 場 合 再 認 証 が 必 要 アクセス 数 超 過 403 単 位 時 間 当 たりのアクセス 数 を 超 過 した 場 合 異 常 500 要 素 名 説 明 error_message エラーメッセージ nextkey 次 ページのキー 値 count このレスポンスのデータ 件 数 data テーブル 形 式 のデータ column:value 検 索 対 象 のデータを 項 目 名 ( 英 名 ) : 値 をカンマ 区 切 りで 構 成 13

14 提 供 データについて 各 データの 項 目 定 義 やコード 表 につきましては 別 紙 データ 仕 様 書 をご 参 照 ください 14

15 サンプル 以 下 は トヨタ(7203)の2014 年 9 月 8 日 の 四 本 値 リクエストに 対 するレスポンスです リクエストURL リクエストヘッダー Authorization: Bearer XXXX-XXXX-XXXX-XXXXXXXXXX レスポンス { } "count" : 1, "data" : [{ "OPEN" : "6121", "CLASS" : "0111", "IND" : "3700", "CLOSE" : "6107", "TO" : " ", "HIGH" : "6123", "ISIN" : "JP ", "EXCH" : "01", "VOL" : " ", "FQID" : "", "FQ" : "", "DATE" : " ", "DELFL" : " ", "LOW" : "6084", "EXRFL" : " ", "FQFL" : "", "VWAP" : " ", "CODE" : "72030" } ] 15

16 トライアル 利 用 各 APIを 認 証 不 要 でご 利 用 いただけるトライアル 環 境 を 用 意 しております URL の 代 わりに を 指 定 してください 取 得 可 能 データ 株 式 コード: 7203 四 本 値 : 歩 み 値 : 気 配 : CBコード: 四 本 値 : 歩 み 値 : 全 件 気 配 : 全 件 指 数 コード: 0000 四 本 値 : 歩 み 値 : インディカティブNAVコード: C306 歩 み 値 :

17 エラーメッセージ1 エラーメッセージ 日 本 語 メッセージ エラーの 原 因 日 付 の 形 式 が 正 しくない {0} must be set in "yyyymmdd" format {0}は yyyymmdd 形 式 で 指 定 してください 又 は 指 定 がない {0} format must be "yyyymmdd", "yyyymmddhhmmss", or "yyyymmddhhmmsssss" "data term from" must be older than "data term to" "data term from" and "data term to" must be the same date {0}は yyyymmdd 形 式 yyyymmddhhmmss 形 式 日 付 の 形 式 が 正 しくない yyyymmddhhmmsssss 形 式 のいずれかで 指 定 して 又 は 指 定 がない ください 取 得 開 始 日 には 取 得 終 了 日 よりも 過 去 の 日 付 を 指 定 してください 取 引 開 始 終 了 日 には 同 一 日 付 を 指 定 してください 執 行 市 場 には 0,1,2,3,6,8のいずれかの Exchange code must be 0, 1, 2, 3, 6, or 8 値 を 指 定 してください Issue code for equity must be 4 or 5 digits Issue code for CB must be 9 digits 株 式 の 銘 柄 コードを 4 文 字 または5 文 字 で 入 力 してください CBの 銘 柄 コードを 9 文 字 で 入 力 して ください 期 間 の 整 合 性 があわない 1 日 分 超 のデータ 取 得 ( 気 配 のみ) 執 行 市 場 が 不 正 株 式 : 銘 柄 コードが 不 正 CB: 銘 柄 コードが 不 正 Index type must be 4 digits 指 数 コードを 4 文 字 で 入 力 してください 指 数 : 銘 柄 コードが 不 正 Index type for indicative NAV must be 4 digits Exchange code or issue code is invalid インディカティブNAVコードを 4 文 字 で 入 力 してください インディカティブnav: 銘 柄 コードが 不 正 執 行 市 場 もしくは 銘 柄 執 行 市 場 もしくは 銘 柄 コードの 値 が 不 正 です コードが 不 正 Exchange code 執 行 市 場 APIの market の 名 称 17

18 エラーメッセージ2 エラーメッセージ 日 本 語 メッセージ エラーの 原 因 Issue code コード APIの code の 名 称 data term from 取 得 開 始 日 APIの from の 名 称 data term to 取 得 終 了 日 APIの to の 名 称 cannot find specified user ID specified user is not authorized to use API user authentification must be conducted exceed the number of accessible times per unit period. Please wait and try again user access information is duplicated. Please contact system administrator. user type is invalid cannot find specified user ID database error has occurred. Please contact system administrator. 該 当 するユーザーIDは 見 つかりませんでした 該 当 するユーザーにAPI 利 用 権 限 が 存 在 しません ユーザー 認 証 が 行 われていません 正 しいトークンだが ユーザー IDが 見 つからない 場 合 正 しいトークンだが API 利 用 権 限 が 無 い 場 合 正 しいトークンだが ユーザー 認 証 が 行 われていない 場 合 単 位 時 間 当 たりのアクセス 数 を 超 過 しています 単 位 時 間 当 たりのアクセス 数 を 一 定 期 間 後 に 再 アクセスを 行 ってください 超 過 している ユーザーアクセス 情 報 が 複 数 存 在 します システム 管 理 者 へご 連 絡 ください ユーザー 種 別 が 不 正 です 該 当 するユーザーIDは 見 つかりませんでした DBエラーが 発 生 しました システム 管 理 者 へ ご 連 絡 ください データの 不 整 合 が 発 生 している 場 合 正 しいトークンだが ユーザー 種 別 が 不 正 な 場 合 正 しいトークンだが ユーザー IDが 見 つからない 場 合 APIでシステム 的 な 問 題 が 発 生 した 場 合 18