mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-02-22 22:59:35 +02:00
83 lines
1.9 KiB
Markdown
83 lines
1.9 KiB
Markdown
# `nearby(location, [opt])`
|
|
|
|
This method can be used to find stops/stations & POIs close to a location. Note that it is not supported by every profile/endpoint.
|
|
|
|
`location` must be an [*FPTF* `location` object](https://github.com/public-transport/friendly-public-transport-format/blob/3bd36faa721e85d9f5ca58fb0f38cdbedb87bbca/spec/readme.md#location-objects).
|
|
|
|
With `opt`, you can override the default options, which look like this:
|
|
|
|
```js
|
|
{
|
|
results: 8, // maximum number of results
|
|
distance: null, // maximum walking distance in meters
|
|
poi: false, // return points of interest?
|
|
stops: true, // return stops/stations?
|
|
subStops: true, // not supported
|
|
entrances: true, // not supported
|
|
linesOfStops: false, // not supported
|
|
language: 'en' // language to get results in
|
|
}
|
|
```
|
|
|
|
## Response
|
|
|
|
```js
|
|
import {createClient} from 'db-vendo-client'
|
|
import {profile as dbProfile} from 'db-vendo-client/p/db/index.js'
|
|
|
|
const userAgent = 'link-to-your-project-or-email' // adapt this to your project!
|
|
const client = createClient(dbProfile, userAgent)
|
|
|
|
await client.nearby({
|
|
type: 'location',
|
|
latitude: 52.5137344,
|
|
longitude: 13.4744798
|
|
}, {distance: 400})
|
|
```
|
|
|
|
The result may look like this:
|
|
|
|
```js
|
|
[ {
|
|
type: 'stop',
|
|
id: '900000120001',
|
|
name: 'S+U Frankfurter Allee',
|
|
location: {
|
|
type: 'location',
|
|
latitude: 52.513616,
|
|
longitude: 13.475298
|
|
},
|
|
products: {
|
|
suburban: true,
|
|
subway: true,
|
|
tram: true,
|
|
bus: true,
|
|
ferry: false,
|
|
express: false,
|
|
regional: false
|
|
},
|
|
distance: 56
|
|
}, {
|
|
type: 'stop',
|
|
id: '900000120540',
|
|
name: 'Scharnweberstr./Weichselstr.',
|
|
location: {
|
|
type: 'location',
|
|
latitude: 52.512339,
|
|
longitude: 13.470174
|
|
},
|
|
products: { /* … */ },
|
|
distance: 330
|
|
}, {
|
|
type: 'stop',
|
|
id: '900000160544',
|
|
name: 'Rathaus Lichtenberg',
|
|
location: {
|
|
type: 'location',
|
|
latitude: 52.515908,
|
|
longitude: 13.479073
|
|
},
|
|
products: { /* … */ },
|
|
distance: 394
|
|
} ]
|
|
```
|