Skip to content

Latest commit

 

History

History
103 lines (57 loc) · 2.84 KB

GeohashApiApi.md

File metadata and controls

103 lines (57 loc) · 2.84 KB

\GeohashApiApi

All URIs are relative to http://localhost

Method HTTP request Description
decode_geohash GET /api/v1/geohash/{ghash} Decode geohash into coordinates.
encode_latlng GET /api/v1/geohash Encode coordinates into geohash
get_neighbors GET /api/v1/geohash/{ghash}/neighbors Neighboring regions

decode_geohash

models::DecodeGeohashResponse decode_geohash(ghash) Decode geohash into coordinates.

Decode geohash by path param, returns coordinates with precision estimates.

Parameters

Name Type Description Required Notes
ghash String Geohash encoded region [required]

Return type

models::DecodeGeohashResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

encode_latlng

models::EncodeLatLngResponse encode_latlng(lat, lng, depth) Encode coordinates into geohash

Encode coordinates by query params, returns geohash.

Parameters

Name Type Description Required Notes
lat f64 Latitude [required]
lng f64 Longitude [required]
depth i32 Determines geohash length [required]

Return type

models::EncodeLatLngResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_neighbors

models::GeohashNeighborsResponse get_neighbors(ghash) Neighboring regions

Returns geohash neighbors in all cardinal directions.

Parameters

Name Type Description Required Notes
ghash String Geohash encoded region [required]

Return type

models::GeohashNeighborsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]