都道府県の一覧を取得します。
Request
GET /zipcode/prefs/all
Authorization: Bearer ACCESS_TOKEN
...
パラメータ名 | 説明 | 例 |
---|---|---|
callback [任意] | JSONP使用する場合コールバック関数名を指定します | /zipcode/prefs/all?callback=func_name |
Response
HTTP/1.1 200 OK
...
[
{"code":"01","name":"\u5317\u6d77\u9053","kana":"\uff8e\uff6f\uff76\uff72\uff84\uff9e\uff73"},
{"code":"02","name":"\u9752\u68ee\u770c","kana":"\uff71\uff75\uff93\uff98\uff79\uff9d"},
...
{"code":"47","name":"\u6c96\u7e04\u770c","kana":"\uff75\uff77\uff85\uff9c\uff79\uff9d"}
]
項目名 | 説明 |
---|---|
val[n].code | 都道府県コード |
val[n].name | 都道府県名 |
val[n].kana | 都道府県名(カナ) |
指定した都道府県内の市区町村一覧を取得します。
Request
GET /zipcode/munics/[pref_code]
Authorization: Bearer ACCESS_TOKEN
...
パラメータ名 | 説明 | 例 |
---|---|---|
pref_code | 都道府県コードを指定します | /zipcode/munics/01 |
callback [任意] | JSONP使用する場合コールバック関数名を指定します | /zipcode/munics/02?callback=func_name |
Response
HTTP/1.1 200 OK
...
[
{"pcode":"01","kana":"\uff71\uff6f\uff79\uff7c\uff78\uff9e\uff9d\uff71\uff6f\uff79\uff7c\uff81\uff6e\uff73","name":"\u539a\u5cb8\u90e1\u539a\u5cb8\u753a","mcode":"662"},
{"pcode":"01","kana":"\uff71\uff6f\uff79\uff7c\uff78\uff9e\uff9d\uff8a\uff8f\uff85\uff76\uff81\uff6e\uff73","name":"\u539a\u5cb8\u90e1\u6d5c\u4e2d\u753a","mcode":"663"},
...
{"pcode":"01","kana":"\uff9c\uff6f\uff76\uff85\uff72\uff7c","name":"\u7a1a\u5185\u5e02","mcode":"214"}
]
項目名 | 説明 |
---|---|
val[n].pcode | 都道府県コード |
val[n].mcode | 市区町村コード |
val[n].name | 市区町村名 |
val[n].kana | 市区町村名(カナ) |
指定した市区町村内の郵便番号一覧を取得します。
Request
GET /zipcode/list/[pref_code][munic_code]
Authorization: Bearer ACCESS_TOKEN
...
パラメータ名 | 説明 | 例 |
---|---|---|
pref_code | 都道府県コードを指定します | /zipcode/list/01667 |
munic_code | 市区町村コードを指定します | /zipcode/list/01668 |
callback [任意] | JSONP使用する場合コールバック関数名を指定します | /zipcode/list/01667?callback=func_name |
Response
HTTP/1.1 200 OK
...
[
{"kana":"","zipcode":"0851200","name":""},
{"kana":"\uff71\uff84\uff7a\uff7c\uff6c\uff97\uff76","zipcode":"0851146","name":"\u30a2\u30c8\u30b3\u30b7\u30e4\u30e9\u30ab"},
...
{"kana":"\uff93\uff8e\uff9b\uff9b","zipcode":"0851134","name":"\u8302\u5e4c\u5442"}
]
項目名 | 説明 |
---|---|
val[n].zipcode | 郵便番号 |
val[n].name | 地域名 |
val[n].kana | 地域名(カナ) |
指定した郵便番号に前方一致する郵便番号一覧を取得します。
Request
GET /zipcode/find/[zipcode]
Authorization: Bearer ACCESS_TOKEN
...
パラメータ名 | 説明 | 例 |
---|---|---|
zipcode | 郵便番号を指定します。3文字以上。前方一致 | /zipcode/find/108 |
callback [任意] | JSONP使用する場合コールバック関数名を指定します | /zipcode/find/10800?callback=func_name |
Response
HTTP/1.1 200 OK
...
[
{
"name":["\u6771\u4eac\u90fd","\u5343\u4ee3\u7530\u533a",""],
"zip":"1000000",
"kana":["\uff84\uff73\uff77\uff6e\uff73\uff84","\uff81\uff96\uff80\uff9e\uff78",""]
},
{
"name":["\u6771\u4eac\u90fd","\u5343\u4ee3\u7530\u533a","\u5343\u4ee3\u7530"],
"zip":"1000001",
"kana":["\uff84\uff73\uff77\uff6e\uff73\uff84","\uff81\uff96\uff80\uff9e\uff78","\uff81\uff96\uff80\uff9e"]
},
...
{
"name":["\u6771\u4eac\u90fd","\u5343\u4ee3\u7530\u533a","\u4e38\u306e\u5185\uff2a\uff30\u30bf\u30ef\u30fc\u5730\u968e\u30fb\u968e\u5c64\u4e0d\u660e"],
"zip":"1007090",
"kana":["\uff84\uff73\uff77\uff6e\uff73\uff84","\uff81\uff96\uff80\uff9e\uff78","\uff8f\uff99\uff89\uff73\uff81\uff7c\uff9e\uff6a\uff72\uff8b\uff9f\uff70\uff80\uff9c\uff70\uff81\uff76\uff72\uff65\uff76\uff72\uff7f\uff73\uff8c\uff92\uff72"]
}
]
項目名 | 説明 |
---|---|
val[n].zipcode | 郵便番号 |
val[n].name[0] | 都道府県名 |
val[n].name[1] | 市区町村名 |
val[n].name[2] | 地域名 |
val[n].kana[0] | 都道府県名(カナ) |
val[n].kana[1] | 市区町村名(カナ) |
val[n].kana[2] | 地域名(カナ) |