gbfs-v3/dev.sargunv.mobilitydata.gbfs.v3/GbfsV3Client

GbfsV3Client

class GbfsV3Client : AutoCloseable(source)

HTTP client for fetching GBFS v3 feeds.

Constructors

constructor(block: HttpClientConfig<*>.() -> Unit = {})

constructor(engine: HttpClientEngine, block: HttpClientConfig<*>.() -> Unit = {})

Functions

open override fun close()

getDatasetManifest

suspend fun getDatasetManifest(manifestUrl: Url): GbfsFeedResponse<DatasetManifest>

Fetches the dataset manifest from the given URL.

getGeofencingZones

context(service: ServiceManifest)
suspend fun getGeofencingZones(): GbfsFeedResponse<GeofencingZones>

Fetches geofencing zones that define geographic restrictions.

getServiceManifest

suspend fun getServiceManifest(discoveryUrl: Url): GbfsFeedResponse<ServiceManifest>

Fetches the GBFS manifest (auto-discovery file) from the given URL.

getStationInformation

context(service: ServiceManifest)
suspend fun getStationInformation(): GbfsFeedResponse<StationInformation>

Fetches static information about stations in the system.

getStationStatus

context(service: ServiceManifest)
suspend fun getStationStatus(): GbfsFeedResponse<StationStatus>

Fetches real-time status of stations including available bikes and docks.

getSystemAlerts

context(service: ServiceManifest)
suspend fun getSystemAlerts(): GbfsFeedResponse<SystemAlerts>

Fetches current system alerts about service disruptions or changes.

getSystemInformation

context(service: ServiceManifest)
suspend fun getSystemInformation(): GbfsFeedResponse<SystemInformation>

Fetches system information including name, operator, timezone, and contact details.

getSystemPricingPlans

context(service: ServiceManifest)
suspend fun getSystemPricingPlans(): GbfsFeedResponse<SystemPricingPlans>

Fetches pricing plans for the system.

getSystemRegions

context(service: ServiceManifest)
suspend fun getSystemRegions(): GbfsFeedResponse<SystemRegions>

Fetches information about geographic regions in the system.

getVehicleStatus

context(service: ServiceManifest)
suspend fun getVehicleStatus(): GbfsFeedResponse<VehicleStatus>

Fetches real-time status of free-floating vehicles not currently docked.

getVehicleTypes

context(service: ServiceManifest)
suspend fun getVehicleTypes(): GbfsFeedResponse<VehicleTypes>

Fetches information about vehicle types available in the system.

getVersionManifest

context(service: ServiceManifest)
suspend fun getVersionManifest(): GbfsFeedResponse<VersionManifest>

Fetches the list of GBFS versions supported by this system.