geoprox-server
| Crates.io | geoprox-server |
| lib.rs | geoprox-server |
| version | 0.5.0 |
| source | src |
| created_at | 2024-08-01 04:25:21.400022 |
| updated_at | 2024-08-23 20:58:54.568511 |
| description | Geoprox server implementation providing a HTTP API for geospatial queries and position tracking |
| homepage | |
| repository | https://github.com/ezrasingh/geoprox |
| max_upload_size | |
| id | 1321602 |
| size | 83,397 |
Ezra Singh (ezrasingh)
documentation
README
Geoprox Server
Geoprox Server is an in-memory geospatial search engine built on top of Geoprox Core.
It provides an API for encoding and decoding geohashes, querying neighboring geohashes, and conducting efficient geospatial searches within specific ranges. This makes it a practical tool for managing and querying location-based data with speed and accuracy.
This service is well-suited for real-time applications such as ride-sharing and food delivery services, where quick and accurate location tracking is crucial.
Need an API Client? See,
contrib/client-sdkfor available HTTP client libraries or generate your own.
- Swagger UI is available at the
/swagger-ui/endpoint. - The OpenAPI specification is accessible at the
/api-spec/openapi.jsonendpoint.
API Endpoints
| Api | Method | HTTP request | Description |
|---|---|---|---|
GeohashApi |
decodeGeohash | GET /api/v1/geohash/{ghash} | Decode geohash into coordinates. |
GeohashApi |
encodeLatlng | GET /api/v1/geohash | Encode coordinates into geohash |
GeohashApi |
getNeighbors | GET /api/v1/geohash/{ghash}/neighbors | Neighboring regions |
GeoshardApi |
createIndex | POST /api/v1/shard/{index} | Create geospatial index |
GeoshardApi |
dropIndex | DELETE /api/v1/shard/{index} | Deletes geospatial index |
GeoshardApi |
insertKey | PUT /api/v1/shard/{index} | Insert key into index |
GeoshardApi |
insertKeyBatch | PUT /api/v1/shard/{index}/batch | Insert multiple keys into index |
GeoshardApi |
queryRange | GET /api/v1/shard/{index} | Search index for objects nearby |
GeoshardApi |
queryRangeMany | GET /api/v1/shard | Search multiple indices for objects nearby |
GeoshardApi |
removeKey | PATCH /api/v1/shard/{index} | Remove key from index |
GeoshardApi |
removeKeyBatch | PATCH /api/v1/shard/{index}/batch | Remove multiple keys from index |
Check out the API documentation for detailed descriptions of all the endpoints.
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
License
This project is licensed under the Apache 2.0 or MIT License (your choice).