gis-tools-ts - v0.6.0
    Preparing search index...

    Interface GBFSVehicleV3

    GBFS Vehicle V3

    interface GBFSVehicleV3 {
        available_until?: string;
        current_fuel_percent?: number;
        current_range_meters?: number;
        home_station_id?: string;
        is_disabled: boolean;
        is_reserved: boolean;
        last_reported?: string;
        lat?: number;
        lon?: number;
        pricing_plan_id?: string;
        rental_uris?: { android?: string; ios?: string; web?: string };
        station_id?: string;
        vehicle_equipment?: (
            | "child_seat_a"
            | "child_seat_b"
            | "child_seat_c"
            | "winter_tires"
            | "snow_chains"
        )[];
        vehicle_id: string;
        vehicle_type_id?: string;
    }

    Hierarchy

    • Properties
      • GBFSVehicleV3
    Index

    Properties

    available_until? current_fuel_percent? current_range_meters? home_station_id? is_disabled is_reserved last_reported? lat? lon? pricing_plan_id? rental_uris? station_id? vehicle_equipment? vehicle_id vehicle_type_id?

    Properties

    available_until?: string

    The date and time when any rental of the vehicle must be completed. Pattern: ^([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(([+-]([0-9]{2}):([0-9]{2}))|Z)$

    current_fuel_percent?: number

    Current percentage of fuel or battery power remaining in the vehicle. Range: [0, 1]

    current_range_meters?: number

    The furthest distance in meters the vehicle can travel without recharging or refueling. Minimum: 0

    home_station_id?: string

    The station_id of the station this vehicle must be returned to.

    is_disabled: boolean

    Is the vehicle currently disabled (broken)?

    is_reserved: boolean

    Is the vehicle currently reserved?

    last_reported?: string

    The last time this vehicle reported its status to the operator's backend. Format: date-time

    lat?: number

    The latitude of the vehicle. Range: [-90, 90]

    lon?: number

    The longitude of the vehicle. Range: [-180, 180]

    pricing_plan_id?: string

    The plan_id of the pricing plan this vehicle is eligible for.

    rental_uris?: { android?: string; ios?: string; web?: string }

    Contains rental URIs for Android, iOS, and web.

    station_id?: string

    Identifier referencing the station_id if the vehicle is currently at a station.

    vehicle_equipment?: (
        | "child_seat_a"
        | "child_seat_b"
        | "child_seat_c"
        | "winter_tires"
        | "snow_chains"
    )[]

    List of vehicle equipment provided by the operator. Enum: ['child_seat_a', 'child_seat_b', 'child_seat_c', 'winter_tires', 'snow_chains']

    vehicle_id: string

    Rotating (as of v2.0) identifier of a vehicle.

    vehicle_type_id?: string

    The vehicle_type_id of this vehicle (added in v2.1-RC).

    Settings

    Member Visibility

    On This Page

    Properties