FlightRadarAPI 1.3.24__tar.gz → 1.3.26__tar.gz

flightradarapi-1.3.26/.flake8

@@ -0,0 +1,11 @@
+[flake8]
+
+max-line-length = 130
+ignore = W503, E701, E722
+
+per-file-ignores =
+    # __init__.py files are allowed to have unused imports and lines-too-long
+    */__init__.py:F401
+
+    # Unused imports are allowed in the tests/package.py module and they must come after setting the current working directory.
+    tests/package.py:F401, E402

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/.gitignore

@@ -5,3 +5,4 @@ dist
 .idea/
 venv/
 node_modules/
+.env

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/__init__.py

@@ -13,7 +13,7 @@ https://www.flightradar24.com/terms-and-conditions
 """
 
 __author__ = "Jean Loui Bernard Silva de Jesus"
-__version__ = "1.3.24"
+__version__ = "1.3.26"
 
 from .api import FlightRadar24API, FlightTrackerConfig
 from .entities import Airport, Entity, Flight

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/api.py

@@ -54,7 +54,7 @@ class FlightRadar24API(object):
         """
         Return a list with all airlines.
         """
-        response = APIRequest(Core.airlines_data_url, headers = Core.json_headers)
+        response = APIRequest(Core.airlines_data_url, headers=Core.json_headers)
         return response.get_content()["rows"]
 
     def get_airline_logo(self, iata: str, icao: str) -> Optional[Tuple[bytes, str]]:
@@ -62,11 +62,11 @@ class FlightRadar24API(object):
         Download the logo of an airline from FlightRadar24 and return it as bytes.
         """
         iata, icao = iata.upper(), icao.upper()
-        
+
         first_logo_url = Core.airline_logo_url.format(iata, icao)
 
         # Try to get the image by the first URL option.
-        response = APIRequest(first_logo_url, headers = Core.image_headers, exclude_status_codes=[403,])
+        response = APIRequest(first_logo_url, headers=Core.image_headers, exclude_status_codes=[403,])
         status_code = response.get_status_code()
 
         if not str(status_code).startswith("4"):
@@ -75,7 +75,7 @@ class FlightRadar24API(object):
         # Get the image by the second airline logo URL.
         second_logo_url = Core.alternative_airline_logo_url.format(icao)
 
-        response = APIRequest(second_logo_url, headers = Core.image_headers)
+        response = APIRequest(second_logo_url, headers=Core.image_headers)
         status_code = response.get_status_code()
 
         if not str(status_code).startswith("4"):
@@ -90,7 +90,7 @@ class FlightRadar24API(object):
         """
         if 4 < len(code) or len(code) < 3:
             raise ValueError(f"The code '{code}' is invalid. It must be the IATA or ICAO of the airport.")
-            
+
         if details:
             airport = Airport()
 
@@ -99,13 +99,13 @@ class FlightRadar24API(object):
 
             return airport
 
-        response = APIRequest(Core.airport_data_url.format(code), headers = Core.json_headers)
+        response = APIRequest(Core.airport_data_url.format(code), headers=Core.json_headers)
         content = response.get_content()
-        
+
         if not content or not isinstance(content, dict) or not content.get("details"):
             raise AirportNotFoundError(f"Could not find an airport by the code '{code}'.")
 
-        return Airport(info = content["details"])
+        return Airport(info=content["details"])
 
     def get_airport_details(self, code: str, flight_limit: int = 100, page: int = 1) -> Dict:
         """
@@ -138,16 +138,16 @@ class FlightRadar24API(object):
             if errors.get("limit"):
                 raise ValueError(errors["limit"]["notBetween"])
 
-            raise AirportNotFoundError(f"Could not find an airport by the code '{code}'.", errors) 
-        
+            raise AirportNotFoundError(f"Could not find an airport by the code '{code}'.", errors)
+
         result = content["result"]["response"]
 
         # Check whether it received data of an airport.
         data = result.get("airport", dict()).get("pluginData", dict())
 
-        if not "details" in data and len(data.get("runways", [])) == 0 and len(data) <= 3:
-            raise AirportNotFoundError(f"Could not find an airport by the code '{code}'.") 
-        
+        if "details" not in data and len(data.get("runways", [])) == 0 and len(data) <= 3:
+            raise AirportNotFoundError(f"Could not find an airport by the code '{code}'.")
+
         # Return the airport details.
         return result
 
@@ -155,19 +155,19 @@ class FlightRadar24API(object):
         """
         Return airport disruptions.
         """
-        response = APIRequest(Core.airport_disruptions_url, headers = Core.json_headers)
+        response = APIRequest(Core.airport_disruptions_url, headers=Core.json_headers)
         return response.get_content()
 
     def get_airports(self) -> List[Airport]:
         """
         Return a list with all airports.
         """
-        response = APIRequest(Core.airports_data_url, headers = Core.json_headers)
+        response = APIRequest(Core.airports_data_url, headers=Core.json_headers)
 
         airports: List[Airport] = list()
 
         for airport_data in response.get_content()["rows"]:
-            airport = Airport(basic_info = airport_data)
+            airport = Airport(basic_info=airport_data)
             airports.append(airport)
 
         return airports
@@ -184,7 +184,7 @@ class FlightRadar24API(object):
 
         cookies = self.__login_data["cookies"]
 
-        response = APIRequest(Core.bookmarks_url, headers = headers, cookies = cookies)
+        response = APIRequest(Core.bookmarks_url, headers=headers, cookies=cookies)
         return response.get_content()
 
     def get_bounds(self, zone: Dict[str, float]) -> str:
@@ -257,11 +257,11 @@ class FlightRadar24API(object):
         """
         flag_url = Core.country_flag_url.format(country.lower().replace(" ", "-"))
         headers = Core.image_headers.copy()
-        
+
         if "origin" in headers:
             headers.pop("origin")  # Does not work for this request.
 
-        response = APIRequest(flag_url, headers = headers)
+        response = APIRequest(flag_url, headers=headers)
         status_code = response.get_status_code()
 
         if not str(status_code).startswith("4"):
@@ -273,7 +273,7 @@ class FlightRadar24API(object):
 
         :param flight: A Flight instance
         """
-        response = APIRequest(Core.flight_data_url.format(flight.id), headers = Core.json_headers)
+        response = APIRequest(Core.flight_data_url.format(flight.id), headers=Core.json_headers)
         return response.get_content()
 
     def get_flights(
@@ -333,6 +333,30 @@ class FlightRadar24API(object):
         """
         return dataclasses.replace(self.__flight_tracker_config)
 
+    def get_history_data(self, flight: Flight, file_type: str, timestamp: int) -> Dict:
+        """
+        Download historical data of a flight.
+
+        :param flight: A Flight instance
+        :param file_type: Must be "CSV" or "KML"
+        :param timestamp: A Unix timestamp
+        """
+        if not self.is_logged_in():
+            raise LoginError("You must log in to your account.")
+
+        file_type = file_type.lower()
+
+        if file_type not in ["csv", "kml"]:
+            raise ValueError(f"File type '{file_type}' is not supported. Only CSV and KML are supported.")
+
+        response = APIRequest(
+            Core.historical_data_url.format(flight.id, file_type, timestamp),
+            headers=Core.json_headers, cookies=self.__login_data["cookies"],
+        )
+
+        content = response.get_content()
+        return str(content.decode("utf-8"))
+
     def get_login_data(self) -> Dict[Any, Any]:
         """
         Return the user data.
@@ -346,21 +370,21 @@ class FlightRadar24API(object):
         """
         Return the most tracked data.
         """
-        response = APIRequest(Core.most_tracked_url, headers = Core.json_headers)
+        response = APIRequest(Core.most_tracked_url, headers=Core.json_headers)
         return response.get_content()
 
     def get_volcanic_eruptions(self) -> Dict:
         """
         Return boundaries of volcanic eruptions and ash clouds impacting aviation.
         """
-        response = APIRequest(Core.volcanic_eruption_data_url, headers = Core.json_headers)
+        response = APIRequest(Core.volcanic_eruption_data_url, headers=Core.json_headers)
         return response.get_content()
 
     def get_zones(self) -> Dict[str, Dict]:
         """
         Return all major zones on the globe.
         """
-        response = APIRequest(Core.zones_data_url, headers = Core.json_headers)
+        response = APIRequest(Core.zones_data_url, headers=Core.json_headers)
         zones = response.get_content()
 
         if "version" in zones:
@@ -372,7 +396,7 @@ class FlightRadar24API(object):
         """
         Return the search result.
         """
-        response = APIRequest(Core.search_data_url.format(query, limit), headers = Core.json_headers)
+        response = APIRequest(Core.search_data_url.format(query, limit), headers=Core.json_headers)
         results = response.get_content().get("results", [])
         stats = response.get_content().get("stats", {})
 
@@ -407,7 +431,7 @@ class FlightRadar24API(object):
             "type": "web"
         }
 
-        response = APIRequest(Core.user_login_url, headers = Core.json_headers, data = data)
+        response = APIRequest(Core.user_login_url, headers=Core.json_headers, data=data)
         status_code = response.get_status_code()
         content = response.get_content()
 
@@ -431,7 +455,7 @@ class FlightRadar24API(object):
         cookies = self.__login_data["cookies"]
         self.__login_data = None
 
-        response = APIRequest(Core.user_login_url, headers = Core.json_headers, cookies = cookies)
+        response = APIRequest(Core.user_login_url, headers=Core.json_headers, cookies=cookies)
         return str(response.get_status_code()).startswith("2")
 
     def set_flight_tracker_config(

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/core.py

@@ -23,6 +23,9 @@ class Core(ABC):
     real_time_flight_tracker_data_url = data_cloud_base_url + "/zones/fcgi/feed.js"
     flight_data_url = data_live_base_url + "/clickhandler/?flight={}"
 
+    # Historical data URL.
+    historical_data_url = flightradar_base_url + "/download/?flight={}&file={}&trailLimit=0&history={}"
+
     # Airports data URLs.
     api_airport_data_url = api_flightradar_base_url + "/airport.json"
     airport_data_url = flightradar_base_url + "/airports/traffic-stats/?airport={}"

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/entities/airport.py

@@ -37,8 +37,8 @@ class Airport(Entity):
         Initialize instance with basic information about the airport.
         """
         super().__init__(
-            latitude = basic_info["lat"],
-            longitude = basic_info["lon"]
+            latitude=basic_info["lat"],
+            longitude=basic_info["lon"]
         )
         self.altitude = basic_info["alt"]
 
@@ -53,8 +53,8 @@ class Airport(Entity):
         Initialize instance with extra information about the airport.
         """
         super().__init__(
-            latitude = info["position"]["latitude"],
-            longitude = info["position"]["longitude"]
+            latitude=info["position"]["latitude"],
+            longitude=info["position"]["longitude"]
         )
         self.altitude = info["position"]["altitude"]
 
@@ -154,7 +154,7 @@ class Airport(Entity):
 
         self.average_rating = self.__get_info(ratings.get("avg"))
         self.total_rating = self.__get_info(ratings.get("total"))
-        
+
         # Weather information.
         self.weather = self.__get_info(airport.get("weather"), dict())
 

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/entities/entity.py

@@ -8,7 +8,7 @@ class Entity(ABC):
     """
     Representation of a real entity, at some location.
     """
-    
+
     _default_text = "N/A"
 
     def __init__(self, latitude: float, longitude: float):

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/entities/flight.py

@@ -16,8 +16,8 @@ class Flight(Entity):
         :param info: Dictionary with received data from FlightRadar24
         """
         super().__init__(
-            latitude = self.__get_info(info[1]),
-            longitude = self.__get_info(info[2])
+            latitude=self.__get_info(info[1]),
+            longitude=self.__get_info(info[2])
         )
 
         self.id = flight_id
@@ -34,7 +34,7 @@ class Flight(Entity):
         self.number = self.__get_info(info[13])
         self.airline_iata = self.__get_info(info[13][:2])
         self.on_ground = self.__get_info(info[14])
-        self.vertical_speed =self.__get_info(info[15])
+        self.vertical_speed = self.__get_info(info[15])
         self.callsign = self.__get_info(info[16])
         self.airline_icao = self.__get_info(info[18])
 
@@ -62,9 +62,9 @@ class Flight(Entity):
         comparison_functions = {"max": max, "min": min}
 
         for key, value in info.items():
-            
+
             # Separate the comparison prefix if it exists.
-            prefix, key = key.split("_", maxsplit = 1) if key[:4] == "max_" or key[:4] == "min_" else (None, key)
+            prefix, key = key.split("_", maxsplit=1) if key[:4] == "max_" or key[:4] == "min_" else (None, key)
 
             # Check if the value is greater than or less than the attribute value.
             if prefix and key in self.__dict__:

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/errors.py

@@ -2,7 +2,7 @@
 
 class AirportNotFoundError(Exception):
     pass
-    
+
 
 class CloudflareError(Exception):
     def __init__(self, message, response):

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/FlightRadar24/request.py

@@ -53,12 +53,12 @@ class APIRequest(object):
         request_method = requests.get if data is None else requests.post
 
         if params: url += "?" + "&".join(["{}={}".format(k, v) for k, v in params.items()])
-        self.__response = request_method(url, headers = headers, cookies = cookies, data = data)
+        self.__response = request_method(url, headers=headers, cookies=cookies, data=data)
 
         if self.get_status_code() == 520:
             raise CloudflareError(
-                message = "An unexpected error has occurred. Perhaps you are making too many calls?",
-                response = self.__response
+                message="An unexpected error has occurred. Perhaps you are making too many calls?",
+                response=self.__response
             )
 
         if self.get_status_code() not in exclude_status_codes:

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: FlightRadarAPI
-Version: 1.3.24
+Version: 1.3.26
 Summary: SDK for FlightRadar24
 Project-URL: Homepage, https://github.com/JeanExtreme002/FlightRadarAPI
 Author-email: Jean Loui Bernard Silva de Jesus <jeanextreme002@gmail.com>
@@ -32,7 +32,8 @@ See more information at: https://www.flightradar24.com/terms-and-conditions
 [![License](https://img.shields.io/pypi/l/FlightRadarAPI)](https://github.com/JeanExtreme002/FlightRadarAPI)
 [![Python Version](https://img.shields.io/badge/python-3.7+-8A2BE2)](https://pypi.org/project/FlightRadarAPI/)
 [![Npm](https://img.shields.io/npm/v/flightradarapi?logo=npm&color=red)](https://www.npmjs.com/package/flightradarapi)
-[![Downloads](https://static.pepy.tech/personalized-badge/flightradarapi?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads)](https://pypi.org/project/FlightRadarAPI/)
+[![downloads](https://static.pepy.tech/personalized-badge/flightradarapi?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads)](https://pypi.org/project/FlightRadarAPI/)
+[![Frequency](https://img.shields.io/pypi/dm/flightradarapi?style=flat&label=frequency)](https://pypi.org/project/FlightRadarAPI/)
 
 ## Installing FlightRadarAPI:
 ```
@@ -126,6 +127,20 @@ distance = flight.get_distance_from(airport)
 print(f"The flight is {distance} km away from the airport.")
 ```
 
+## Downloading Flight Data
+*Note*: This requires a premium subscription and for you to be logged in.
+
+```py
+history_data = fr_api.get_history_data(flight, file_type="csv", time=1706529600)
+
+ with open("history_data.csv", "w") as file:
+    file.write(history_data)
+```
+
+`flight_id` - The ID of the flight. Can be gotten from any other function that returns flight details.
+`file_type` - Either CSV or KML.
+`time` - The STD/scheduled time of deperature in UTC of the flight as a Unix timestamp. Putting an invalid time will return a blank document.
+
 ## Setting and getting Real-time Flight Tracker parameters:
 Set it by using the `set_flight_tracker_config(...)` method. It receives a `FlightTrackerConfig` dataclass instance, but
 you can also use keyword arguments directly to the method.

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/README.md

@@ -9,7 +9,8 @@ See more information at: https://www.flightradar24.com/terms-and-conditions
 [![License](https://img.shields.io/pypi/l/FlightRadarAPI)](https://github.com/JeanExtreme002/FlightRadarAPI)
 [![Python Version](https://img.shields.io/badge/python-3.7+-8A2BE2)](https://pypi.org/project/FlightRadarAPI/)
 [![Npm](https://img.shields.io/npm/v/flightradarapi?logo=npm&color=red)](https://www.npmjs.com/package/flightradarapi)
-[![Downloads](https://static.pepy.tech/personalized-badge/flightradarapi?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads)](https://pypi.org/project/FlightRadarAPI/)
+[![downloads](https://static.pepy.tech/personalized-badge/flightradarapi?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads)](https://pypi.org/project/FlightRadarAPI/)
+[![Frequency](https://img.shields.io/pypi/dm/flightradarapi?style=flat&label=frequency)](https://pypi.org/project/FlightRadarAPI/)
 
 ## Installing FlightRadarAPI:
 ```
@@ -103,6 +104,20 @@ distance = flight.get_distance_from(airport)
 print(f"The flight is {distance} km away from the airport.")
 ```
 
+## Downloading Flight Data
+*Note*: This requires a premium subscription and for you to be logged in.
+
+```py
+history_data = fr_api.get_history_data(flight, file_type="csv", time=1706529600)
+
+ with open("history_data.csv", "w") as file:
+    file.write(history_data)
+```
+
+`flight_id` - The ID of the flight. Can be gotten from any other function that returns flight details.
+`file_type` - Either CSV or KML.
+`time` - The STD/scheduled time of deperature in UTC of the flight as a Unix timestamp. Putting an invalid time will return a blank document.
+
 ## Setting and getting Real-time Flight Tracker parameters:
 Set it by using the `set_flight_tracker_config(...)` method. It receives a `FlightTrackerConfig` dataclass instance, but
 you can also use keyword arguments directly to the method.

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/pyproject.toml

@@ -17,7 +17,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11"
 ]
-exclude = ["tests"]
+exclude = ["tests", ".flake8"]
 requires-python = ">=3.7"
 dependencies = [
   "Brotli",

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/tests/package.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
-import os, sys
+import os
+import sys
 
 current_dir = os.path.join(os.getcwd(), "python")
 sys.path.append(current_dir)

{flightradarapi-1.3.24 → flightradarapi-1.3.26}/tests/test_api.py

@@ -15,34 +15,34 @@ fr_api = FlightRadar24API()
 
 
 @repeat_test(**repeat_test_config)
-def test_get_airlines(expect = 100):
+def test_get_airlines(expect=100):
     results = fr_api.get_airlines()
     assert len(results) >= expect
 
 
 @repeat_test(**repeat_test_config)
-def test_get_airport(airports = ["ATL", "LAX", "DXB", "DFW"]):
+def test_get_airport(airports=["ATL", "LAX", "DXB", "DFW"]):
     for airport in airports:
         assert fr_api.get_airport(airport).iata == airport
 
 
 @repeat_test(**repeat_test_config)
-def test_get_airport_details(airports = ["ATL", "LAX", "DXB", "DFW"]):
+def test_get_airport_details(airports=["ATL", "LAX", "DXB", "DFW"]):
     data = ["airport", "airlines", "aircraftImages"]
 
     for airport in airports:
-        details = fr_api.get_airport_details(airport, flight_limit = 1)
+        details = fr_api.get_airport_details(airport, flight_limit=1)
         assert all([key in details for key in data]) and details["airport"]["pluginData"]["details"]
 
 
 @repeat_test(**repeat_test_config)
-def test_get_airports(expect = 1000):
+def test_get_airports(expect=1000):
     results = fr_api.get_airports()
     assert len(results) >= expect
 
 
 @repeat_test(**repeat_test_config)
-def test_get_zones(expect = 5):
+def test_get_zones(expect=5):
     results = fr_api.get_zones()
 
     assert len(results) >= expect
@@ -52,7 +52,7 @@ def test_get_zones(expect = 5):
 
 
 @repeat_test(**repeat_test_config)
-def test_get_flights(expect = 100):
+def test_get_flights(expect=100):
     results = fr_api.get_flights()
     assert len(results) >= expect
 
@@ -72,11 +72,11 @@ def test_get_flight_details():
 
 
 @repeat_test(**repeat_test_config)
-def test_get_flights_by_airline(airlines = ["SWA", "GLO", "AZU", "UAL", "THY"], expect = 3):
+def test_get_flights_by_airline(airlines=["SWA", "GLO", "AZU", "UAL", "THY"], expect=3):
     count = 0
 
     for airline in airlines:
-        flights = fr_api.get_flights(airline = airline)
+        flights = fr_api.get_flights(airline=airline)
 
         for flight in flights:
             assert flight.airline_icao == airline
@@ -87,14 +87,14 @@ def test_get_flights_by_airline(airlines = ["SWA", "GLO", "AZU", "UAL", "THY"],
 
 
 @repeat_test(**repeat_test_config)
-def test_get_flights_by_bounds(target_zones = ["northamerica", "southamerica"], expect = 30):
+def test_get_flights_by_bounds(target_zones=["northamerica", "southamerica"], expect=30):
     zones = fr_api.get_zones()
-    
+
     for zone in target_zones:
         zone = zones[zone]
         bounds = fr_api.get_bounds(zone)
 
-        flights = fr_api.get_flights(bounds = bounds)
+        flights = fr_api.get_flights(bounds=bounds)
 
         for flight in flights:
             assert zone["tl_y"] >= flight.latitude >= zone["br_y"]
@@ -104,7 +104,7 @@ def test_get_flights_by_bounds(target_zones = ["northamerica", "southamerica"],
 
 
 @repeat_test(**repeat_test_config)
-def test_get_airline_logo(airlines = [["WN", "SWA"], ["G3", "GLO"], ["AD", "AZU"], ["AA", "AAL"], ["TK", "THY"]]):
+def test_get_airline_logo(airlines=[["WN", "SWA"], ["G3", "GLO"], ["AD", "AZU"], ["AA", "AAL"], ["TK", "THY"]]):
     expected = len(airlines) * 0.8
     found = 0
 
@@ -116,7 +116,7 @@ def test_get_airline_logo(airlines = [["WN", "SWA"], ["G3", "GLO"], ["AD", "AZU"
 
 
 @repeat_test(**repeat_test_config)
-def test_get_country_flag(countries = ["United States", "Brazil", "Egypt", "Japan", "South Korea", "Canada"]):
+def test_get_country_flag(countries=["United States", "Brazil", "Egypt", "Japan", "South Korea", "Canada"]):
     expected = len(countries) * 0.8
     found = 0