川崎市のイベント情報のオープンデータ
API リファレンス
イベント API ¶
川崎市公式アプリ「かわさきイベントアプリ」では、川崎市内のさまざまなイベント情報を、行政、民間の隔てなく一体的に発信しており、そのイベント情報をWEBAPI機能によりオープンデータとして提供しています。
ご利用に際しては、必ず、以下の「川崎市のオープンデータ利用規約」をご一読の上、活用ください。
また、取得後、ホームページやアプリ等で活用された場合、下記フォームからご連絡いただけますと、市のホームページ上に活用事例といった形でご紹介することも可能ですので、よろしければご連絡ください。
フォーム
利用規約
川崎市オープンデータ利用規約
川崎市オープンデータ利用規約(PDF形式, 58.62KB)
川崎市オープンデータ利用規約は、川崎市オープンデータ一覧に掲載されているデータの利用に関する規約です。データの利用の際には、本規約に従っていただくようお願いいたします。
ライセンスの取り扱い
本サイトで公開されているデータは、クリエイティブ・コモンズ 表示 2.1 日本 ライセンスの下に提供されています。
画像をクリックするとライセンスの説明ページに移動します。
川崎市のオープンデータの取組については、市のサイトをご確認ください。
http://www.city.kawasaki.jp/shisei/category/51-7-4-0-0-0-0-0-0-0.html
イベント情報 ¶
イベント情報の取得GET/data/api/v1/events{?page,format,place,from,to,type,target,title}
-
クエリ文字列で指定された条件で、公開中のイベント情報を取得します
- イベント情報には画像情報は含まれません
-
クエリ文字列に複数の条件を指定することで、AND 条件で検索することができます
- 例えば、開催場所とイベント種別を AND 条件で検索する場合は以下のように指定します
- /data/api/v1/events?place=1&type=2
-
本 API で取得できる情報は最大100件です
- 100件を超えるイベント情報を取得する場合は、クエリ文字列のページ番号を指定して複数回に分けてリクエストしてください
-
API が返却するデータの構造については、後述の「データ構造」をご確認ください
Example URI
- page
number
(optional) Default: 1 Example: 1取得するイベント情報のページ番号を指定します。
指定できる値は1以上の整数値です。- format
string
(optional) Default: JSON Example: JSON返却するデータ形式を指定します。
指定できる文字列は以下の通りです。-
JSON - JSON形式
-
XML - XML形式
-
- place
number
(optional) Default: 全ての開催場所 Example: 1検索対象とする開催場所を指定します。
カンマ区切りで指定することで、OR 条件で検索できます。(例:place=1,2)
指定できる数値は以下の通りです。-
1 - 川崎区
-
2 - 幸区
-
3 - 中原区
-
4 - 高津区
-
5 - 宮前区
-
6 - 多摩区
-
7 - 麻生区
-
8 - 横浜市
-
9 - 東京都
-
10 - その他
-
- from
string
(optional) Default: 日時指定なし Example: 2019-06-01to と併せて指定することで、開催日時が from から to の範囲に含まれているイベントを検索します。
指定できる文字列は yyyy-MM-dd 形式の日付です。(例:2019-06-01)-
to を指定せずに本項目を指定した場合、Default で動作します
-
from と to に同じ日付を指定した場合、開催日時が指定した日付と一致するイベントを検索します
-
- to
string
(optional) Default: 日時指定なし Example: 2019-07-01from と併せて指定することで、開催日時が from から to の範囲に含まれているイベントを検索します。
指定できる文字列は yyyy-MM-dd 形式の日付です。(例:2019-07-01)-
from を指定せずに本項目を指定した場合、Default で動作します
-
from と to に同じ日付を指定した場合、開催日時が指定した日付と一致するイベントを検索します
-
- type
number
(optional) Default: 全てのイベント種別 Example: 1検索対象とするイベント種別を指定します。
カンマ区切りで指定することで、OR 条件で検索できます。(例:type=1,2)
指定できる数値は以下の通りです。-
1 - 学び・講座
-
2 - 体感・体験
-
3 - 遊び
-
4 - コミュニティ・交流
-
5 - 音楽
-
6 - 文化・芸術
-
7 - スポーツ
-
8 - 子ども・子育て
-
9 - 健康・福祉
-
10 - 環境・自然
-
11 - 防災・防犯
-
12 - 生き物
-
13 - ボランティア
-
14 - 観光
-
15 - 祭り
-
16 - 食
-
17 - 買い物
-
18 - 生活
-
19 - 仕事・ビジネス
-
20 - 小学生向け
-
21 - 中学生向け
-
22 - 高校生向け
-
- target
number
(optional) Default: 全ての対象者 Example: 0検索対象とする対象者を指定します。
カンマ区切りで指定することで、OR 条件で検索できます。(例:target=0,1)
指定できる数値は以下の通りです。-
0 - 指定なし
-
1 - 乳児
-
2 - 幼児
-
3 - 小学生
-
4 - 中学生
-
5 - 高校生
-
6 - 大学生
-
7 - 社会人
-
8 - 保護者
-
9 - 高齢者
-
10 - 妊産婦
-
11 - 障がい者
-
12 - 外国人
-
- title
string
(optional) Default: 指定なし Example: 2019イベント名称に指定した文字列を含む、イベント情報を検索します。
対応する文字コードはUTF-8になります。
200
-
以下は format に JSON を指定し、イベント情報の取得が正常に行われた場合のレスポンス例になります
-
イベント情報の取得結果が0件であった場合も本ステータスコードを返却します
Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Body
{
"page": 1,
"total_pages": 1,
"total_numbers": 1,
"event_data": [
{
"title": "親子でランチ",
"content": "公立保育園3か所で『親子でランチ』を毎月2回(4月と8月を除く)行っています。お子さんと同年齢のクラスに親子で入り一緒に遊んだり、保育園の給食や離乳食を食べるなど、保育園生活を体験できることができます。",
"status": "公開中",
"status_ext": null,
"date_list": [
{
"date": "2017-05-25",
"time_from": "09:00",
"time_to": "12:00",
"time_ext": "",
"date_w": "木曜日"
},
{
"date": "2017-05-18",
"time_from": "09:00",
"time_to": "12:00",
"time_ext": "",
"date_w": "木曜日"
},
{
"date": "2017-05-16",
"time_from": "09:00",
"time_to": "12:00",
"time_ext": "",
"date_w": "火曜日"
},
{
"date": "2017-05-11",
"time_from": "09:00",
"time_to": "12:00",
"time_ext": "",
"date_w": "木曜日"
}
],
"type1": "食,子ども・子育て,コミュニティ・交流,遊び,体感・体験,学び・講座",
"type2": "行政",
"target": "",
"target_ext": "",
"target_sex": "指定なし",
"target_area": "地域指定あり",
"target_area_ext": "",
"place": "多摩区",
"place_zip": "2140001",
"place_adr": "多摩区菅1-5-24 川崎市菅保育園",
"place_lat": 35.63268,
"place_lon": 139.53629,
"cost_ext": "一人250円(親子二人で500円)",
"capacity_ext": "先着順 1回2組",
"entry_list": [
{
"entry_from": "2017-04-17",
"entry_to": "2017-04-17",
"entry_tel": "0449353177",
"entry_fax": "",
"entry_mail": "",
"entry_url": "",
"entry_postcode": "",
"entry_post": "",
"entry_ext": "先着順 1回2組\n月曜日から金曜日 9時から5時まで受付",
"entry_from_w": "月曜日",
"entry_to_w": "月曜日"
}
],
"note": "",
"rel_list": [
{
"rel_alt": "",
"rel_url": ""
}
],
"organizer": "多摩区役所 保健福祉センター地域みまもり支援センター保育所等・地域連携",
"contact_list": [
{
"contact": "地域みまもり支援センター保育所等・地域連携",
"contact_tel": "0449353177",
"contact_fax": "",
"contact_mail": "",
"contact_ext": "多摩区役所 保健福祉センター"
}
],
"open_url": "https://www.city.kawasaki.jp/aaa/bbb.html",
"upd_date": "2017-04-03 17:32:49",
"created_date": "2017-04-03 15:28:54"
}
]
}
200
-
以下は format に XML を指定し、イベント情報の取得が正常に行われた場合のレスポンス例になります
-
イベント情報の取得結果が0件であった場合も本ステータスコードを返却します
Headers
Content-Type: application/xml
Transfer-Encoding: chunked
Body
<response>
<page>1</page>
<total_pages>1</total_pages>
<total_numbers>1</total_numbers>
<event_data>
<title>親子でランチ</title>
<content>公立保育園3か所で『親子でランチ』を毎月2回(4月と8月を除く)行っています。お子さんと同年齢のクラスに親子で入り一緒に遊んだり、保育園の給食や離乳食を食べるなど、保育園生活を体験できることができます。</content>
<status>公開中</status>
<status_ext/>
<date_list>
<date>2017-05-25</date>
<time_from>09:00</time_from>
<time_to>12:00</time_to>
<time_ext></time_ext>
<date_w>木曜日</date_w>
</date_list>
<date_list>
<date>2017-05-18</date>
<time_from>09:00</time_from>
<time_to>12:00</time_to>
<time_ext></time_ext>
<date_w>木曜日</date_w>
</date_list>
<date_list>
<date>2017-05-16</date>
<time_from>09:00</time_from>
<time_to>12:00</time_to>
<time_ext></time_ext>
<date_w>火曜日</date_w>
</date_list>
<date_list>
<date>2017-05-11</date>
<time_from>09:00</time_from>
<time_to>12:00</time_to>
<time_ext></time_ext>
<date_w>木曜日</date_w>
</date_list>
<type1>食,子ども・子育て,コミュニティ・交流,遊び,体感・体験,学び・講座</type1>
<type2>行政</type2>
<target></target>
<target_ext></target_ext>
<target_sex>指定なし</target_sex>
<target_area>地域指定あり</target_area>
<target_area_ext></target_area_ext>
<place>多摩区</place>
<place_zip>2140001</place_zip>
<place_adr>多摩区菅1-5-24 川崎市菅保育園</place_adr>
<place_lat>35.63268</place_lat>
<place_lon>139.53629</place_lon>
<cost_ext>一人250円(親子二人で500円)</cost_ext>
<capacity_ext>先着順 1回2組</capacity_ext>
<entry_list>
<entry_from>2017-04-17</entry_from>
<entry_to>2017-04-17</entry_to>
<entry_tel>0449353177</entry_tel>
<entry_fax></entry_fax>
<entry_mail></entry_mail>
<entry_url></entry_url>
<entry_postcode></entry_postcode>
<entry_post></entry_post>
<entry_ext>先着順 1回2組
月曜日から金曜日 9時から5時まで受付</entry_ext>
<entry_from_w>月曜日</entry_from_w>
<entry_to_w>月曜日</entry_to_w>
</entry_list>
<note></note>
<rel_list>
<rel_alt></rel_alt>
<rel_url></rel_url>
</rel_list>
<organizer>多摩区役所 保健福祉センター地域みまもり支援センター保育所等・地域連携</organizer>
<contact_list>
<contact>地域みまもり支援センター保育所等・地域連携</contact>
<contact_tel>0449353177</contact_tel>
<contact_fax></contact_fax>
<contact_mail></contact_mail>
<contact_ext>多摩区役所 保健福祉センター</contact_ext>
</contact_list>
<open_url>https://www.city.kawasaki.jp/aaa/bbb.html</open_url>
<upd_date>2017-04-03 17:32:49</upd_date>
<created_date>2017-04-03 15:28:54</created_date>
</event_data>
</response>
400
-
以下は format に JSON を指定し、イベント情報の取得が行われなかった場合のレスポンス例になります
-
指定したクエリ文字列に誤りがあり、イベントデータの取得が行われなかった場合に本ステータスコードを返却します
-
該当するケースは以下の通りです
- クエリ文字列の種別とは異なる値を指定した場合
- page に対し、1未満の整数を指定した場合
- format に対し、サポートする形式以外の文字列を指定した場合
- form または to に対し、誤った形式の文字列を指定した場合
- form または to に対し、存在しない日付を指定した場合
Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Body
{
"status": 400,
"message": "Invalid query string"
}
400
-
以下は format に XML を指定し、イベント情報の取得が行われなかった場合のレスポンス例になります
-
指定したクエリ文字列に誤りがあり、イベントデータの取得が行われなかった場合に本ステータスコードを返却します
-
該当するケースは format に JSON を指定した場合と同等です
Headers
Content-Type: application/xml
Transfer-Encoding: chunked
Body
<response><status>400</status><message>Invalid query string</message></response>
405
-
以下は format に JSON を指定し、イベント情報の取得が行われなかった場合のレスポンス例になります
-
URI に対し、サポートしていないメソッドをリクエストした場合に本ステータスコードを返却します
Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Body
{
"status": 405,
"message": "Method not allowed"
}
405
-
以下は format に XML を指定し、イベント情報の取得が行われなかった場合のレスポンス例になります
-
URI に対し、サポートしていないメソッドをリクエストした場合に本ステータスコードを返却します
Headers
Content-Type: application/xml
Transfer-Encoding: chunked
Body
<response><status>405</status><message>Method not allowed</message></response>
500
-
以下は format に JSON を指定し、イベント情報の取得が行われなかった場合のレスポンス例になります
-
REST APIサーバ内でエラーが発生し、リクエストを処理できなかった場合に本ステータスコードを返却します
Headers
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Body
{
"status": 500,
"message": "Internal server error"
}
500
-
以下は format に XML を指定し、イベント情報の取得が行われなかった場合のレスポンス例になります
-
REST APIサーバ内でエラーが発生し、リクエストを処理できなかった場合に本ステータスコードを返却します
Headers
Content-Type: application/xml
Transfer-Encoding: chunked
Body
<response><status>500</status><message>Internal server error</message></response>
データ構造 ¶
イベント情報の取得
-
イベント情報にデータが格納されていない場合、種別がリストの項目は空配列、それ以外の種別の項目は null を格納します
-
イベント情報のリストは、最も古い開催日を基準に昇順でソートされます
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
ページ番号 | page | 整数 | 取得したイベント情報のページ番号を示す |
最大ページ数 | total_pages | 整数 | 検索条件に合致したイベント情報の最大ページ数を示す |
総件数 | total_numbers | 整数 | 検索条件に合致したイベント情報の総件数を示す |
イベント情報 | event_data | リスト | 取得したイベント情報をリストで格納する。 詳細は後述の「イベント情報」参照。 |
イベント情報
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
イベント名称 | title | 文字列 | |
イベント概要 | content | 文字列 | |
ステータス | status | 文字列 | |
ステータス(補足) | status_ext | 文字列 | |
開催日リスト | date_list | リスト | 後述の「開催日」データをリストで格納する |
イベントの種別 | type1 | 文字列 | 種別が複数の場合、カンマ区切りの文字列で格納 |
イベントの種別(主体) | type2 | 文字列 | 種別が複数の場合、カンマ区切りの文字列で格納 |
対象者 | target | 文字列 | 対象者が複数の場合、カンマ区切りの文字列で格納 |
対象者(補足) | target_ext | 文字列 | |
対象者(性別) | target_sex | 文字列 | 指定なし 男性 女性 |
対象者(地域) | target_area | 文字列 | 地域指定あり 地域指定なし |
対象者(地域補足) | target_area_ext | 文字列 | |
開催場所 | place | 文字列 | |
開催場所(郵便番号) | place_zip | 文字列 | |
開催場所(住所) | place_adr | 文字列 | |
開催場所(緯度) | place_lat | 小数 | |
開催場所(経度) | place_lon | 小数 | |
参加費用(補足) | cost_ext | 文字列 | |
定員(補足) | capacity_ext | 文字列 | |
申し込み方法リスト | entry_list | リスト | 後述の「申し込み方法」データをリストで格納する |
その他備考など | note | 文字列 | |
関連URLリスト | rel_list | リスト | 後述の「関連URL」データをリストで格納する |
主催者 | organizer | 文字列 | |
問い合わせ先リスト | contact_list | リスト | 後述の「問い合わせ先」データをリストで格納する |
コンテンツURL | open_url | 文字列 | |
最終更新日時 | upd_date | 文字列 | yyyy-MM-dd HH:mm:ss形式の文字列 (例:2019-06-01 13:05:30) |
登録日 | created_date | 文字列 | yyyy-MM-dd HH:mm:ss形式の文字列 (例:2019-06-01 13:05:30) |
開催日
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
開催日 | date | 文字列 | yyyy-MM-dd形式の文字列(例:2019-06-01) |
開催時間(from) | time_from | 文字列 | HH:mm形式の文字列(例:13:05) |
開催時間(to) | time_to | 文字列 | HH:mm形式の文字列(例:13:05) |
開催日時例外 | time_ext | 文字列 | |
開催日(曜日) | date_w | 文字列 | 日曜日 月曜日 火曜日 水曜日 木曜日 金曜日 土曜日 |
申し込み方法
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
申し込み方法(from) | entry_from | 文字列 | yyyy-MM-dd形式の文字列 (例:2019-06-01) |
申し込み方法(to) | entry_to | 文字列 | yyyy-MM-dd形式の文字列 (例:2019-06-01) |
申し込み方法(電話) | entry_tel | 文字列 | |
申し込み方法(ファックス) | entry_fax | 文字列 | |
申し込み方法(メール) | entry_mail | 文字列 | |
申し込み方法(URL) | entry_url | 文字列 | |
申し込み方法(郵便番号) | entry_postcode | 文字列 | |
申し込み方法(宛先) | entry_post | 文字列 | |
申し込み方法(補足) | entry_ext | 文字列 | |
申し込み方法(from)曜日 | entry_from_w | 文字列 | 日曜日 月曜日 火曜日 水曜日 木曜日 金曜日 土曜日 |
申し込み方法(to)曜日 | entry_to_w | 文字列 | 日曜日 月曜日 火曜日 水曜日 木曜日 金曜日 土曜日 |
関連URL
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
関連URL(altテキスト) | rel_alt | 文字列 | |
関連URL(URL) | rel_url | 文字列 |
問い合わせ先
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
問い合わせ先 | contact | 文字列 | |
問い合わせ先(電話) | contact_tel | 文字列 | |
問い合わせ先(ファックス) | contact_fax | 文字列 | |
問い合わせ先(メール) | contact_mail | 文字列 | |
問い合わせ先(補足) | contact_ext | 文字列 |
エラーレスポンス
論理名 | 物理名 | 種別 | 説明 |
---|---|---|---|
ステータスコード | status | 整数 | 返却したステータスコードを示す |
メッセージ | message | 整数 | 発生したエラーのメッセージを示す |
エラーメッセージ一覧
status | message |
---|---|
400 | Invalid query string |
405 | Method not allowed |
500 | Internal server error |