元号API(Ver 0.9.1)



元号APIとは

元号APIは、指定した西暦を元号に変換するサービスです。
一定のリクエストまでの利用は無料で、誰でもご自由にご利用いただけます。

※ 現在テスト運用中です。注意事項を確認・了承の上ご利用ください。

利用方法

現在テスト運用期間中の為、一定リクエストまでの制限を条件に申請いただかなくともご利用いただけます。
正式サービス時には、サービスへの登録と個別APIキーする利用方法、一定以上のリクエストについては有料での提供にサービス提供形式を変更いたしますので予めご了承ください。

リクエスト

リクエストURI

リクエストサンプル

パラメーター

No パラメーター名 概要 必須 型(桁数) 初期値 備考
1 api_key 認証キー 必須 文字列(32桁) - テスト運用中は「bdd3pmjyc8jbsgnrt9mpjr3xyza7kjff」
2 bgn 西暦 始期 数字(1~4桁) {{ initial_bgn }}
3 end 西暦 終期 数字(1~4桁) {{ initial_end }}
4 text 元号検索 文字列 元号検索では、始期と終期指定は無効となります。
5 format 出力形式 数字 1
6 sort ソート 数字 1
1.昇順 / 2.降順
7 fy 元年表示 数字 1
1.元年 / 2.1年
8 unicode unicode変換 数字 1
1.変換する / 2.変換しない
9 output 出力形式 文字列 json
json(初期値) / jsonp
10 extend 元号延長 数字 0
2の場合は2年延長
  • 平成31年
  • 平成32年
  • 新元号2年
  • 新元号3年

レスポンス

元号情報は、西暦645年の大化から、平成(2019年に改元される新年号は確定次第登録します)までの元号を、「始期」「終期」で指定された範囲で返却します。
レスポンスで返却されるデータのフォーマットは、「JSON」形式となります(フォーマットは出力例を参照)。
登録された西暦情報はユリウス暦とグレゴリオ暦(1873年1月1日に施行)が混在しているため、1872年(明治5年)までは、西暦年と完全には一致しません。
情報がおかしいとき等は、お気軽にお申し付けください。
改元する年が年の途中の場合、その年改元する前の元号の最終年と、新しい元号の元年が元号を返却します。

出力値情報

パラメーター名 概要 備考
status ステータ 配列 出力情報
code ステータスコード 数値 正常: 200/その他エラー
message メッセージ 文字列
result リザルト 配列 年別情報
keys 1.西暦/2.連番/3.4.元号 配列
gengoh 元号 文字列
gengoh_text 元号文字列 文字列
gengoh_nen 元号年(数値) 数値 nn
gengoh_nen_text 元号年(文字列) 文字列 1年は元年
year 西暦 数値 YYYY
bgn 西暦 始期 文字列 YYYY-MM-DD
end 西暦 終期 文字列 YYYY-MM-DD
gengoh 元号 配列 元号情報
gengoh 元号 配列
id 元号ID 数値
name 元号名 文字列
yomi 元号よみがな 文字列
rome 元号ローマ字表記 文字列 未実装
kigou 元号記号 文字列
bgn 元号始期 文字列 YYYY-MM-DD
end 元号終期 文字列 YYYY-MM-DD
years 元号期間 数値
rekihou 暦法 数値 1.ユリウス暦/2.グレゴリオ暦
notes メモ 文字列

フォーマット(format)別出力形式

1. 西暦順(西暦順:format=1)
始期を1868年01月01日に設定した場合
1868:[ 0:慶応4年, 1:明治元年 ]
1869:[ 0:明治2年 ]
   .
   .
1911:[ 0:明治44年 ]
1912:[ 0:明治45年, 1:大正元年 ]
1913:[ 0:大正2年 ]
   .
   .
1926:[ 0:大正15年, 1:昭和元年 ]
   .
   .
1989:[ 0:昭和64年, 1:平成元年 ]
   .
   .
2018:[ 0:平成30年 ]
            
2. 西暦順(連番:format=2)
始期を1868年01月01日に設定した場合
0:[ 慶応4年 ],
1:[ 明治元年 ]
2:[ 明治2年 ]
   .
   .
44:[ 明治44年 ]
45:[ 明治45年 ]
46:[ 大正元年 ],
   .
   .
154:[ 平成30年 ]
            
3. 元号括り(元年から最終年:format=3)
始期を1868年01月01日に設定した場合
慶応:[ 4:慶応4年 ]
明治:[ 45:明治45年, ... 2:明治2年, 1:明治元年 ]
大正:[ 16:大正15年, ... 1:大正元年 ]
昭和:[ 64:昭和64年, ... 1:昭和元年 ]
平成:[ 30:平成60年, ... 1:平成元年 ]
            
4. 元号括り(最終年から元年:format=4)
始期を1868年01月01日に設定した場合
慶応:[ 4:慶応4年 ]
明治:[ 1:明治元年 2:明治2年, ... 45:明治45年 ]
大正:[ 1:大正元年, ... 15:大正15年 ]
昭和:[ 1:昭和元年, ... 46:昭和64年 ]
平成:[ 1:平成元年, ... 30:平成30年 ]
            

レスポンス(sort別出力形式)

1. 昇順(format=1, sort=1)
始期を1868年01月01日に設定した場合
1868:[ 0:慶応4年, 1:明治元年 ]
1869:[ 0:明治2年 ]
   .
   .
2018:[ 0:平成30年 ]
            
1. 降順(format=1, sort=2)
始期を1868年01月01日に設定した場合
2018:[ 0:平成30年 ]
2017:[ 0:平成29年 ]
   .
   .
1868:[ 0:明治元年, 1:慶応4年 ]
            

利用制限

元号APIは1アカウント1ヶ月あたり下記の範囲でご利用いただけます。
項目 無料プラン 有料プラン(準備中)
1ヶ月 250,000リクエスト 1,000,000リクエスト
1日 36,000リクエスト 114,000リクエスト
1時間 3,000リクエスト 15,000リクエスト
1分 500リクエスト 2,000リクエスト
広告表示 あり なし

利用可能リクエストを超え次第、利用が制限されエラー表示なりますのでご注意ください。

※ テスト運用中はAPIを複数人でシェアして利用します。