Skip to content

Files

Latest commit

2257c79 · May 26, 2024

History

History
60 lines (51 loc) · 1.59 KB

stop_areas.md

File metadata and controls

60 lines (51 loc) · 1.59 KB

Stop areas

API client for handling 'StopArea' entities in the Navitia API.

Official documentation: https://doc.navitia.io/#pt-ref

Property: NavitiaClient.stop_areas

Methods:

    list_entity_collection_from_region(
        region_id: str,
        start_page: int = 0,
        count: int = 25,
        depth: int = 1,
        odt: str = "all",
        distance: int = 200,
        headsign: Optional[str] = None
    ) -> Tuple[Sequence[StopArea], Pagination]:
        List stop areas for a given region.

    get_entity_by_id(
        region_id: str,
        object_id: str,
        start_page: int = 0,
        count: int = 25,
        depth: int = 1,
        odt: str = "all",
        distance: int = 200,
        headsign: Optional[str] = None
    ) -> Tuple[Sequence[StopArea], Pagination]:
        Get a stop area by its ID in a given region.

    list_entity_collection_from_coordinates(
        lon: float,
        lat: float,
        start_page: int = 0,
        count: int = 25,
        depth: int = 1,
        odt: str = "all",
        distance: int = 200,
        headsign: Optional[str] = None
    ) -> Tuple[Sequence[StopArea], Pagination]:
        List stop areas for given geographic coordinates.

    get_entity_by_id_and_coordinates(
        lon: float,
        lat: float,
        object_id: str,
        start_page: int = 0,
        count: int = 25,
        depth: int = 1,
        odt: str = "all",
        distance: int = 200,
        headsign: Optional[str] = None
    ) -> Tuple[Sequence[StopArea], Pagination]:
        Get a stop area by its ID for given geographic coordinates.