メッシュ検索API

TOP > API > メッシュ検索API

メッシュ検索API

指定した領域に含まれる250mメッシュの中から、指定した条件を満たす250mメッシュの表層地盤情報を提供します。

バージョン

1.0.0

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/meshsearch?meshcode=meshcode&format=format&filter=filter&radius=radius&options

https://www.j-shis.bosai.go.jp/map/api/meshcode/meshsearch?format=format&filter=filter&radius=radius&options

https://www.j-shis.bosai.go.jp/map/api/meshsearch?center=center&epsg=epsg&format=format&filter=filter&radius=radius&options

リクエスト

– URL

– メッシュコード指定

– 経度緯度指定

– パラメータ

レスポンス

– ステータスコード

– 正常ケース

– GeoJSON形式

– レスポンスサンプル

– GML形式

– レスポンスサンプル

– エラーケース

– エラー分類コード

– GeoJSON形式

– レスポンスサンプル

– GML形式

– レスポンスサンプル

リクエスト

URL

位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。

メッシュコード指定

https://www.j-shis.bosai.go.jp/map/api/meshsearch?meshcode=meshcode¹&format=format⁴&filter=filter⁵&radius=radius⁶&options⁷

https://www.j-shis.bosai.go.jp/map/api/meshcode¹/meshsearch?format=format⁴&filter=filter⁵&radius=radius⁶&options⁷

経度緯度指定

https://www.j-shis.bosai.go.jp/map/api/meshsearch?center=center²&epsg=epsg³&format=format⁴&filter=filter⁵&radius=radius⁶&options⁷

パラメータ

APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。

No	パラメータ	省略可否	説明
1	meshcode	centerと排他的	250mメッシュコード詳細はこちらを参照して下さい。注) centerもしくはepsgが指定された場合はエラーとなります。
2	center	meshcodeと排他的	検索中心の経度と緯度をコンマ区切りで指定します。指定可能範囲は以下の通りです。 122.0≦経度≦154.0 20.0≦緯度≦47.0 注1) epsg指定時は必須です。注2) meshcodeが指定された場合はエラーとなります。
3	epsg	meshcodeと排他的	EPSGコード JGD2000…4612 Tokyo…4301 WGS84…4326 注1) center指定時は必須です。注2) meshcodeが指定された場合はエラーとなります。
4	format	必須	出力形式 GeoJSON形式…geojson GML形式…gml
5	filter	必須	条件式形式：[attribute]_[operator]_[value] attribute…表層地盤属性コードを指定します。 operator…lt, gt, eq, le, ge, neの演算子から指定します。 value…attributeの右辺値を指定します。例：JCODE_lt_15 ⇒JCODEが15より小さいメッシュを検索
6	radius	必須	検索半径をkm単位で指定します。指定可能範囲…10km以内
7	version	省略可	表層地盤データのバージョンコードバージョン1…V1 バージョン2…V2 バージョン3…V3 バージョン4…V4 詳細はバージョンコード一覧を参照して下さい。省略した場合…最新バージョン
7	order	省略可	ソート条件複数条件の場合はコンマ区切りで記述します。形式：[属性]+[ソート方法],[属性]+[ソート方法],… 属性…表層地盤属性コードまたは距離（DIST）ソート方法昇順…ASC 降順…DESC 注1) ソート属性省略時…filterで指定した属性、メッシュコードの順でソート注2) ソート方法省略時…ASC 注3) メッシュコードによるソート…常にASC 例：JCODE+DESC,AVS ⇒JCODEの降順, AVSの昇順, メッシュコードの昇順の順にソート
7	limit	省略可	取得件数省略した場合…検索結果全てを取得します。
7	offset	省略可	検索結果のオフセット省略した場合…0
7	lang	省略可	レスポンスの言語日本語…ja 英語…en 省略した場合…ja

バージョンコードの一覧を以下に示します。

バージョンコード	概要
V1	2005年～2008年の「確率論的地震動予測地図」で使用した、3 次メッシュ単位データを16分割し250m メッシュ単位に変換したデータ
V2	2009年の「全国地震動予測地図」で使用した、250mメッシュ単位データ
V3	2014年の「全国地震動予測地図」で使用した、250mメッシュ単位データ
V4	2020年の「全国地震動予測地図」で使用した、250mメッシュ単位データ

表層地盤属性コードの一覧を以下に示します。

属性名	出力形式	説明
JCODE	%2d	微地形分類コード基準年により分類区分が異なるので注意して下さい。詳細はJ-SHISデータ規約集の「表層地盤データ記述ファイル規約」を参照して下さい。
AVS	%5.1f	表層30mの平均S波速度（m/s）
ARV	%9.4f	工学的基盤（Vs=400m/s）から地表に至る最大速度の増幅率
AVS_EB	%5.1f	詳細法工学的基盤面深さ30mの平均S波速度。値が定義されていないメッシュは「-」となります。注)バージョン４のみの属性です。
AVS_REF	%d	表層30mの平均S波速度出典番号 0の場合若松・松岡(2020)：地形・地盤分類250m メッシュマップの更新, 日本地震工学会誌, No.40,pp.24-27 1の場合 Senna et al. (2013) (DOI) およびSenna et al. (2019) (DOI) 注)バージョン４のみの属性です。

レスポンス

ステータスコード

データを正常に取得した場合は、HTTPステータスコードに200を設定し、正常ケースのレスポンスを返します。エラーが発生した場合は、以下のHTTPステータスコードを設定し、エラーケースのレスポンスを返します。

HTTPステータスコード	説明
400	Bad Request	リクエストURLに間違いがあることを示します。例：サポートされていない値を設定した。
403	Forbidden	リクエストが拒否されたことを示します。例：リクエストの上限を超えた。
404	Not Found	リクエストに一致するデータが1件も存在しないことを示します。例：存在しないメッシュコードを指定した。
500	Internal Server Error	内部エラーが発生したことを示します。
503	Service Unavailable	サービスが一時的に利用不可であることを示します。例：DBへの接続に失敗した。

正常ケース

GeoJSON形式

GeoJSON形式のレスポンスは以下の通りです。

タグ			説明
type			GeoJSONオブジェクトタイプ FeatureCollection（固定値）
crs			GeoJSON 座標参照系オブジェクト座標参照系情報
status			ステータス Success（固定値）
features			メンバー要素メッシュ矩形ジオメトリとその属性値の配列
	type		GeoJSONオブジェクトタイプ Feature（固定値）
	geometry		メッシュ矩形のジオメトリ情報
	properties		ジオメトリの属性値を含むオブジェクト
		meshcode	250mメッシュコード詳細はこちらを参照して下さい。
		JCODE	微地形分類コード詳細は表層地盤属性コード一覧を参照して下さい。
		JNAME	微地形区分名詳細はJ-SHISデータ規約集の「表層地盤データ記述ファイル規約」を参照して下さい。
		AVS	表層30mの平均S波速度（m/s）詳細は表層地盤属性コード一覧を参照して下さい。
		ARV	工学的基盤（Vs=400m/s）から地表に至る最大速度の増幅率詳細は表層地盤属性コード一覧を参照して下さい。
		AVS_EB	詳細法工学的基盤面深さ30mの平均S波速度詳細は表層地盤属性コード一覧を参照して下さい。
		AVS_REF	表層30mの平均S波速度出典分類番号詳細は表層地盤属性コード一覧を参照して下さい。
metaData			メタ情報
	meshcode		250mメッシュコード詳細はこちらを参照して下さい。
	filter		検索に使用した検索条件
	version		バージョンコード
	center		検索中心経度緯度
	radius		検索半径
		unit	検索半径の単位
		value	検索半径の値
	order		ソート条件
		attr	ソート属性
		direction	ソート方法昇順…ASC 降順…DESC
	attr		表層地盤属性
		name	表層地盤属性コード詳細は表層地盤属性コード一覧を参照して下さい。
		unit	表層地盤属性値の単位
	offset		検索オフセット
	total		検索結果総数

以下の例はGeoJSON形式レスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/5339358942N/meshsearch?format=geojson&filter=JCODE_lt_15&radius=10&limit=5&order=DIST

GeoJSON形式レスポンス

{
    "type": "FeatureCollection",
    "crs": {
        "type": "name",
        "properties": {
            "name": "urn:ogc:def:crs:EPSG:4301"
        }
    },
    "status": "Success",
    "features": [
        {
            "type": "Feature",
            "geometry": {
                "coordinates": [[
                        [139.74687, 35.65417],
                        [139.74687, 35.65625],
                        [139.75,35.65625],
                        [139.75,35.65417],
                        [139.74687,35.65417]
                    ]],
                "type": "Polygon"
            },
            "properties": {
                "meshcode": "5339358942N",
                "JCODE": "9",
                "JNAME": "ローム台地",
                "AVS": "246.9",
                "ARV": "1.5083"
            }
        },
        {
            "type": "Feature",
            "geometry": {
                "coordinates": [[
                        [139.74687,35.65208],
                        [139.74687,35.65417],
                        [139.75, 35.65417],
                        [139.75,35.65208],
                        [139.74687,35.65208]
                    ]],
                "type": "Polygon"
            },
            "properties": {
                "meshcode": "5339358924N",
                "JCODE": "10",
                "JNAME": "谷底低地",
                "AVS": "187.7",
                "ARV": "1.9057"
            }
        },
        {
            "type": "Feature",
            "geometry": {
                "coordinates": [[
                        [139.74687,35.65625],
                        [139.74687,35.65833],
                        [139.75,35.65833],
                        [139.75,35.65625],
                        [139.74687,35.65625]
                    ]],
                "type": "Polygon"
            },
            "properties": {
                "meshcode": "5339358944N",
                "JCODE": "9",
                "JNAME": "ローム台地",
                "AVS": "246.9",
                "ARV": "1.5083"
            }
        },
        {
            "type": "Feature",
            "geometry": {
                "coordinates": [[
                        [139.75,35.65417],
                        [139.75,35.65625]
                        [139.75313,35.65625],
                        [139.75313,35.65417],
                        [139.75,35.65417]
                    ]],
                "type": "Polygon"
            },
            "properties": {
                "meshcode": "5339368031N",
                "JCODE": "9",
                "JNAME": "ローム台地",
                "AVS": "194.7",
                "ARV": "1.8468"
            }
        },
        {
            "type": "Feature",
            "geometry": {
                "coordinates": [[
                        [139.74375,35.65417],
                        [139.74375,35.65625],
                        [139.74687,35.65625],
                        [139.74687,35.65417],
                        [139.74375,35.65417]
                    ]],
                "type": "Polygon"
            },
            "properties": {
                "meshcode": "5339358941N",
                "JCODE": "9",
                "JNAME": "ローム台地",
                "AVS": "246.9",
                "ARV": "1.5083"
            }
        }
    ],
    "metaData": {
        "meshcode": [
            "5339358942N",
            "5339358924N",
            "5339358944N",
            "5339368031N",
            "5339358941N"
        ],
        "filter": "JCODE_lt_15",
        "version": "V2",
        "center": "139.7484375,35.65520833",
        "radius": {
            "unit": "km",
            "value": "10"
        },
        "order": [
            {
                "attr": "DIST",
                "direction": "ASC"
            }
        ],
        "attr": [
            {
                "name": "ARV",
                "unit": ""
            },
            {
                "name": "AVS",
                "unit": "m/s"
            },
            {
                "name": "JCODE",
                "unit": ""
            },
            {
                "name": "JNAME",
                "unit": ""
            }
        ],
        "offset": "0",
        "total": "5"
    }
}

GML形式

GML形式のレスポンスは以下の通りです。

タグ				説明
gml: boundedBy				レスポンスに含まれる全ジオメトリのバウンディングボックス
gml: featureMember				メンバー要素
	jshis: mesh			メッシュ
		gml: coverage		メッシュ矩形のジオメトリ情報
		jshis: meshcode		250mメッシュコード詳細はこちらを参照して下さい。
		jshis: JCODE		微地形分類コード詳細は表層地盤属性コード一覧を参照して下さい。
		jshis: JNAME		微地形区分名詳細はJ-SHISデータ規約集の「表層地盤データ記述ファイル規約」を参照して下さい。
		jshis: AVS		表層30mの平均S波速度（m/s）詳細は表層地盤属性コード一覧を参照して下さい。
		jshis: ARV		工学的基盤（Vs=400m/s）から地表に至る最大速度の増幅率詳細は表層地盤属性コード一覧を参照して下さい。
		jshis: AVS_EB		詳細法工学的基盤面深さ30mの平均S波速度詳細は表層地盤属性コード一覧を参照して下さい。
		jshis: AVS_REF		表層30mの平均S波速度出典分類番号詳細は表層地盤属性コード一覧を参照して下さい。
jshis: status				ステータス Success（固定値）
jshis: metaData				メタ情報
	jshis: meshcodes			メッシュコードの配列
		jshis: meshcode		250mメッシュコード詳細はこちらを参照して下さい。
	jshis: filter			検索条件
	jshis: version			バージョンコード
	jshis: center			中心経度緯度
	jshis: radius			検索半径情報
		jshis: value		検索半径の値
		jshis: unit		単位
	jshis: orders			ソート形式配列
		jshis: order		ソート形式要素
			jshis: attr	ソート属性
			jshis: direction	ソート方法昇順…ASC 降順…DESC
	jshis: offset			検索オフセット
	jshis: total			検索結果総数
	jshis: attrs			表層地盤属性配列
		jshis: attr		表層地盤属性
			jshis: name	表層地盤属性コード詳細は表層地盤属性コード一覧を参照して下さい。
			jshis: unit	表層地盤属性値の単位

以下の例はGML形式レスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/meshsearch?format=gml&meshcode=5339358942N&filter=JCODE_ge_16&radius=10&limit=2&order=JCODE,DIST

GML形式レスポンス

<?xml version="1.0" encoding="utf-8"?>
<jshis:MeshSearch xmlns:gml="http://www.opengis.net/gml"
 xmlns:jshis="http://www.j-shis.bosai.go.jp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.j-shis.bosai.go.jp http://www.j-shis.bosai.go.jp/map/xsd/gml-v2.1.2/meshsearch-v1.0.xsd">
    <gml:boundedBy>
        <gml:Box srsName="urn:ogc:def:crs:EPSG:4301">
            <gml:coord>
                <gml:X>139.74687</gml:X>
                <gml:Y>35.64792</gml:Y>
            </gml:coord>
            <gml:coord>
                <gml:X>139.75313</gml:X>
                <gml:Y>35.65208</gml:Y>
            </gml:coord>
        </gml:Box>
    </gml:boundedBy>
    <gml:featureMember>
        <jshis:mesh>
            <gml:coverage>
                <gml:Polygon srsName="urn:ogc:def:crs:EPSG:4301">
                    <gml:outerBoundaryIs>
                        <gml:LinearRing>
                            <gml:coordinates>139.75,35.65 139.75,35.65208 139.75313,35.65208 139.75313,35.65 139.75,35.65 </gml:coordinates>
                        </gml:LinearRing>
                    </gml:outerBoundaryIs>
                </gml:Polygon>
            </gml:coverage>
            <jshis:meshcode>5339368011N</jshis:meshcode>
            <jshis:JCODE>16</jshis:JCODE>
            <jshis:JNAME>砂州・砂礫州</jshis:JNAME>
            <jshis:AVS>260.2</jshis:AVS>
            <jshis:ARV>1.4425</jshis:ARV>
        </jshis:mesh>
    </gml:featureMember>
    <gml:featureMember>
        <jshis:mesh>
            <gml:coverage>
                <gml:Polygon srsName="urn:ogc:def:crs:EPSG:4301">
                    <gml:outerBoundaryIs>
                        <gml:LinearRing>
                            <gml:coordinates>139.74687,35.64792 139.74687,35.65 139.75,35.65 139.75,35.64792 139.74687,35.64792 </gml:coordinates>
                        </gml:LinearRing>
                    </gml:outerBoundaryIs>
                </gml:Polygon>
            </gml:coverage>
            <jshis:meshcode>5339357944N</jshis:meshcode>
            <jshis:JCODE>16</jshis:JCODE>
            <jshis:JNAME>砂州・砂礫州</jshis:JNAME>
            <jshis:AVS>260.2</jshis:AVS>
            <jshis:ARV>1.4425</jshis:ARV>
        </jshis:mesh>
    </gml:featureMember>
    <jshis:status>Success</jshis:status>
    <jshis:metaData>
        <jshis:meshcodes>
            <jshis:meshcode>5339368011N</jshis:meshcode>
            <jshis:meshcode>5339357944N</jshis:meshcode>
        </jshis:meshcodes>
        <jshis:filter>JCODE_ge_16</jshis:filter>
        <jshis:version>V2</jshis:version>
        <jshis:center>139.7484375,35.65520833</jshis:center>
        <jshis:radius>
            <jshis:value>10</jshis:value>
            <jshis:unit>km</jshis:unit>
        </jshis:radius>
        <jshis:orders>
            <jshis:order>
                <jshis:attr>JCODE</jshis:attr>
                <jshis:direction>ASC</jshis:direction>
            </jshis:order>
            <jshis:order>
                <jshis:attr>DIST</jshis:attr>
                <jshis:direction>ASC</jshis:direction>
            </jshis:order>
        </jshis:orders>
        <jshis:offset>0</jshis:offset>
        <jshis:total>2</jshis:total>
        <jshis:attrs>
            <jshis:attr>
                <jshis:name>ARV</jshis:name>
                <jshis:unit/>
            </jshis:attr>
            <jshis:attr>
                <jshis:name>AVS</jshis:name>
                <jshis:unit>m/s</jshis:unit>
            </jshis:attr>
            <jshis:attr>
                <jshis:name>JCODE</jshis:name>
                <jshis:unit/>
            </jshis:attr>
            <jshis:attr>
                <jshis:name>JNAME</jshis:name>
                <jshis:unit/>
            </jshis:attr>
        </jshis:attrs>
    </jshis:metaData>
</jshis:MeshSearch>

エラーケース

エラー分類コード

エラー分類コードは以下の通りです。

分類コード	説明
INVALID_REQUEST	指定したリクエストに誤りがある。
DB_CONNECT_ERROR	DBに関するエラーが発生した。
UNKNOWN_ERROR	未定義のエラーが発生した。
NOT_FOUND	該当するデータが存在しない。

GeoJSON形式

GeoJSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。

タグ		説明
type		GeoJSONオブジェクトタイプ FeatureCollection（固定値）
status		ステータス Error（固定値）
features		空の配列
error		エラー情報
	code	エラー分類コード
	message	エラー内容を示すメッセージ

以下の例はGeoJSON形式エラーレスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/5339358942N/meshsearch?format=geojson&filter=JCODE_lt_15&radius=20&limit=5&order=DIST

GeoJSON形式エラーレスポンス

{
    "type": "FeatureCollection",
    "status": "Error",
    "features": [
        {
            "geometry": {
                "coordinates": [
                    []
                ]
            }
        }
    ],
    "error": {
        "code": "INVALID_REQUEST",
        "message": "Set 0 < radius <= 10 for option [radius]"
    }
}

GML形式

GML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。

タグ		説明
gml: boundedBy		null要素 <gml:null>unknown</gml:null> （固定値）
gml: featureMember		空の配列
jshis: status		ステータス Error（固定値）
jshis: error		エラー情報
	jshis: code	エラー分類コード
	jshis: message	エラー内容を示すメッセージ

以下の例はGML形式エラーレスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/meshsearch?format=gml&meshcode=5339358942N&filter=JCODE_aa_16&radius=10&limit=2&order=JCODE,DIST

GML形式エラーレスポンス

<?xml version="1.0" encoding="utf-8"?>
<jshis:MeshSearch xmlns:gml="http://www.opengis.net/gml"
 xmlns:jshis="http://www.j-shis.bosai.go.jp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.j-shis.bosai.go.jp http://www.j-shis.bosai.go.jp/map/xsd/gml-v2.1.2/meshsearch-v1.0.xsd">
    <gml:boundedBy>
        <gml:null>unknown</gml:null>
    </gml:boundedBy>
    <gml:featureMember/>
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>INVALID_REQUEST</jshis:code>
        <jshis:message>Supprted options for [filter.operator] are : eq / ge / gt / le / lt / ne </jshis:message>
    </jshis:error>
</jshis:MeshSearch>

カテゴリー : API | タグ : 表層地盤　

TOP > API > メッシュ検索API

J-SHIS | 地震ハザードステーション