Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/twihike/go-geojp

🌏 An API server for Japanese geographics
https://github.com/twihike/go-geojp

geo geocoding go golang japan

Last synced: 2 days ago
JSON representation

🌏 An API server for Japanese geographics

Host: GitHub
URL: https://github.com/twihike/go-geojp
Owner: twihike
License: mit
Created: 2020-10-09T14:59:15.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-09-19T13:20:59.000Z (about 3 years ago)
Last Synced: 2024-02-29T05:00:23.096Z (9 months ago)
Topics: geo, geocoding, go, golang, japan
Language: Go
Homepage:
Size: 17.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# go-geojp

[![ci status](https://github.com/twihike/go-geojp/workflows/ci/badge.svg)](https://github.com/twihike/go-geojp/actions) [![license](https://img.shields.io/github/license/twihike/go-geojp)](LICENSE)

An API server for Japanese geographics.

## Installation

```shell
go get -u github.com/twihike/go-geojp/cmd/...
```

## Usage

Start the server.

```shell
# Download Japanese addresses.
curl -LO https://raw.githubusercontent.com/geolonia/japanese-addresses/master/data/latest.csv
# Set file path.
export ADDR_POS_PATH=latest.csv
# Run server
./geojp
```

Reverse geocoding.

```shell
curl -sS \
-X POST localhost:8080/api/reverse-geocoding \
-d 'latitude=35.658584' \
-d 'longitude=139.7454316' \
| jq .
```

Output:

```json
{
"pref_name": "東京都",
"city_name": "港区",
"area_name": "芝公園三丁目",
"latitude": 35.659943,
"longitude": 139.747207,
"distance": 220.37123693585445
}
```

Geocoding.

```shell
curl -sS \
-X POST localhost:8080/api/geocoding \
-d 'area_name=芝公園' \
| jq .
```

Output:

```js
[
{
"pref_name": "広島県",
"city_name": "広島市西区",
"area_name": "大芝公園",
"latitude": 34.417138,
"longitude": 132.460336
},
{
"pref_name": "東京都",
"city_name": "港区",
"area_name": "芝公園三丁目",
"latitude": 35.659943,
"longitude": 139.747207
},
// ...
{
"pref_name": "東京都",
"city_name": "港区",
"area_name": "芝公園二丁目",
"latitude": 35.655131,
"longitude": 139.751235
}
]
```

With current location.

```shell
curl -sS \
-X POST localhost:8080/api/geocoding \
-d 'area_name=芝公園' \
-d 'latitude=35.658584' \
-d 'longitude=139.7454316' \
| jq .
```

Output:

```js
[
{
"pref_name": "東京都",
"city_name": "港区",
"area_name": "芝公園三丁目",
"latitude": 35.659943,
"longitude": 139.747207,
"distance": 220.37123693585445
},
{
"pref_name": "東京都",
"city_name": "港区",
"area_name": "芝公園四丁目",
"latitude": 35.656459,
"longitude": 139.74764,
"distance": 309.2609283463855
},
// ...
{
"pref_name": "広島県",
"city_name": "広島市西区",
"area_name": "大芝公園",
"latitude": 34.417138,
"longitude": 132.460336,
"distance": 677296.9280660086
}
]
```

## Credits

[japanese-addresses](https://geolonia.github.io/japanese-addresses/) by [geolonia](https://github.com/geolonia) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).

## License

This project is licensed under the terms of the MIT license.