README
Endpoints
- search-by-details
- search-by-address
- search-by-zipcode
Overview
You can get a list of zip codes and addresses(maximum 10) matching the Key you entered.
Fill in the required Key (and optional Key) and push [TEST] button in each of the endpoint.
How to
1.search-by-details
You can find the list of adresses and zip codes.
enter the following infomation.
| Key | Key sample | description | REQUIRED | pattern match |
|---|---|---|---|---|
| prefecture | 東京都 | enter prefecture | REQUIRED | extract |
| city | 台東区 | enter city | OPTIONAL | partial |
| townarea | 小島 | enter townarea | OPTIONAL | partial |
example:
Key:Value
"prefecture":"東京都"
"city":"台東区"
"townarea":""
2.search-by-address
You can find the zip code from address
enter the following infomation.
| Key | Key sample | description | REQUIRED | pattern match |
|---|---|---|---|---|
| address | 東京都台東区 | enter address | OPTIONAL | partial |
example:
Key:Value
"address":"東京都台東区"
3.search-by-zipcode
You can find the address from zip code
enter the following infomation.
| Key | Key sample | description | REQUIRED | valid value | pattern match |
|:-----------|------------😐:------------😐:------------😐:------------😐
| zipcode | 1110056 | enter zipcode | REQUIRED | 1 to 7 digit number | partial |
example:
Key:Value
"zipcode":"1110056"
