Skip to content

availability

availability

availability(gbfs_url: str, **kwargs: Any) -> DataFrame

One-liner: live availability (bikes/docks + name/coords) from a gbfs.json URL.

See Also

build_availability_panel : The longitudinal panel version. stockout_episodes : Detect outages over time.

Source code in src/gbfs_toolkit/io/fetch.py
def availability(gbfs_url: str, **kwargs: Any) -> pd.DataFrame:
    """One-liner: live availability (bikes/docks + name/coords) from a ``gbfs.json`` URL.

    See Also
    --------
    [`build_availability_panel`][gbfs_toolkit.build_availability_panel] : The longitudinal panel version.
    [`stockout_episodes`][gbfs_toolkit.stockout_episodes] : Detect outages over time.
    """
    return GBFSFeed.from_url(gbfs_url, **kwargs).availability()