海洋速報 v2
⽇本周辺の⿊潮などの海流の状況
詳細︓https://www.msil.go.jp/meta/10038j.pdf
Base URLs:
https://api.msil.go.jp/quick-bulletin/v2

Authentication
API Key (apiKeyHeader)Parameter Name: Ocp-Apim-Subscription-Key, in: header.
API Key (apiKeyQuery)Parameter Name: subscription-key, in: query.

Default
GET /MapServer/
説明
このAPIの情報を返します。
Example responses
200 Response{"name": "海洋速報（海流図）","description": "⽇本周辺の⿊潮などの海流の状況"}

401 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to includesubscription key when making requests to an API."}429 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

500 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

Responses
StatusMeaning

Description

Schema200

OK

APIの情報を返します。

description

401

Unauthorized

サブスクリプションキーがありません。

error_code

リクエストが集中しています。

error_code

429

500

Too ManyRequests

ArcGIS REST API の レスポンスコードも参照してください。

InternalServer Error

https://developers.arcgis.com/rest/services-

error_code

reference/enterprise/output-formats.htm

query
GET /MapServer/{LayerSelection}/query
JSON出⼒
地理情報を出⼒します。 ⼀度の応答で出⼒できる地理情報レコードは1000レコードです。 クエリーパラメータで条件を指定して出⼒レコード数を調整して下さい。

Parameters
Name

InTypeRequired

Description
ジオメトリ番号を⼊⼒します。6は⿊潮、7は津軽暖

LayerSelection

path

integertrue

流、8は対⾺暖流、9は宗⾕暖流に対応します。デフ
ォルトは6です。

Name

InTypeRequired

Description

f

query

stringfalse

出⼒形式を指定します。

where

query

stringfalse

フィールドの内容で条件を絞ります。

geometry

query

stringfalse空間フィルターとして適⽤するジオメトリです。
ジオメトリ パラメータで指定されたジオメトリのタ

geometryType

query

stringfalse

イプ。ジオメトリ タイプは、エンベロープ、ポイント、ライン、またはポリゴンです。デフォルトのジオメトリ タイプはエンベロープです。

inSR

query

stringfalse

⼊⼒ジオメトリの空間参照。
クエリの実⾏中に⼊⼒ジオメトリに適⽤される空間

spatialRel

query

stringfalse

関係。サポートされている空間関係には、交差、包含、エンベロープ交差、内などがあります。デフォルトの空間関係は交差(esriSpatialRelIntersects)です。

distancequery

string

false

units

query

string

false

time

query

stringfalse

returnGeometryquerybooleanfalse

距離検索条件です。
距離の単位です。距離検索で指定する距離の単位を⼊⼒します。
時間検索条件です。
APIの応答内容にジオメトリ情報を含めるかを設定します。

Detailed descriptions
f: 出⼒形式を指定します。 デフォルトはjsonです。
where: フィールドの内容で条件を絞ります。 このパラメータが指定されていない場合、全ての内容を取り出します。
geometry: 空間フィルターとして適⽤するジオメトリです。 ジオメトリの構造は、ArcGIS REST API によって返されるJSON ジオメトリ オブジェクトの構造と同じです。 エンベロープとポイントの JSON 構造に加えて、より単純なカンマ区切りの構⽂でジオメトリを指定できます。 例: bbox=135.0,35.0,136.0,40.0
inSR: ⼊⼒ジオメトリの空間参照。 空間参照は、既知の ID または空間参照 JSON オブジェクトとして指定できます。 inSRが指定されていない 場合、ジオメトリはマップの空間参照にあると⾒なされます。
distance: 距離検索条件です。 基点の経緯度と距離をカンマ区切りで3点⼊⼒します。 距離の単位はunitsで設定できます。デフォルトはメートルです。 例: distance=135.0,35.0,100.0
time: 時間検索条件です。 1970年1⽉1⽇からの経過ミリ秒で期間の開始と終了を指定します。 例:
time=1199145600000, 1230768000000
returnGeometry: APIの応答内容にジオメトリ情報を含めるかを設定します。 メタ情報のみ必要な場合はfalseに設定してください。 デフォルトはtrueです。

Enumerated Values
Parameter

Value

LayerSelection

6

LayerSelection

7

LayerSelection

8

LayerSelection

9fjsonfgeojsongeometryType

esriGeometryPoint

geometryType

esriGeometryMultipoint

geometryType

esriGeometryPolyline

geometryType

esriGeometryPolygon

geometryType

esriGeometryEnvelope

spatialRel

esriSpatialRelIntersects

spatialRel

esriSpatialRelContains

spatialRelesriSpatialRelCrosses

spatialRel

esriSpatialRelEnvelopeIntersects

spatialRel

esriSpatialRelIndexIntersects

spatialRel

esriSpatialRelOverlaps

spatialRel

esriSpatialRelTouches

spatialRel

esriSpatialRelWithin

spatialRel

esriSpatialRelRelation

units

esriSRUnit_Meter

units

esriSRUnit_StatuteMileunits

esriSRUnit_Foot

units

esriSRUnit_Kilometer

units

esriSRUnit_NauticalMile

units

esriSRUnit_USNauticalMile

returnGeometry

true

returnGeometryfalse

Example responses
200 Response{"displayFieldName": "解析対象⽇","fieldAliases": {"解析対象⽇": "解析対象⽇","速報発⾏⽇": "速報発⾏⽇","速報号数": "速報号数","海流の種別": "海流の種別"},"geometryType": "esriGeometryPolyline","spatialReference": {"wkid": 4326,"latestWkid": 4326},
"fields": [{"name": "解析対象⽇","type": "esriFieldTypeString","alias": "解析対象⽇","length": 254},{"name": "速報発⾏⽇","type": "esriFieldTypeString","alias": "速報発⾏⽇","length": 254},{"name": "速報号数","type": "esriFieldTypeString","alias": "速報号数","length": 254},{"name": "海流の種別","type": "esriFieldTypeString","alias": "海流の種別","length": 254}],
"features": [{"attributes": {"解析対象⽇": "R5(2023)/03/01","速報発⾏⽇": "R5(2023)/03/02","速報号数": "R5年第040号","海流の種別": "⿊潮"},"geometry": {"paths": [[[
121.98900000017382,24.543999999850193],[
121.98983662724908,24.54648959613128
]
]
]}
}
]}

400 Response{"statusCode": 400,
"message": "Value of the path parameter LAYERSELECTION does not conform to thedefinition. Value 5 is not defined in enum. Line: 1, Position: 1"}

401 Response{"statusCode": 401,"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}429 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

500 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include

subscription key when making requests to an API."}

ResponsesStatus

Meaning

Description

200OK

地理情報を返します。

400

Bad Request

パラメータが違います。

None

401

Unauthorized

サブスクリプションキーがありません。

error_code

リクエストが集中しています。

error_code

429

500

Too Many
Requests

Schemaquickbulletin_geojson

ArcGIS REST API の レスポンスコードも参照してくださInternal

い。https://developers.arcgis.com/rest/services-

Server Error

error_code

reference/enterprise/output-formats.htm

Response Schema

exportGET /MapServer/export
画像出⼒
経緯度で指定した範囲に含まれる地理情報をWebメルカトル図法で投影し、PNG画像形式で出⼒します。

Parameters
NameInType

Required

Description

bbox

query

stringtrue

出⼒範囲を設定するバウンディングボックスです。

size

query

stringfalse

出⼒する画像のサイズです。

transparentquerybooleanfalse

背景⾊を透明にします。

dpi

query

integerfalse

解像度を指定します。デフォルトは96です。

time

query

integer

false"時間検索条件です。

mapScalequery

integerfalse

縮尺を設定します。

Detailed descriptions
bbox: 出⼒範囲を設定するバウンディングボックスです。 経緯度をカンマ区切りで4点⼊⼒します。 例:
bbox=135.0,35.0,136.0,40.0

size: 出⼒する画像のサイズです。 幅,⾼さをカンマ区切りで⼊⼒します。単位はpixelsです。 例:
size=1920,1080
transparent: 背景⾊を透明にします。 trueなら背景は透過します。デフォルトはfalseです。 例:
transparent=true
dpi: 解像度を指定します。デフォルトは96です。 例: dpi=200
time: "時間検索条件です。 1970年1⽉1⽇からの経過ミリ秒で期間の開始と終了を指定します。 例:
time=1199145600000, 1230768000000
mapScale: 縮尺を設定します。 bboxパラメータの中⼼点を基準に 1:mapScaleの⽐率で画像を出⼒します。
例: mapScale=5000000
Example responses
401 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}429 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

500 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

Responses
StatusMeaning

Description

Schema200

OK

PNG画像を返します。

None

401

Unauthorized

サブスクリプションキーがありません。

error_code

Status

Meaning
Too Many

429

Requests
Internal

500

Server Error

Description

Schemaリクエストが集中しています。

error_code

ArcGIS REST API の レスポンスコードも参照してください。
https://developers.arcgis.com/rest/servicesreference/enterprise/output-formats.htm

range
GET /MapServer/range
時系列出⼒
データの存在する時間情報を出⼒します。時間検索を⾏う際に使⽤します。
Example responses
200 Response{"displayFieldName": "解析対象⽇","fieldAliases": {"msilstarttime": "msilstarttime","msilendtime": "msilendtime"},"fields": [{"name": "msilstarttime","type": "esriFieldTypeDate","alias": "msilstarttime","length": 8},{"name": "msilendtime","type": "esriFieldTypeDate","alias": "msilendtime","length": 8}],"features": [{"attributes": {"msilstarttime": 1676818800000,"msilendtime": 1676905199000}},{"attributes": {"msilstarttime": 1676905200000,

error_code

"msilendtime": 1676991599000}},{"attributes": {"msilstarttime": 1676991600000,"msilendtime": 1677077999000}},{"attributes": {"msilstarttime": 1677164400000,"msilendtime": 1677250799000}},{"attributes": {"msilstarttime": 1677423600000,"msilendtime": 1677509999000}},{"attributes": {"msilstarttime": 1677510000000,"msilendtime": 1677596399000}},{"attributes": {"msilstarttime": 1677596400000,"msilendtime": 1677682799000}},{"attributes": {"msilstarttime": 1677682800000,"msilendtime": 1677769199000}},{"attributes": {"msilstarttime": 1677769200000,"msilendtime": 1677855599000}}]}

401 Response{"statusCode": 401,

"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}429 Response{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

500 Response{"statusCode": 401,"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}

Responses
StatusMeaning

Description

Schema200

OK

データの存在する時間情報を情報を返します。

range

401

Unauthorized

サブスクリプションキーがありません。

error_code

リクエストが集中しています。

error_code

429

500

Too Many
Requests
Internal
Server Error

ArcGIS REST API の レスポンスコードも参照してください。
https://developers.arcgis.com/rest/services-

error_code

reference/enterprise/output-formats.htm

Schemaserror_code{"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include
subscription key when making requests to an API."}Properties
Name

Type

Required

Restrictions

Description

statusCode

integer(int32)

false

none

状態コード

messagestring(byte)

false

none

エラーメッセージ

description{"name": "海洋速報（海流図）","description": "⽇本周辺の⿊潮などの海流の状況"}

Properties
Name

Type

Required

Restrictions

Description

namestring

false

none

APIの名前description

string

false

none

APIの説明range{"displayFieldName": "string","fieldAliases": {"msilstarttime": "1676818800000","msilendtime": "1676905199000"},"fields": [{"name": "string","type": "string","alias": "string","length": 0}],"features": [{"attributes": {"msilstarttime": "1676818800000","msilendtime": "1676905199000"}}]}

Properties
Name

Type

Required

Restrictions

Description

displayFieldName

string

false

none

none

fieldAliases

targer_date

false

none

none

fields[object]

false

none

none

» namestring

false

none

none

» typestring

false

none

none

» aliasstring

false

none

none

» length

integer(int64)

false

none

none

features[object]

false

none

none

» attributes

targer_date

false

none

none

quick-bulletin{"displayFieldName": "string","fieldAliases": {"解析対象⽇": "R5(2023)/03/01","速報発⾏⽇": "R5(2023)/03/02","速報号数": "R5年第040号","海流の種別": "⿊潮"},"geometryType": "string","spatialReference": {"wkid": 0,"latestWkid": 0},"fields": [{"name": "string","type": "string","alias": "string","length": 0}],"features": [{"attributes": {"解析対象⽇": "R5(2023)/03/01","速報発⾏⽇": "R5(2023)/03/02",

"速報号数": "R5年第040号","海流の種別": "⿊潮"},"geometry": {"paths": [[0]]}}]}Properties
Name

Type

Required

Restrictions

Description

displayFieldName

string

false

none

none

fieldAliases

attributes

false

none

none

geometryType

string

false

none

none

spatialReference

object

false

none

none

» wkidinteger(int64)

false

none

none

» latestWkid

integer(int64)

false

none

none

fields[object]

false

none

none

» namestring

false

none

none

» typestring

false

none

none

» aliasstring

false

none

none

» length

integer(int64)

false

none

none

features[object]

false

none

none

» attributes

attributes

false

none

none

» geometry

object

false

none

none

»» paths[array]

false

none

none

quick-bulletin_geojson{"type": "string","crs": {"type": "string",

"properties": {"name": "string"}},"features": [{"type": "string","geometry": {"type": "string","coordinates": [[0]]},"properties": {"解析対象⽇": "R5(2023)/03/01","速報発⾏⽇": "R5(2023)/03/02","速報号数": "R5年第040号","海流の種別": "⿊潮"}}]}Properties
NameType

Required

Restrictions

Description

typestring

false

nonenonecrs

object

false

none

none

» typestring

false

none

none

» properties

object

false

none

none

»» namestring

false

none

none

features[object]

false

none

none

» typestring

false

none

none

» geometry

object

false

none

none

»» typestring

false

none

none

»» coordinates[array]

false

none

none

» properties

attributes

false

none

none

attributes

{"解析対象⽇": "R5(2023)/03/01","速報発⾏⽇": "R5(2023)/03/02","速報号数": "R5年第040号","海流の種別": "⿊潮"}Properties
Name

Type

Required

Restrictions

Description

解析対象⽇

string

false

none

解析対象⽇

速報発⾏⽇

string

false

none

速報発⾏⽇

速報号数

string

false

none

速報号数

海流の種別

string

false

none

海流の種別

targer_date{"msilstarttime": "1676818800000","msilendtime": "1676905199000"}

Properties
Name

Type

Required

Restrictions

Description

msilstarttime

integer

false

none

開始時間

msilendtime

integer

false

none

終了時間