Skip to content

Fetch API Flight data

Interface for fetching flight data.

APIFetchFlightData

Bases: APIFetchInternal

Exposes functions for fetching flight data from the server.

Source code in src/rmlab/api/fetch/flight_data.py
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
class APIFetchFlightData(APIFetchInternal):
    """Exposes functions for fetching flight data from the server."""

    async def fetch_flights_data_historic(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataBooks]:
        """Fetch flight data of historic books of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of historic books data containers of each flight.
        """

        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.ACTUAL_BOOKS,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )


    async def fetch_flights_data_expected(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataForecastedBooks]:
        """Fetch flight data of expected books of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of expected books data containers of each flight.
        """
        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.EXPECTED_BOOKS,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )


    async def fetch_flights_data_dynamic(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataForecastedBooks]:
        """Fetch flight data of dynamic books of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of dynamic books data containers of each flight.
        """
        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.DYNAMIC_BOOKS,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )

    async def fetch_flights_data_forecast(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataQForecast]:
        """Fetch forecast flight data of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of forecast data containers of each flight.
        """

        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.FORECAST,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )

    async def fetch_flights_data_pricing_thresholds(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataThresholdSettings]:
        """Fetch flight data of pricing thresholds of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of pricing thresholds data containers of each flight.
        """

        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.THRESHOLDS_SETTINGS,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )


    async def fetch_flights_data_pricing_per_seat(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataPricePerSeatSettings]:
        """Fetch flight data of pricing per seat of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of pricing per seat data containers of each flight.
        """

        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.PRICE_PER_SEAT_SETTINGS,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )

    async def fetch_flights_data_events(
        self,
        scen_id: int,
        ids: List[str],
        *,
        citysector_id: Optional[str] = None,
        sector_id: Optional[str] = None,
    ) -> List[FlightDataEvents]:
        """Fetch flight data of events of given flights, associated to a citysector or sector, from server.
        At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

        Args:
            scen_id (int): Scenario ID
            ids (List[str]): List of flights IDs
            citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
            sector_id (Optional[str], optional): Target sector ID. Defaults to None.

        Raises:
            ValueError: If none of `citysector_id`, `sector_id` is defined

        Returns:
            List of events data containers of each flight.
        """

        return await self._fetch_flights_data(
            scen_id,
            ids,
            FlightDataKind.EVENTS,
            citysector_id=citysector_id,
            sector_id=sector_id,
        )

fetch_flights_data_dynamic(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch flight data of dynamic books of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataForecastedBooks]

List of dynamic books data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
async def fetch_flights_data_dynamic(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataForecastedBooks]:
    """Fetch flight data of dynamic books of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of dynamic books data containers of each flight.
    """
    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.DYNAMIC_BOOKS,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )

fetch_flights_data_events(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch flight data of events of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataEvents]

List of events data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
async def fetch_flights_data_events(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataEvents]:
    """Fetch flight data of events of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of events data containers of each flight.
    """

    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.EVENTS,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )

fetch_flights_data_expected(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch flight data of expected books of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataForecastedBooks]

List of expected books data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
async def fetch_flights_data_expected(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataForecastedBooks]:
    """Fetch flight data of expected books of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of expected books data containers of each flight.
    """
    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.EXPECTED_BOOKS,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )

fetch_flights_data_forecast(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch forecast flight data of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataQForecast]

List of forecast data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
async def fetch_flights_data_forecast(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataQForecast]:
    """Fetch forecast flight data of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of forecast data containers of each flight.
    """

    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.FORECAST,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )

fetch_flights_data_historic(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch flight data of historic books of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataBooks]

List of historic books data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
async def fetch_flights_data_historic(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataBooks]:
    """Fetch flight data of historic books of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of historic books data containers of each flight.
    """

    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.ACTUAL_BOOKS,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )

fetch_flights_data_pricing_per_seat(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch flight data of pricing per seat of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataPricePerSeatSettings]

List of pricing per seat data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
async def fetch_flights_data_pricing_per_seat(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataPricePerSeatSettings]:
    """Fetch flight data of pricing per seat of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of pricing per seat data containers of each flight.
    """

    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.PRICE_PER_SEAT_SETTINGS,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )

fetch_flights_data_pricing_thresholds(scen_id, ids, *, citysector_id=None, sector_id=None) async

Fetch flight data of pricing thresholds of given flights, associated to a citysector or sector, from server. At least citysector_id and/or sector_id associated to the flights must be defined.

Parameters:

NameTypeDescriptionDefault
scen_idint

Scenario ID

required
idsList[str]

List of flights IDs

required
citysector_idOptional[str]

Target citysector ID. Defaults to None.

None
sector_idOptional[str]

Target sector ID. Defaults to None.

None

Raises:

TypeDescription
ValueError

If none of citysector_id, sector_id is defined

Returns:

TypeDescription
List[FlightDataThresholdSettings]

List of pricing thresholds data containers of each flight.

Source code in src/rmlab/api/fetch/flight_data.py
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
async def fetch_flights_data_pricing_thresholds(
    self,
    scen_id: int,
    ids: List[str],
    *,
    citysector_id: Optional[str] = None,
    sector_id: Optional[str] = None,
) -> List[FlightDataThresholdSettings]:
    """Fetch flight data of pricing thresholds of given flights, associated to a citysector or sector, from server.
    At least `citysector_id` and/or `sector_id` associated to the flights must be defined.

    Args:
        scen_id (int): Scenario ID
        ids (List[str]): List of flights IDs
        citysector_id (Optional[str], optional): Target citysector ID. Defaults to None.
        sector_id (Optional[str], optional): Target sector ID. Defaults to None.

    Raises:
        ValueError: If none of `citysector_id`, `sector_id` is defined

    Returns:
        List of pricing thresholds data containers of each flight.
    """

    return await self._fetch_flights_data(
        scen_id,
        ids,
        FlightDataKind.THRESHOLDS_SETTINGS,
        citysector_id=citysector_id,
        sector_id=sector_id,
    )