イベント検索APIリファレンス
イー・モシコムではイベント情報を検索できるAPIを公開しています。
【注意事項】
・APIの仕様は予告なく変更される可能性があります。
・商用利用はお断りしております。
イベント募集(イベント、回数券等)リクエストURL
フォーマット | リクエストURL |
---|---|
xml | https://api.moshicom.com/api/events.xml |
json | https://api.moshicom.com/api/events.json |
随時募集(メンバー募集、施設募集等)リクエストURL
フォーマット | リクエストURL |
---|---|
xml | https://api.moshicom.com/api/plans.xml |
json | https://api.moshicom.com/api/plans.json |
パラメータ
パラメータ | 名前 | タイプ | 初期値 | 複数 | 備考 |
---|---|---|---|---|---|
event_id | イベントID | 数値 | - | ○ | イベントページのURLのxxxxがイベントIDとなります。 https://moshicom.com/xxxx/ |
prefecture_id | 都道府県ID | 数値 | - | ○ | 1 - 91 までの都道府県IDを指定 ※91 は海外となります。 ※下表参照 |
ym | 開催年月 | 数値 | - | ○ | yyyymm形式 例)201501 |
ym_between | 開催年月範囲 | 数値 | - | 2個 | yyyymm形式 例)201501,201505 |
ymd | 開催年月日 | 数値 | - | ○ | yyyymmdd形式 例)20150125 |
ymd_between | 開催年月日範囲 | 数値 | - | 2個 | yyyymmdd形式 例)20150320,20150505 |
owner_id | 主催者ID | 数値 | - | ○ | 主催者ページのURLのxxxxが主催者IDとなります。 https://moshicom.com/user/xxxx/ |
place | 会場名 | 文字列 | - | ○ | 会場名が公開されているイベントのみ 部分一致検索 |
keyword | キーワード(OR) | 文字列 | - | ○ | イベント名、概要、イベント内容から部分一致検索 |
keyword_and | キーワード(AND) | 文字列 | - | ○ | イベント名、概要、イベント内容から部分一致検索 |
entry_status | 申込ステータス | 数値 | - | ○ | 0:受付開始前、1:受付中、2:受付終了 |
start | 検索開始位置 | 数値 | 1 | - | 1以上 |
limit | 取得件数 | 数値 | 10 | - | 最大30 |
order | 並び順 | 文字列 | started_at_desc | - | 以下のキーワードが指定可能 started_at_asc:開催日昇順 started_at_desc:開催日降順 address_asc:住所昇順 address_desc:住所降順 |
サンプルクエリ
2016年1月と2月に開催される「マラソン」関連のイベントを5件取得
https://api.moshicom.com/api/events.json?ym=201601,201602&keyword=マラソン&limit=5
2016年3月20日から5月5日に開催されるイベントを取得
https://api.moshicom.com/api/events.json?ymd_between=20160320,20160505
関東で開催されるイベントをxml形式で取得
https://api.moshicom.com/api/events.xml?prefecture_id=8,9,10,11,12,13,14
レスポンス
フィールド | 名前 | 備考 |
---|---|---|
ReturnCode | リクエストコード | リクエストに対するステータスコード |
Request | イベント情報 | |
+- event_id | イベントID | |
+- prefecture_id | 都道府県ID | |
+- ym | 開催年月 | |
+- ym_between | 開催年月範囲 | |
+- ymd | 開催年月日 | |
+- ymd_between | 開催年月日範囲 | |
+- owner_id | 主催者ID | |
+- keyword | キーワード(OR) | |
+- keyword_and | キーワード(AND) | |
+- place | 会場名 | |
+- start | 検索開始位置 | |
+- limit | 取得件数 | |
+- offset | 検索開始位置 | |
+- order | 並び順 | |
Result | イベント情報 | |
+- total | 全体件数 | |
+- offset | 検索開始位置 | |
+- count | 検索件数 | |
+- items | 検索結果 | |
+- events | イベント情報 | |
+- event | [複数要素] | |
+- event_id | イベントID | |
+- title | イベント名 | |
+- summary | 概要 | |
+- contents | イベント内容 | ※HTML形式 |
+- image_path | イベント画像パス | |
+- valid | 申込有効期間 | 例)2017/1/7〜2017/1/8 例)申込月から3ヶ月間有効 |
+- started_at | イベント開催日時 | 例)2015-02-27T12:30:00+09:00 ※随時募集等の開催日がない場合は空を取得 |
+- ended_at | イベント終了日時 | 例)2015-02-27T12:30:00+09:00 ※随時募集等の開催日がない場合は空を取得 |
+- opened_at | 入場可能日時 | 例)2015-02-27T12:30:00+09:00 |
+- entry_started_at | 申込み受付開始日時 | 例)2015-02-27T12:30:00+09:00 |
+- entry_ended_at | 申込み受付終了日時 | 例)2015-02-27T12:30:00+09:00 |
+- cancel_at | キャンセル可能日時 | 例)2015-02-27T12:30:00+09:00 |
+- capacity | 定員 | 定員数が公開の場合のみ取得 |
+- event_url | モシコムのURL | |
+- url | 参考URL | |
+- payment_types | 支払い方法 | |
+- payment_type | [複数要素] | 会場払い、クレジット払い、コンビニ払い |
+- tickets | チケット情報 | |
+- ticket | [複数要素] | |
+- name | チケット名 | |
+- price | チケット料金 | |
+- cancel_policy | キャンセル規約 | |
+- prefecture_id | 都道府県ID | ※下表参照 |
+- address | 開催場所 | 開催場所が公開の場合のみ取得 ※非公開の場合は市区町村まで取得 |
+- place | 会場名 | 開催場所が公開の場合のみ取得 |
+- lat | 緯度 | 開催場所が公開の場合のみ取得 |
+- lng | 経度 | 開催場所が公開の場合のみ取得 |
+- accepted | 参加者数 | 参加者数が公開の場合のみ取得 |
+- waiting | キャンセル待ち数 | 参加者数が公開の場合のみ取得 |
+- categorie | スポーツ | |
+- league | リーグ | |
+- owners | 主催者情報 | |
+- owner | [複数要素] | |
+- id | 主催者ID | |
+- name | 主催者名 | |
+- url | 主催者URL | |
+- embed_code | 埋め込みコード | ※HTML形式 |
+- updated_at | 更新日時 | 例)2015-02-27T12:30:00+09:00 |
都道府県一覧 (JISコード準拠)
都道府県ID | 都道府県名 |
---|---|
1 | 北海道 |
2 | 青森県 |
3 | 岩手県 |
4 | 宮城県 |
5 | 秋田県 |
6 | 山形県 |
7 | 福島県 |
8 | 茨城県 |
9 | 栃木県 |
10 | 群馬県 |
11 | 埼玉県 |
12 | 千葉県 |
13 | 東京都 |
14 | 神奈川県 |
15 | 新潟県 |
16 | 富山県 |
17 | 石川県 |
18 | 福井県 |
19 | 山梨県 |
20 | 長野県 |
21 | 岐阜県 |
22 | 静岡県 |
23 | 愛知県 |
24 | 三重県 |
25 | 滋賀県 |
26 | 京都府 |
27 | 大阪府 |
28 | 兵庫県 |
29 | 奈良県 |
30 | 和歌山県 |
31 | 鳥取県 |
32 | 島根県 |
33 | 岡山県 |
34 | 広島県 |
35 | 山口県 |
36 | 徳島県 |
37 | 香川県 |
38 | 愛媛県 |
39 | 高知県 |
40 | 福岡県 |
41 | 佐賀県 |
42 | 長崎県 |
43 | 熊本県 |
44 | 大分県 |
45 | 宮崎県 |
46 | 鹿児島県 |
47 | 沖縄県 |
91 | 海外 |