郡山市オープンデータ非公式WebAPI

概要

福島県郡山市が公開するオープンデータの一部をjson形式で返すWebAPIです。

API Endpoint https://koriyama.api.alflag.org/
SSL Support
Available HTTP Method GET
Response format json

注意事項

  • API Endpointへアクセスした時点で、本ページに書かれた全ての内容を理解・同意しているものとみなします。
  • 提供されるAPIは全て非公式です。
  • 本APIは郡山市役所と関係ありません。
  • 本APIを利用した場合の損害について一切の責任を負いません。
  • 本APIから取得できたデータの完全性・正確性・有用性・安全性等について一切の保証を行いません。
  • 本APIは事前に予告なく内容等の改変や削除、サービス停止を行う可能性があります。
  • 本APIから提供される情報は、郡山市役所が公開するオープンデータを改変したものです。
  • 本APIから提供される情報は、CC BY 4.0が適用されます。
  • 本APIから取得した情報を利用する場合、郡山市役所が公開する郡山市オープンデータ利用規約に従う必要があります。
  • 本APIへの過度なリクエストは避けてください。

利用方法

レスポンスヘッダーのContent-Typeについて

レスポンスヘッダーのContent-Typeは application/json; charset=UTF-8 となっています。エラー発生時も同様です。

エラー

本APIのエラーはエラーメッセージとサーバが受け取ったリクエスト内容で表現されています。

Bad Request

リクエストされた内容が正しくないときに発生します。レスポンスヘッダーのステータスは 200 OK です。

{
  "error": {
    "message": "Bad Request",
    "request": {
      "method":"GET",
      "id": "",
      "url":""
    }
  }
}

Not Found

指定されたURLに該当するAPIが存在しないときに発生します。レスポンスヘッダーのステータスは 200 OK です。

{
  "error": {
    "message": "Not Found",
    "request": {
      "method":"GET",
      "url":""
    }
  }
}

API

郡山市役所ウェブサイトの「オープンデータの公共施設等情報」「オープンデータのその他の情報」で公開されているファイルの内容をjson形式で取得できます。

v1/{id} で全てを取得できます。 {id} には「オープンデータの公共施設等情報」「オープンデータのその他の情報」上で公開されているファイル名が入ります。以下は、idの早見表です。

1603 「市民提案制度」提案等と対応状況(平成29年度分)
1604 「市民提案制度」提案等と対応状況(平成28年度分)
1605 「ココナビこおりやま」年度別月別件数
1606 鯉の生産量
1607 鯉料理提供店舗数
1705 市の行政サービス
1706 ふれあいセンター・コミュニティセンター
1707 公民館
1708 保健所
1709 病院
1710 福祉・子育て支援施設
1711 働く人のための施設
1712 上下水道局
1713 衛生
1714 霊園
1715 火葬場
1716 消防
1717 郡山水防センター
1718 保育所(認可保育所)
1719 その他の私立保育園
1720 幼稚園(私立幼稚園)
1721 小学校
1722 中学校
1723 文化・教育・社会施設
1724 スポーツ施設
1725 観光・産業施設
1726 市営住宅
1727 AED設置施設
1728 Wi-Fi設置施設
1729 オストメイト対応トイレ設置施設

APIから返される全てのjsonは、以下のフォーマットに基づいています。

{
    "last_updated": {time},
    "name": {name},
    "id": {id},
    "original_url": {url},
    "data": []
}

last_updated には内容が最後に更新された日時が入っています。

name には「オープンデータの公共施設等情報」上の分類名が入っています。

id には「オープンデータの公共施設等情報」で公開されているcsvのファイル名が入っています。

original_url には元データの取得元URLが入っています。

data には、取得されたcsvに基づいて生成された配列が入っています。元データが整形されている場合、data は返されません。

更新履歴

2022/07/17

  • /v1/1603 を追加
  • /v1/1604 を追加
  • /v1/1605 を追加
  • /v1/1606 を追加
  • /v1/1607 を追加