Install the NPM Package by using
npm i @nearest/nearest-sdk -S
Now you can use the SDK by importing it. The code is isomophic ready.
import { NearestClient } from 'nearest-sdk';
const nearest = NearestClient({
apiKey: 'your-api-public-key',
app: 'your-appId',
});The API works with schema SDK.$topic.$action(options, [callback]). All methods return a Promise except callback is defined.
| Parameter | Description |
|---|---|
| lang: String | The language code (de) for translations. |
| Parameter | Description |
|---|---|
| id: [String]! | Required: The node id (_id) |
| lang: String | The language code (de) for translated content. |
| Parameter | Description |
|---|---|
| lat: Float | A latitude for specifying a center point. Requires lng and radius. |
| lng: Float | A longitude for specifying a center point. Requires lat and radius. |
| radius: Int | Max. distance in meters a node is located from the center. Refuires lat and lng. |
| lang: String | The language code (de) for translated content. |
| limit: Int | Limit amount of nodes. |
| Parameter | Description |
|---|---|
| bound: [[Float]]! | Required: Array of coordinates, representing a bounding box. |
| limit: Int | Limit amount of nodes. Default 10. |
| Parameter | Description |
|---|---|
| regionId: [Int]! | Required: Array of regionIds (osm_ids) |
| limit: Int | Max. amount of nodes. Default 10. |
| Parameter | Description |
|---|---|
| regions: [Int]! | Required: Ids of the region |
| Parameter | Description |
|---|
| Parameter | Description |
|---|---|
| region: Int! | Required: Array of region ids (osm_id). |
| Parameter | Description |
|---|---|
| id: [Int]! | Required: Array of regionIds (osm_id) |
| lang: String | The language code (de) for translated content. |
| Parameter | Description |
|---|---|
| path: String! | Required: Path of a region (Germany/Berlin/Kreuzberg) |
| lang: String | The language code (de) for translated content. |
| Parameter | Description |
|---|---|
| name: String! | Required: Name of a region (Bologna) |
| lang: String | The language code (de) for translated content. |
| Parameter | Description |
|---|---|
| name: String! | Required: Name of a region (Bologna) |
| lat: Float! | Required: Latitiude of a Point within a region |
| lng: Float! | Required: Longitude of a Point within a region |
| lang: String | The language code (de) for translated content. |
| Parameter | Description |
|---|---|
| steps: [[Float]]! | Required: The steps of a direction in lng,lat order. [[Lng,Lat],...,[Lng,Lat]] |
| mode: String | Mode of the direction (car or foot) |
Information from the server. Could be used for testing.
- info: Get info of Endpoint Server
SDK.server.info({}).then((serverInfo) => {
const { version } = serverInfo;
// do smth with it
}, (err) => {
// work with the err
});