DiscoverApi

interface DiscoverApi

Main entrypoint to the Mapbox Discover API.

Functions

search
Link copied to clipboard
abstract suspend fun search(query: DiscoverApiQuery, proximity: Point, options: DiscoverApiOptions = DiscoverApiOptions()): Expected<Exception, List<DiscoverApiResult>>
Search for places nearby the specified geographic point.
abstract suspend fun search(query: DiscoverApiQuery, region: BoundingBox, proximity: Point? = null, options: DiscoverApiOptions = DiscoverApiOptions()): Expected<Exception, List<DiscoverApiResult>>
Search for places inside the specified bounding box.
abstract suspend fun search(query: DiscoverApiQuery, route: List<Point>, deviation: RouteDeviationOptions = RouteDeviationOptions.DEFAULT_DEVIATION, options: DiscoverApiOptions = DiscoverApiOptions()): Expected<Exception, List<DiscoverApiResult>>
Search for places along the road.