コンテンツにスキップ
風土記
Esc
↑↓移動↵開く⌘Jプレビュー

団体と収録範囲

団体(自治体)の名称・6桁の団体コード・都道府県と、その団体の収録範囲(明細を検索できる年度・資料区分・会計と、明細の出典の原典の標題・URL)を返す。歳出を検索する前に、団体コードと、比べたい年度・資料区分が収録されているかをここで確かめる。名称(部分一致)か団体コード(5桁・6桁)で絞り、絞らなければ全団体を団体コード順に返す。収録の無い団体は coverage が空。返った jurisdiction_code(6桁)・fiscal_year・document_kind・account_name は search_expenditure_nodes の条件にそのまま使える。検索は5桁のコードを受け付けず0件になるので、ここで6桁を引いてから渡す。名前とコードの両方を渡すと AND。

GET/v1/jurisdictions
Query parameters
namestring

団体名の部分一致(例: "武蔵野市"、"府中")。全角・半角の違いは NFKC で揃えて比べる。同名の団体はすべて返るので、prefecture_name と jurisdiction_code で区別する。

max length 50 · matches ^[^\u0000-\u001f\u007f]*$
codestring

全国地方公共団体コード。6桁(末尾は検査数字)でも、検査数字を除いた5桁でもよい。

matches ^[0-9]{5,6}$
page_tokenstring

前回の応答の next_page_token。name と code は前回と同じにする。

max length 512 · matches ^[A-Za-z0-9_-]*$
page_sizeinteger

1ページの団体の数(1〜100、既定 20)。

min 1 · max 100 · default: 20
Responses
200

成功

jurisdictionsJurisdiction[]required

団体コードの昇順。

Show properties
Array of Jurisdiction
jurisdiction_codestringrequired

全国地方公共団体コード(6桁、末尾は検査数字)。木の表・origin の jurisdiction_code と同じ値。検査数字を除いた先頭5桁でも一意に決まる。

namestringrequired

団体の名称(例:武蔵野市)。全国では一意でない(府中市は東京都と広島県にある)ので、都道府県と合わせて区別する。

prefecture_codestringrequired

都道府県コード(JIS X 0401)。団体コードの先頭2桁。

prefecture_namestringrequired

都道府県の名称。団体マスタには無いので、団体コードの先頭2桁から引いた値。

ocd_idstringrequired

Open Civic Data 形式の識別子。OCD の本家に未登録の市区町村は、同じ形式で風土記が定めた値。

coverageCoverage[]required

収録範囲(年度の昇順、同じ年度は当初予算・決算の順)。空なら、この団体の明細は収録していない。明細があることを示し、会計全体・全事業を収録し終えたことは保証しない。

Show properties
Array of Coverage
fiscal_yearintegerrequired

会計年度(西暦)。木の表の fiscal_year。

document_kindstringrequired

資料区分。settlement は決算(金額は支出済額)、initial は当初予算(金額は当初予算額)。意味の違う金額を足さない。

Allowed:settlementinitial
accountsobject[]required

明細がある会計。一般会計が先。

Show properties
Array of object
account_namestringrequired

原典の会計名。木の表の account_name と同じ値で、明細の検索の条件にそのまま使える。

account_kindstringrequired

団体共通の会計の種類。木の表の account_kind(風土記の判断)。

originsCoverageOrigin[]required

この会計の明細が指す原典すべて。

Show properties
Array of CoverageOrigin
origin_idstringrequired

原典ファイルを指すSHA由来のID。木の表の origin_id が指す。

titlestringrequired

原典の資料名(前後の空白を除いたもの)。

urlstringrequired

原典の公開URL。

formatstringrequired

原典の形式(pdf か csv)。

next_page_tokenstring | nullrequired

次のページの token。無ければ null。位置は 100000 件目までで、それ以上は null になるので、条件を絞って問い合わせる。

400

入力が不正

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
404

見つからない

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
503

提供を止めている

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
Request
curl -X GET 'https://api.fudoki.dev/v1/jurisdictions' \
  -H 'Accept: application/json'
Response
{
  "jurisdictions": [
    {
      "jurisdiction_code": "string",
      "name": "string",
      "prefecture_code": "string",
      "prefecture_name": "string",
      "ocd_id": "string",
      "coverage": [
        {
          "fiscal_year": 0,
          "document_kind": "settlement",
          "accounts": [
            {
              "account_name": "string",
              "account_kind": "string",
              "origins": [
                {
                  "origin_id": "string",
                  "title": "string",
                  "url": "string",
                  "format": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "next_page_token": "string"
}

このページは役に立ちましたか?