API docs by Redocly

GeoLOD API (1.0.0)

Download OpenAPI specification:Download

GeoLODシステムに登録されている公開辞書と、そこに含まれる地名にアクセスするためのAPI。

リクエスト形式

URLクエリにおけるbooleanパラメータは、trueもしくはfalseの文字列で、それぞれ真と偽を表すものとする。 それ以外の値がセットされた場合、バリデーションエラーとなる。

Dictionary

公開辞書を検索する。

query Parameters
keywords
Array of strings

辞書名に対する部分一致を行うキーワード。複数指定した場合、OR検索を行う。

sort
string
Enum: "id" "name" "user" "created" "modified"
Examples: sort=id

ソート基準。

asc
boolean

ソート順。true falseがそれぞれ昇順、降順を示す。

limit
integer

取得件数。

offset
integer

取得オフセット。

Responses

Response samples

Content type
application/json
{}

公開辞書情報を取得する。

path Parameters
code
required
string

辞書コード。

query Parameters
pretty
boolean

trueの場合、JSON-LDタグ内のjsonがインデントされた形式となる。

Responses

Response samples

Content type
application/json
{
  • "code": "stations",
  • "name": "駅名辞書",
  • "landingUrl": "https://geolod.ex.nii.jp/stations.html",
  • "description": "日本の駅を含む辞書です。",
  • "source": "駅名データ",
  • "minLat": 35.69393,
  • "minLng": 139.75354,
  • "maxLat": 43.06417,
  • "maxLng": 141.34694,
  • "createdAt": "2021-01-01T00:00:00.000000+00:00",
  • "modifiedAt": "2021-01-01T00:00:00.000000+00:00",
  • "ldAltName": "日本の駅名",
  • "ldCreator": { },
  • "ldIdentifier": "GeoLOD-stations",
  • "ldLicense": { },
  • "minDate": "2019-08-24",
  • "maxDate": "2019-08-24",
  • "sourceUrl": "https://geolod.ex.nii.jp/stations-source.html",
  • "publicUrl": "https://geolod.ex.nii.jp/stations-public.csv",
  • "kind": { },
  • "geoCount": 0,
  • "jsonLd": "<script type=\"application/ld+json\">\n{\"@context\":\"https://schema.org\",...}\n</script>"
}

Geo

公開辞書に含まれる地名を検索する。

idまたはkeywordは排他関係でいずれかが必須。

キーワードは、接頭辞、原型、接尾辞を接続した文字列との部分一致を行う。また、use_variantをtrueとした場合、異表記も対象とする。

有効期間条件を指定した場合、地名に設定された期間とその期間が重なる地名に絞り込む。 始点や終点の設定されていない地名は、その時間方向について無限に有効な地名と見なす。

エリア検索は、centerLat centerLng distance の全てのクエリパラメータが必要。 いずれかが指定されて、他が指定されていない場合、バリデーションエラーとなる。 distance による中心地点からのソートは、これらのクエリが揃っている場合に有効となり、それ以外は無視される。

query Parameters
id
Array of strings or null

GeoLOD-ID。複数指定可能。

limit
integer

取得件数。

offset
integer

取得オフセット。

keyword
Array of strings or null

地名の属性に対して部分一致検索を行うキーワード。複数指定した場合、OR検索を行う。

matching
string
Enum: "partial" "prefix" "suffix"
Examples: matching=partial

キーワード検索のマッチング方法。

sort
string
Enum: "id" "body" "class" "kana" "distance" "lat" "lng"
Examples: sort=id

ソート基準。

asc
boolean

ソート順。true falseがそれぞれ昇順、降順を示す。

validFrom
string <date>

有効期間(始点)。YYYY-MM-DD形式。

validTo
string <date>

有効期間(終点)。YYYY-MM-DD形式。

dictionary
Array of strings or null

地名の含まれる辞書コード。複数指定可能。

neClass
Array of strings or null

固有名クラス。固有名クラスに対して部分一致検索を行う。複数指定した場合、OR検索を行う。

useVariant
boolean

異表記をキーワード検索の対象とするフラグ。

useKana
boolean

かなをキーワード検索の対象とするフラグ。

useHypernym
boolean

上位語をキーワード検索の対象とするフラグ。

centerLat
number or null

検索エリアの中心緯度。

centerLng
number or null

検索エリアの中心経度。

distance
number or null

検索エリアの半径(m)。

Responses

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ],
  • "total": 0
}

GeoLOD-IDから地名情報を取得する。

path Parameters
geolod_id
required
string

GeoLOD-ID。

Responses

Response samples

Content type
application/json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}