+```
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 0000000..2cd8491
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,98 @@
+# Installation
+
+FlightRadarAPI ships as three packages, one per language. They carry the same
+features and are released together, under the same version number.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+Install from [PyPI](https://pypi.org/project/FlightRadarAPI/):
+
+```bash
+pip install FlightRadarAPI
+```
+
+```python
+from FlightRadarAPI import FlightRadar24API
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+Install from [npm](https://www.npmjs.com/package/flightradarapi):
+
+```bash
+npm install flightradarapi
+```
+
+```javascript
+const { FlightRadar24API } = require("flightradarapi");
+```
+
+TypeScript declarations are bundled with the package.
+:::
+
+:::{tab-item} Go
+:sync: go
+
+Add the module to your project:
+
+```bash
+go get github.com/JeanExtreme002/FlightRadarAPI/go@latest
+```
+
+```go
+import "github.com/JeanExtreme002/FlightRadarAPI/go/flightradarapi"
+```
+:::
+::::
+
+## Requirements
+
+| SDK | Runtime |
+|---|---|
+| Python | Python 3.10 or later |
+| Node.js | Node.js 18.17 or later |
+| Go | Go 1.26 or later |
+
+The dependencies are installed for you by `pip`, `npm` and `go get`.
+
+## Checking the installed version
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+import FlightRadarAPI
+
+print(FlightRadarAPI.__version__)
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const { version } = require("flightradarapi");
+
+console.log(version);
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+fmt.Println(flightradarapi.Version)
+```
+:::
+::::
+
+This documentation describes version {{ release }}.
diff --git a/docs/license.md b/docs/license.md
new file mode 100644
index 0000000..bcca920
--- /dev/null
+++ b/docs/license.md
@@ -0,0 +1,13 @@
+# License
+
+FlightRadarAPI is released under the **MIT License**. The full text is below and
+in the [`LICENSE`](https://github.com/JeanExtreme002/FlightRadarAPI/blob/main/LICENSE)
+file.
+
+```{literalinclude} ../LICENSE
+:language: none
+```
+
+FlightRadarAPI is not affiliated with or endorsed by Flightradar24. This SDK
+should only be used for your own educational purposes. See
+[Flightradar24's terms and conditions](https://www.flightradar24.com/terms-and-conditions).
diff --git a/docs/live-data.md b/docs/live-data.md
new file mode 100644
index 0000000..7c67ea4
--- /dev/null
+++ b/docs/live-data.md
@@ -0,0 +1,50 @@
+# Most Tracked, Disruptions and Eruptions
+
+Three calls return a snapshot of what FlightRadar24 is showing right now:
+
+- **Most tracked flights**: the flights most people are following at the moment.
+- **Airport disruptions**: the airports currently affected by delays and
+ cancellations.
+- **Volcanic eruptions**: the boundaries of the eruptions and ash clouds
+ impacting aviation.
+
+None takes a parameter, and each returns the payload as FlightRadar24 sends it.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+most_tracked = fr_api.get_most_tracked() # dict
+disruptions = fr_api.get_airport_disruptions() # dict
+eruptions = fr_api.get_volcanic_eruptions() # dict
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const mostTracked = await frApi.getMostTracked(); // object
+const disruptions = await frApi.getAirportDisruptions(); // object
+const eruptions = await frApi.getVolcanicEruptions(); // object
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+mostTracked, err := client.GetMostTracked(ctx) // map[string]any
+disruptions, err := client.GetAirportDisruptions(ctx) // map[string]any
+eruptions, err := client.GetVolcanicEruptions(ctx) // map[string]any
+```
+:::
+::::
+
+```{note}
+The shape of these payloads is defined by FlightRadar24 and may change. Inspect
+a response before relying on a particular field.
+```
diff --git a/docs/nodejs.md b/docs/nodejs.md
deleted file mode 100644
index b1cfca1..0000000
--- a/docs/nodejs.md
+++ /dev/null
@@ -1,164 +0,0 @@
----
-title: Node.js
-description: API Documentation for Node.js
----
-
-## Installation
-
-To install the FlightRadarAPI for Node.js, use the following npm command:
-
-```bash
-npm install flightradarapi
-```
-
-## Basic Usage
-
-Start by importing the `FlightRadar24API` class and creating an instance of it:
-
-```javascript
-const { FlightRadar24API } = require("flightradarapi");
-const frApi = new FlightRadar24API();
-```
-
-### Fetching Data
-
-You can fetch various types of data using the following methods:
-
-- **Flights list:**
-
- ```javascript
- let flights = await frApi.getFlights(...); // Returns a list of Flight objects
- ```
-
-- **Airports list:**
-
- ```javascript
- let airports = await frApi.getAirports(...); // Returns a list of Airport objects
- ```
-
- FR24 lists airports one page per country (and per state for the largest
- countries), so this makes one request per page: a handful for a few
- countries, a few hundred for every airport, `maxWorkers` at a time. The
- listing carries the name, codes and country only; use `getAirport(code)`
- for the position and altitude of an airport.
-
-- **Airlines list:**
-
- ```javascript
- let airlines = await frApi.getAirlines();
- ```
-
-- **Zones list:**
-
- ```javascript
- let zones = frApi.getZones();
- ```
-
-### Fetching Detailed Information
-
-Fetch more information about a specific flight or airport using the following methods:
-
-- **Flight details:**
-
- ```javascript
- let flightDetails = await frApi.getFlightDetails(flight);
- flight.setFlightDetails(flightDetails);
-
- console.log("Flying to", flight.destinationAirportName);
- ```
-
-- **Airport details:**
-
- ```javascript
- let airportDetails = await frApi.getAirportDetails(icao);
- ```
-
- !!! note
- Arrivals and departures can have a limit `flightLimit` (max value is 100) to display. When you need to reach more than 100 flights you can use additional parameter `page` to view other pages.
-
-## Advanced Usage
-
-### Fetching Flights Above a Specific Position
-
-Use the `getBoundsByPoint(...)` method to fetch flights above a specific position. This method takes `latitude` and `longitude` for your position and `radius` for the distance in meters from your position to designate a tracking area.
-
-```javascript
-// Your point is 52°34'04.7"N 13°16'57.5"E from Google Maps and radius 2km
-let bounds = frApi.getBoundsByPoint(52.567967, 13.282644, 2000);
-
-let flights = await frApi.getFlights(null, bounds);
-```
-
-### Filtering Flights and Airports
-
-Use the `getFlights(...)` method to search for flights by area line, bounds (customized coordinates or obtained by the `getZones()` method), aircraft registration or aircraft type.
-
-```javascript
-let airlineIcao = "UAE";
-let aircraftType = "B77W";
-
-// You may also set a custom region, such as: bounds = "73,-12,-156,38"
-let zone = frApi.getZones()["northamerica"];
-let bounds = frApi.getBounds(zone);
-
-let emiratesFlights = await frApi.getFlights(
- airlineIcao,
- bounds,
- null,
- aircraftType,
-);
-```
-
-### Fetching Airport by ICAO or IATA
-
-```javascript
-let luklaAirport = await frApi.getAirport("VNLK", true);
-```
-
-### Calculating Distance Between Flights and Airports
-
-The `Flight` and `Airport` classes inherit from `Entity`, which contains the `getDistanceFrom(...)` method. This method returns the distance between the self instance and another entity in kilometers.
-
-```javascript
-let airport = await frApi.getAirport("KJFK");
-let distance = flight.getDistanceFrom(airport);
-
-console.log("The flight is", distance, "km away from the airport.");
-```
-
-## Downloading Flight Data :material-information-outline:{ title="This requires a premium subscription" }
-
-You can download flight data in either CSV or KML format. The method `getHistoryData(...)` is used for this purpose. It takes three parameters:
-
-!!! warning inline end
- If an invalid time is provided, a blank document will be returned.
-
-| Parameter | Description |
-| ------------- | ------------- |
-| `flight_id` | The ID of the flight. This can be obtained from any other function that returns flight details. |
-| `file_type` | The format of the file to download. This can be either "CSV" or "KML". |
-| `time` | The scheduled time of departure (STD) of the flight in UTC, as a Unix timestamp. |
-
-Here is an example of how to use this method:
-
-```javascript
-let historyData = await frApi.getHistoryData(flight, "csv", 1706529600);
-
-const buffer = Buffer.from(historyData);
-fs.writeFile("history_data.csv", buffer);
-```
-
-### Setting and Getting Real-time Flight Tracker Parameters
-
-Set it by using the `setFlightTrackerConfig(...)` method. It receives a `FlightTrackerConfig` dataclass instance, but you can also use keyword arguments directly to the method.
-
-Get the current configuration with the `getFlightTrackerConfig()` method, that returns a `FlightTrackerConfig` instance. Note: creating a new `FlightTrackerConfig` instance means resetting all parameters to default.
-
-```javascript
-let flightTracker = frApi.getFlightTrackerConfig();
-flightTracker.limit = 10
-
-frApi.setFlightTrackerConfig(flightTracker, ...);
-
-let flights = await frApi.getFlights(...); // Returns only 10 flights
-```
diff --git a/docs/projects.md b/docs/projects.md
index abb2550..b29383b 100644
--- a/docs/projects.md
+++ b/docs/projects.md
@@ -1,47 +1,45 @@
----
-title: Projects using FlightRadarAPI
-description: Nice projects that use FlightRadarAPI
----
+# Projects Using FlightRadarAPI
-
+Research, products and weekend builds made with FlightRadarAPI.
-- [__Automatic Calibration in Crowd-sourced Network of Spectrum Sensors__](https://dl.acm.org/doi/10.1145/3626111.3628187)
+::::{grid} 1 1 2 2
+:gutter: 3
- ---
+:::{grid-item-card} Automatic Calibration in Crowd-sourced Network of Spectrum Sensors
+:link: https://dl.acm.org/doi/10.1145/3626111.3628187
- By Ali Abedi, Joshua Sanz, Anant Sahai, from University of California (UC), Berkeley
+By Ali Abedi, Joshua Sanz, Anant Sahai, from University of California (UC), Berkeley
+:::
+:::{grid-item-card} Airline Status Tracker for top 10 Airport Departures in North America
+:link: https://people.ischool.berkeley.edu/~frank.song/flight.html
-- [__Airline Status Tracker for top 10 Airport Departures in North America__](https://people.ischool.berkeley.edu/~frank.song/flight.html)
+By Adeleke Coker, Frank Song, Greg Chi, from University of California (UC), Berkeley, School of Information
+:::
- ---
+:::{grid-item-card} Flight Tracker with Weather
+:link: https://magpi.raspberrypi.com/articles/flight-tracker-with-weather
- By Adeleke Coker, Frank Song, Greg Chi, from University of California (UC), Berkeley, School of Information
+By Adam Paulson, a Reddit user going by the name C0wsaysmoo
+:::
-- [__Flight Tracker with Weather__](https://magpi.raspberrypi.com/articles/flight-tracker-with-weather)
+:::{grid-item-card} Design and implementation project of an aircraft mobile node module for the SeamSAT-LEO constellation simulator
+:link: https://upcommons.upc.edu/bitstream/handle/2117/394691/TFG.pdf?sequence=2&isAllowed=y
- ---
+By David Anton Dobarro, graduate in Aerospace Technologies Engineering from Universitat Politècnica de Catalunya
+:::
- By Adam Paulson, a Reddit user going by the name C0wsaysmoo
+:::{grid-item-card} Fridge Flight Tracker
+:link: https://blog.colinwaddell.com/flight-tracker/
-- [__Design and implementation project of an aircraft mobile node module for the SeamSAT-LEO constellation simulator__](https://upcommons.upc.edu/bitstream/handle/2117/394691/TFG.pdf?sequence=2&isAllowed=y)
+By Colin Waddell, a Glasgow based programmer, website designer and electronics specialist
+:::
- ---
+:::{grid-item-card} Plane spotting Telegram Bot
+:link: https://github.com/ViLsonCake/avgeek-telegram-bot
- By David Anton Dobarro, graduate in Aerospace Technologies Engineering from Universitat Politècnica de Catalunya
+By Timofey Dmitrenko, aviation geek and Java Spring Boot programmer
+:::
+::::
-- [__Fridge Flight Tracker__](https://blog.colinwaddell.com/flight-tracker/)
-
- ---
-
- By Colin Waddell, a Glasgow based programmer, website designer and electronics specialist
-
-- [__Plane spotting Telegram Bot__](https://github.com/ViLsonCake/avgeek-telegram-bot)
-
- ---
-
- By Timofey Dmitrenko, aviation geek and Java Spring Boot programmer
-
-
-
-[Contribute Your Own :writing_hand:](https://github.com/JeanExtreme002/FlightRadarAPI/edit/main/docs/projects.md){ .md-button .md-button--primary }
+Built something with FlightRadarAPI? Add it to this [page](https://github.com/JeanExtreme002/FlightRadarAPI/edit/main/docs/projects.md).
diff --git a/docs/python.md b/docs/python.md
deleted file mode 100644
index d9ec6a8..0000000
--- a/docs/python.md
+++ /dev/null
@@ -1,161 +0,0 @@
----
-title: Python
-description: API Documentation for Python
----
-
-## Installation
-
-To install the FlightRadarAPI for Python, use the following pip command:
-
-```bash
-pip install FlightRadarAPI
-```
-
-## Basic Usage
-
-Start by importing the `FlightRadar24API` class and creating an instance of it:
-
-```python
-from FlightRadarAPI import FlightRadar24API
-fr_api = FlightRadar24API()
-```
-
-### Fetching Data
-
-You can fetch various types of data using the following methods:
-
-- **Flights list:**
-
- ```python
- flights = fr_api.get_flights(...) # Returns a list of Flight objects
- ```
-
-- **Airports list:**
-
- ```python
- airports = fr_api.get_airports(...) # Returns a list of Airport objects
- ```
-
- FR24 lists airports one page per country (and per state for the largest
- countries), so this makes one request per page: a handful for a few
- countries, a few hundred for every airport, `max_workers` at a time. The
- listing carries the name, codes and country only; use `get_airport(code)`
- for the position and altitude of an airport.
-
-- **Airlines list:**
-
- ```python
- airlines = fr_api.get_airlines()
- ```
-
-- **Zones list:**
-
- ```python
- zones = fr_api.get_zones()
- ```
-
-### Fetching Detailed Information
-
-Fetch more information about a specific flight or airport using the following methods:
-
-- **Flight details:**
-
- ```python
- flight_details = fr_api.get_flight_details(flight)
- flight.set_flight_details(flight_details)
-
- print("Flying to", flight.destination_airport_name)
- ```
-
-- **Airport details:**
-
- ```python
- airport_details = fr_api.get_airport_details(icao)
- ```
-
- !!! note
- Arrivals and departures can have a limit `flightLimit` (max value is 100) to display. When you need to reach more than 100 flights you can use additional parameter `page` to view other pages.
-
-## Advanced Usage
-
-### Fetching Flights Above a Specific Position
-
-Use the `get_bounds_by_point(...)` method to fetch flights above a specific position. This method takes `latitude` and `longitude` for your position and `radius` for the distance in meters from your position to designate a tracking area.
-
-```python
-# Your point is 52°34'04.7"N 13°16'57.5"E from Google Maps and radius 2km
-bounds = fr_api.get_bounds_by_point(52.567967, 13.282644, 2000)
-
-flights = fr_api.get_flights(bounds = bounds)
-```
-
-### Filtering Flights and Airports
-
-Use the `get_flights(...)` method to search for flights by area line, bounds (customized coordinates or obtained by the `get_zones()` method), aircraft registration or aircraft type.
-
-```python
-airline_icao = "UAE"
-aircraft_type = "B77W"
-
-# You may also set a custom region, such as: bounds = "73,-12,-156,38"
-zone = fr_api.get_zones()["northamerica"]
-bounds = fr_api.get_bounds(zone)
-
-emirates_flights = fr_api.get_flights(
- aircraft_type = aircraft_type,
- airline = airline_icao,
- bounds = bounds
-)
-```
-
-### Fetching Airport by ICAO or IATA
-
-```python
-lukla_airport = fr_api.get_airport(code = "VNLK", details = True)
-```
-
-### Calculating Distance Between Flights and Airports
-
-The `Flight` and `Airport` classes inherit from `Entity`, which contains the `get_distance_from(...)` method. This method returns the distance between the self instance and another entity in kilometers.
-
-```python
-airport = fr_api.get_airport("KJFK")
-distance = flight.get_distance_from(airport)
-
-print(f"The flight is {distance} km away from the airport.")
-```
-
-### Downloading Flight Data :material-information-outline:{ title="This requires a premium subscription" }
-
-
-```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)
-```
-
-!!! warning inline end
- If an invalid time is provided, a blank document will be returned.
-
-| Parameter | Description |
-| ------------- | ------------- |
-| `flight_id` | The ID of the flight. This can be obtained from any other function that returns flight details. |
-| `file_type` | The format of the file to download. This can be either "CSV" or "KML". |
-| `time` | The scheduled time of departure (STD) of the flight in UTC, as a Unix timestamp. |
-
-
-### 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.
-
-Get the current configuration with the `get_flight_tracker_config()` method, that returns a `FlightTrackerConfig` instance. Note: creating a new `FlightTrackerConfig` instance means resetting all parameters to default.
-
-```python
-flight_tracker = fr_api.get_flight_tracker_config()
-flight_tracker.limit = 10
-
-fr_api.set_flight_tracker_config(flight_tracker, ...)
-
-flights = fr_api.get_flights(...) # Returns only 10 flights
-```
diff --git a/docs/quickstart.md b/docs/quickstart.md
new file mode 100644
index 0000000..b2e8fba
--- /dev/null
+++ b/docs/quickstart.md
@@ -0,0 +1,176 @@
+# Quick Start
+
+Everything starts with a client. It needs no account and no API key: it reads
+the same public data the FlightRadar24 website shows.
+
+## Create a client
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+from FlightRadarAPI import FlightRadar24API
+
+fr_api = FlightRadar24API()
+```
+
+Calls are blocking and return when the data has arrived.
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const { FlightRadar24API } = require("flightradarapi");
+
+const frApi = new FlightRadar24API();
+```
+
+Every method that talks to FlightRadar24 returns a `Promise`. The examples use
+`await`, so run them inside an `async` function.
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+package main
+
+import (
+ "context"
+ "fmt"
+ "log"
+
+ "github.com/JeanExtreme002/FlightRadarAPI/go/flightradarapi"
+)
+
+func main() {
+ ctx := context.Background()
+ client := flightradarapi.New()
+
+ // ...
+}
+```
+
+Construction cannot fail. Every method that talks to FlightRadar24 takes a
+`context.Context` and returns an `error` alongside its result.
+:::
+::::
+
+The examples in the rest of this documentation assume the client above:
+`fr_api` in Python, `frApi` in Node.js, and `client` with a `ctx` in Go.
+
+## Fetch the basics
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+flights = fr_api.get_flights() # list of Flight
+airports = fr_api.get_airports(["brazil"]) # list of Airport
+airlines = fr_api.get_airlines() # list of dict
+zones = fr_api.get_zones() # dict
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const flights = await frApi.getFlights(); // Array of Flight
+const airports = await frApi.getAirports(["brazil"]); // Array of Airport
+const airlines = await frApi.getAirlines(); // Array of object
+const zones = frApi.getZones(); // object
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+flights, err := client.GetFlights(ctx, flightradarapi.FlightSearch{}) // []*Flight
+airports, err := client.GetAirports(ctx, []flightradarapi.Country{
+ flightradarapi.CountryBrazil,
+}) // []*Airport
+airlines, err := client.GetAirlines(ctx) // []Airline
+zones := client.GetZones() // map[string]Zone
+```
+:::
+::::
+
+## Follow one flight
+
+The live feed gives each flight its position, speed and codes. One more call
+adds the details: airline and aircraft names, airports, times and trail.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+flight = fr_api.get_flights(airline="UAE")[0]
+
+print(flight.callsign, flight.get_altitude(), flight.get_heading())
+
+flight.set_flight_details(fr_api.get_flight_details(flight))
+
+print("Flying to", flight.destination_airport_name)
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const [flight] = await frApi.getFlights("UAE");
+
+console.log(flight.callsign, flight.getAltitude(), flight.getHeading());
+
+flight.setFlightDetails(await frApi.getFlightDetails(flight));
+
+console.log("Flying to", flight.destinationAirportName);
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+flights, err := client.GetFlights(ctx, flightradarapi.FlightSearch{Airline: "UAE"})
+
+if err != nil {
+ log.Fatal(err)
+}
+
+flight := flights[0]
+
+fmt.Println(flight.Callsign, flight.GetAltitude(), flight.GetHeading())
+
+details, err := client.GetFlightDetails(ctx, flight)
+
+if err != nil {
+ log.Fatal(err)
+}
+
+flight.SetFlightDetails(details)
+
+fmt.Println("Flying to", flight.Details.DestinationAirportName)
+```
+:::
+::::
+
+## Where to go next
+
+- [Live flights](flights.md): filtering, details and the helpers of a flight.
+- [Zones and bounds](zones.md): looking at one region, or around one point.
+- [Airports](airports.md): one airport, or the airports of whole countries.
+- [Configuration](client.md): timeouts, concurrency and TLS impersonation.
+- [Errors and retries](errors.md): what can fail and how to retry it.
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..daa77b3
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,9 @@
+# Pinned so a compromised release cannot be pulled in automatically: these
+# packages execute during the docs build. Bump deliberately, not implicitly.
+# sphinx-rtd-theme 3.x does not yet support Sphinx 9.
+sphinx==8.2.3
+sphinx-rtd-theme==3.1.0
+myst-parser==5.2.0
+sphinx-copybutton==0.5.2
+sphinx-design==0.8.0
+sphinxext-opengraph==0.13.0
diff --git a/docs/searching.md b/docs/searching.md
new file mode 100644
index 0000000..d5efb28
--- /dev/null
+++ b/docs/searching.md
@@ -0,0 +1,65 @@
+# Searching
+
+`search` runs a query through the search of the FlightRadar24 website.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+results = fr_api.search("Emirates")
+
+for category, items in results.items():
+ print(category, len(items))
+```
+
+The signature is `search(query, limit=50)`.
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const results = await frApi.search("Emirates");
+
+for (const [category, items] of Object.entries(results)) {
+ console.log(category, items.length);
+}
+```
+
+The signature is `search(query, limit = 50)`.
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+results, err := client.Search(ctx, "Emirates", 0)
+
+if err != nil {
+ log.Fatal(err)
+}
+
+for category, items := range results {
+ fmt.Println(category, len(items))
+}
+```
+
+A limit of zero means the default of 50.
+:::
+::::
+
+## The result
+
+The result groups what was found by category. Each key is a category, as
+FlightRadar24 names it in the response, and each value is the list of results of
+that category, as FlightRadar24 sends them.
+
+`limit` is sent to FlightRadar24 as the maximum number of results.
+
+```{note}
+The categories and the fields of each result are defined by FlightRadar24 and
+may change. Inspect a response before relying on a particular field.
+```
diff --git a/docs/tracker-config.md b/docs/tracker-config.md
new file mode 100644
index 0000000..7b6ea31
--- /dev/null
+++ b/docs/tracker-config.md
@@ -0,0 +1,215 @@
+# Flight Tracker Settings
+
+The client keeps a set of options that it sends with every
+[flight search](flights.md): which data sources to include, whether to show
+aircraft on the ground, how many flights to return. They are the same switches
+as the filters of the FlightRadar24 map, and they live in a
+`FlightTrackerConfig`.
+
+## Options
+
+Every value is a string holding a number. The switches take `"1"` (on) or `"0"`
+(off).
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+| Option | Default | Meaning |
+|---|---|---|
+| `faa` | `"1"` | Include data from the FAA |
+| `satellite` | `"1"` | Include satellite-based tracking |
+| `mlat` | `"1"` | Include MLAT (multilateration) positions |
+| `flarm` | `"1"` | Include FLARM positions |
+| `adsb` | `"1"` | Include ADS-B positions |
+| `gnd` | `"1"` | Include aircraft on the ground |
+| `air` | `"1"` | Include aircraft in the air |
+| `vehicles` | `"1"` | Include ground vehicles |
+| `estimated` | `"1"` | Include estimated positions |
+| `maxage` | `"14400"` | Maximum age of a position, in seconds |
+| `gliders` | `"1"` | Include gliders |
+| `stats` | `"1"` | Include the feed statistics in the response |
+| `limit` | `"5000"` | Maximum number of flights returned |
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+| Option | Default | Meaning |
+|---|---|---|
+| `faa` | `"1"` | Include data from the FAA |
+| `satellite` | `"1"` | Include satellite-based tracking |
+| `mlat` | `"1"` | Include MLAT (multilateration) positions |
+| `flarm` | `"1"` | Include FLARM positions |
+| `adsb` | `"1"` | Include ADS-B positions |
+| `gnd` | `"1"` | Include aircraft on the ground |
+| `air` | `"1"` | Include aircraft in the air |
+| `vehicles` | `"1"` | Include ground vehicles |
+| `estimated` | `"1"` | Include estimated positions |
+| `maxage` | `"14400"` | Maximum age of a position, in seconds |
+| `gliders` | `"1"` | Include gliders |
+| `stats` | `"1"` | Include the feed statistics in the response |
+| `limit` | `"5000"` | Maximum number of flights returned |
+:::
+
+:::{tab-item} Go
+:sync: go
+
+| Field | Default | Meaning |
+|---|---|---|
+| `FAA` | `"1"` | Include data from the FAA |
+| `Satellite` | `"1"` | Include satellite-based tracking |
+| `MLAT` | `"1"` | Include MLAT (multilateration) positions |
+| `FLARM` | `"1"` | Include FLARM positions |
+| `ADSB` | `"1"` | Include ADS-B positions |
+| `GND` | `"1"` | Include aircraft on the ground |
+| `Air` | `"1"` | Include aircraft in the air |
+| `Vehicles` | `"1"` | Include ground vehicles |
+| `Estimated` | `"1"` | Include estimated positions |
+| `MaxAge` | `"14400"` | Maximum age of a position, in seconds |
+| `Gliders` | `"1"` | Include gliders |
+| `Stats` | `"1"` | Include the feed statistics in the response |
+| `Limit` | `"5000"` | Maximum number of flights returned |
+:::
+
+::::
+
+```{note}
+These are the query parameters of FlightRadar24's own feed, and FlightRadar24
+does not document them. The meanings above describe how its map uses them.
+```
+
+## Changing the settings
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+Pass single options as keyword arguments:
+
+```python
+fr_api.set_flight_tracker_config(limit=10, gnd=0)
+
+flights = fr_api.get_flights() # at most 10 flights, none on the ground
+```
+
+Or read the current settings, change them and set them back:
+
+```python
+config = fr_api.get_flight_tracker_config()
+config.limit = "10"
+
+fr_api.set_flight_tracker_config(config)
+```
+
+Both forms can be combined: `set_flight_tracker_config(config, gnd=0)` replaces
+the settings with `config` and then applies the keyword arguments on top.
+
+Keyword values may be integers or numeric strings. An unknown option raises
+`KeyError` and a value that is not a number raises `TypeError`.
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+Pass single options as an object, in the second argument:
+
+```javascript
+frApi.setFlightTrackerConfig(null, { limit: 10, gnd: 0 });
+
+const flights = await frApi.getFlights(); // at most 10 flights, none on the ground
+```
+
+Or read the current settings, change them and set them back:
+
+```javascript
+const config = frApi.getFlightTrackerConfig();
+config.limit = 10;
+
+frApi.setFlightTrackerConfig(config);
+```
+
+Both forms can be combined: `setFlightTrackerConfig(config, { gnd: 0 })`
+replaces the settings with `config` and then applies the object on top.
+
+Values may be numbers or numeric strings. An unknown option throws `RangeError`
+and a value that is not a number throws `TypeError`, both when calling
+`setFlightTrackerConfig` and when assigning to a `FlightTrackerConfig`.
+:::
+
+:::{tab-item} Go
+:sync: go
+
+Pass single options as a map, in the second argument:
+
+```go
+err := client.SetFlightTrackerConfig(nil, map[string]string{"limit": "10", "gnd": "0"})
+
+flights, err := client.GetFlights(ctx, flightradarapi.FlightSearch{}) // at most 10 flights, none on the ground
+```
+
+The keys of the map are the field names in lower case: `limit`, `maxage`, `gnd`.
+
+Or read the current settings, change them and set them back:
+
+```go
+config := client.GetFlightTrackerConfig()
+config.Limit = "10"
+
+err := client.SetFlightTrackerConfig(&config, nil)
+```
+
+Either argument may be `nil`. With both, the config replaces the settings and
+the map is applied on top. A field left empty in the config takes its default,
+so `&flightradarapi.FlightTrackerConfig{Limit: "10"}` changes the limit only.
+
+An unknown option or a value that is not a number returns an error, and a
+rejected update leaves the current settings untouched.
+:::
+::::
+
+## Reading and resetting
+
+Reading the settings returns a copy: changing it has no effect until you set it
+back. A new `FlightTrackerConfig` carries the defaults, so setting one resets
+everything.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+from FlightRadarAPI import FlightTrackerConfig
+
+fr_api.set_flight_tracker_config(FlightTrackerConfig()) # back to the defaults
+fr_api.set_flight_tracker_config(FlightTrackerConfig(limit="100")) # defaults, except the limit
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const { FlightTrackerConfig } = require("flightradarapi");
+
+frApi.setFlightTrackerConfig(new FlightTrackerConfig()); // back to the defaults
+frApi.setFlightTrackerConfig(new FlightTrackerConfig({ limit: 100 })); // defaults, except the limit
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+defaults := flightradarapi.NewFlightTrackerConfig()
+
+err := client.SetFlightTrackerConfig(&defaults, nil) // back to the defaults
+```
+:::
+::::
diff --git a/docs/zones.md b/docs/zones.md
new file mode 100644
index 0000000..b6cf332
--- /dev/null
+++ b/docs/zones.md
@@ -0,0 +1,191 @@
+# Zones and Bounds
+
+The flight feed looks at a rectangle of the globe, described by a **bounds**
+string. You can write one by hand, take it from a named **zone**, or compute it
+around a point.
+
+## The bounds string
+
+Bounds are four comma-separated coordinates, `"y1,y2,x1,x2"`:
+
+| Part | Meaning |
+|---|---|
+| `y1` | Latitude of the top edge (north) |
+| `y2` | Latitude of the bottom edge (south) |
+| `x1` | Longitude of the left edge (west) |
+| `x2` | Longitude of the right edge (east) |
+
+For example, `"72.57,33.57,-16.96,53.05"` covers Europe. Pass the string as the
+bounds filter of a [flight search](flights.md#filtering).
+
+## Zones
+
+FlightRadar24 names the major regions of the globe. They are bundled with the
+SDK, so reading them makes no request.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+zones = fr_api.get_zones()
+
+europe = zones["europe"]
+# {"tl_y": 72.57, "tl_x": -16.96, "br_y": 33.57, "br_x": 53.05, "subzones": {...}}
+
+bounds = fr_api.get_bounds(europe) # "72.57,33.57,-16.96,53.05"
+flights = fr_api.get_flights(bounds=bounds)
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const zones = frApi.getZones();
+
+const europe = zones["europe"];
+// { tl_y: 72.57, tl_x: -16.96, br_y: 33.57, br_x: 53.05, subzones: {...} }
+
+const bounds = frApi.getBounds(europe); // "72.57,33.57,-16.96,53.05"
+const flights = await frApi.getFlights(null, bounds);
+```
+
+`getZones()` and `getBounds()` are synchronous.
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+zones := client.GetZones()
+
+europe := zones["europe"]
+// Zone{TLY: 72.57, TLX: -16.96, BRY: 33.57, BRX: 53.05, Subzones: map[string]Zone{...}}
+
+bounds := client.GetBounds(europe) // "72.57,33.57,-16.96,53.05"
+flights, err := client.GetFlights(ctx, flightradarapi.FlightSearch{Bounds: bounds})
+```
+:::
+::::
+
+A zone is the top-left corner (`tl_y`, `tl_x`) and the bottom-right corner
+(`br_y`, `br_x`) of the rectangle. Some zones are split further, under
+`subzones`:
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+germany = zones["europe"]["subzones"]["germany"]
+london = zones["europe"]["subzones"]["uk"]["subzones"]["london"]
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const germany = zones["europe"]["subzones"]["germany"];
+const london = zones["europe"]["subzones"]["uk"]["subzones"]["london"];
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+germany := zones["europe"].Subzones["germany"]
+london := zones["europe"].Subzones["uk"].Subzones["london"]
+```
+:::
+::::
+
+## Around a point
+
+To look at the sky above one place, build the bounds from its coordinates and a
+radius in meters. The result is the square that extends that distance from the
+point in each direction.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+# 52°34'04.7"N 13°16'57.5"E, and 2 km around it
+bounds = fr_api.get_bounds_by_point(52.567967, 13.282644, 2000)
+
+flights = fr_api.get_flights(bounds=bounds)
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+// 52°34'04.7"N 13°16'57.5"E, and 2 km around it
+const bounds = frApi.getBoundsByPoint(52.567967, 13.282644, 2000);
+
+const flights = await frApi.getFlights(null, bounds);
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+// 52°34'04.7"N 13°16'57.5"E, and 2 km around it
+bounds := client.GetBoundsByPoint(52.567967, 13.282644, 2000)
+
+flights, err := client.GetFlights(ctx, flightradarapi.FlightSearch{Bounds: bounds})
+```
+:::
+::::
+
+## A custom region
+
+Any rectangle works: write the string yourself, or describe it as a zone.
+
+::::{tab-set}
+:sync-group: lang
+
+:::{tab-item} Python
+:sync: python
+
+```python
+flights = fr_api.get_flights(bounds="73,-12,-156,38")
+
+# Or from the corners
+bounds = fr_api.get_bounds({"tl_y": 73, "tl_x": -156, "br_y": -12, "br_x": 38})
+```
+:::
+
+:::{tab-item} Node.js
+:sync: node
+
+```javascript
+const flights = await frApi.getFlights(null, "73,-12,-156,38");
+
+// Or from the corners
+const bounds = frApi.getBounds({ tl_y: 73, tl_x: -156, br_y: -12, br_x: 38 });
+```
+:::
+
+:::{tab-item} Go
+:sync: go
+
+```go
+flights, err := client.GetFlights(ctx, flightradarapi.FlightSearch{Bounds: "73,-12,-156,38"})
+
+// Or from the corners
+bounds := client.GetBounds(flightradarapi.Zone{TLY: 73, TLX: -156, BRY: -12, BRX: 38})
+```
+:::
+::::
diff --git a/go/README.md b/go/README.md
index 618b070..4adb34b 100644
--- a/go/README.md
+++ b/go/README.md
@@ -69,4 +69,4 @@ for _, country := range flightradarapi.AllCountries() { }
```
## Documentation
-Explore the documentation of FlightRadarAPI package through [this site](https://JeanExtreme002.github.io/FlightRadarAPI/), or read the [Go reference](https://pkg.go.dev/github.com/JeanExtreme002/FlightRadarAPI/go/flightradarapi).
+Explore the documentation of FlightRadarAPI package through [this site](https://flightradarapi.readthedocs.io/), or read the [Go reference](https://pkg.go.dev/github.com/JeanExtreme002/FlightRadarAPI/go/flightradarapi).
diff --git a/mkdocs.yml b/mkdocs.yml
deleted file mode 100644
index bf52fc4..0000000
--- a/mkdocs.yml
+++ /dev/null
@@ -1,63 +0,0 @@
-site_name: FlightRadarAPI
-repo_url: https://github.com/JeanExtreme002/FlightRadarAPI
-docs_dir: docs
-site_description: Documentation for the FlightRadarAPI
-site_author: JeanExtreme002
-edit_uri: edit/main/docs/
-
-nav:
- - Home: index.md
- - Python: python.md
- - Node.js: nodejs.md
- - Go: go.md
- - Projects Using FlightRadarAPI: projects.md
-
-theme:
- name: material
- logo: assets/logo.png
- favicon: assets/favicon.ico
-
- features:
- - navigation.instant
- - navigation.instant.progress
- - content.code.copy
- - content.action.edit
- - search.suggest
- - search.highlight
- - search.share
- - content.tooltips
- - content.tabs.link
-
- icon:
- repo: fontawesome/brands/github
- annotation: material/arrow-right-circle
-
- palette:
- - primary: indigo
- - accent: yellow
-
-extra:
- social:
- - icon: fontawesome/brands/github
- link: https://github.com/JeanExtreme002
-
-markdown_extensions:
- - admonition
- - pymdownx.details
- - attr_list
- - md_in_html
- - abbr
- - attr_list
- - pymdownx.snippets
- - pymdownx.emoji:
- emoji_index: !!python/name:material.extensions.emoji.twemoji
- emoji_generator: !!python/name:material.extensions.emoji.to_svg
- - pymdownx.tabbed:
- alternate_style: true
- - pymdownx.superfences
-
-plugins:
- - git-committers:
- repository: JeanExtreme002/FlightRadarAPI
- branch: main
- - search
\ No newline at end of file
diff --git a/nodejs/FlightRadarAPI/index.d.ts b/nodejs/FlightRadarAPI/index.d.ts
index 1af0f81..d484ff2 100644
--- a/nodejs/FlightRadarAPI/index.d.ts
+++ b/nodejs/FlightRadarAPI/index.d.ts
@@ -11,12 +11,16 @@ export interface Zone {
}
/**
- * Options for TLS impersonation. Currently maps Chrome major versions to
- * the ciphers/sigalgs/curves the runtime should use.
+ * TLS impersonation profile. Each field left out keeps the value of the
+ * bundled Chrome 136 profile.
*/
export interface ImpersonateOptions {
- /** Chrome major version label, e.g. "chrome136". Defaults to the latest supported. */
- profile?: string;
+ /** OpenSSL cipher names, in the order offered. */
+ ciphers?: readonly string[];
+ /** OpenSSL signature algorithm names, in the order offered. */
+ sigalgs?: readonly string[];
+ /** Colon-separated curve names, e.g. "X25519:P-256:P-384". */
+ ecdhCurve?: string;
}
/**
diff --git a/nodejs/README.md b/nodejs/README.md
index ccf63be..acc1259 100644
--- a/nodejs/README.md
+++ b/nodejs/README.md
@@ -67,4 +67,4 @@ Countries.FRANCE // "france"
```
## Documentation
-Explore the documentation of FlightRadarAPI package through [this site](https://JeanExtreme002.github.io/FlightRadarAPI/).
+Explore the documentation of FlightRadarAPI package through [this site](https://flightradarapi.readthedocs.io/).
diff --git a/nodejs/tests/index.test-d.ts b/nodejs/tests/index.test-d.ts
index f7641a4..639d5e7 100644
--- a/nodejs/tests/index.test-d.ts
+++ b/nodejs/tests/index.test-d.ts
@@ -9,6 +9,9 @@ import {
const api = new FlightRadar24API();
expectType(new FlightRadar24API({timeout: 5000, maxWorkers: 4}));
+expectType(new FlightRadar24API({
+ impersonate: {ciphers: ["TLS_AES_128_GCM_SHA256"], sigalgs: ["rsa_pss_rsae_sha256"], ecdhCurve: "X25519:P-256"},
+}));
// getFlights
expectType>(api.getFlights());
@@ -70,3 +73,4 @@ expectType(flight.checkInfo({airlineIcao: "TAM"}));
expectError(api.getFlights(123));
expectError(api.getBounds({tl_y: 1}));
expectError(new FlightRadar24API({timeout: "5000"}));
+expectError(new FlightRadar24API({impersonate: {profile: "chrome136"}}));
diff --git a/python/Makefile b/python/Makefile
index 6e93445..de711f1 100644
--- a/python/Makefile
+++ b/python/Makefile
@@ -64,8 +64,8 @@ help:
@echo " $(YELLOW)check-deps$(NC) - Check for outdated dependencies"
@echo " $(YELLOW)update-deps$(NC) - Update dependencies"
@echo " $(YELLOW)security$(NC) - Run security audit"
- @echo " $(YELLOW)docs$(NC) - Build the MkDocs site (output in ../site/)"
- @echo " $(YELLOW)docs-serve$(NC) - Serve the MkDocs site locally with auto-reload"
+ @echo " $(YELLOW)docs$(NC) - Build the documentation (see ../Makefile)"
+ @echo " $(YELLOW)docs-serve$(NC) - Serve the documentation locally (see ../Makefile)"
@echo " $(YELLOW)venv$(NC) - Create virtual environment"
@echo " $(YELLOW)all$(NC) - Run full pipeline (install, lint, test, build)"
@@ -245,22 +245,16 @@ security:
$(PYTHON) -m pip_audit
@echo "$(GREEN)Security audit completed!$(NC)"
-# Build the MkDocs site. The configuration (`mkdocs.yml`) and the `docs/`
-# directory live in the repository root, so we invoke MkDocs from one level
-# up. Requires `mkdocs-material` (install with `pip install mkdocs-material`
-# — kept out of `install-dev` because the docs site is rebuilt by CI, not
-# every developer needs the dependency locally).
+# The documentation belongs to the whole repository, so its targets live in the
+# Makefile one level up (`make install-docs` there installs the tooling). These
+# two forward to it for whoever is working from this directory.
.PHONY: docs
docs:
- @echo "$(GREEN)Building MkDocs site...$(NC)"
- cd .. && mkdocs build
- @echo "$(GREEN)Site generated in ../site/$(NC)"
+ $(MAKE) -C .. docs
-# Serve the MkDocs site locally with auto-reload.
.PHONY: docs-serve
docs-serve:
- @echo "$(GREEN)Serving MkDocs site at http://127.0.0.1:8000 ...$(NC)"
- cd .. && mkdocs serve
+ $(MAKE) -C .. docs-serve
# Full development pipeline. Uses `install-dev` (not `install`) so that
# `lint`, `type-check`, and `test` have flake8 / mypy / pytest available
diff --git a/python/README.md b/python/README.md
index 4f045ef..b675c31 100644
--- a/python/README.md
+++ b/python/README.md
@@ -12,7 +12,7 @@ This SDK should only be used for your own educational purposes. If you are inter
[](https://www.npmjs.com/package/flightradarapi)
[](https://www.npmjs.com/package/flightradarapi)
[](https://pkg.go.dev/github.com/JeanExtreme002/FlightRadarAPI/go/flightradarapi)
-[](https://go.dev/dl/)
+[](https://go.dev/dl/)
[](https://pypi.org/project/FlightRadarAPI/)
[](https://pypi.org/project/FlightRadarAPI/)
@@ -47,4 +47,4 @@ zones = fr_api.get_zones()
```
## Documentation
-Explore the documentation of FlightRadarAPI package through [this site](https://JeanExtreme002.github.io/FlightRadarAPI/).
+Explore the documentation of FlightRadarAPI package through [this site](https://flightradarapi.readthedocs.io/).
diff --git a/python/pyproject.toml b/python/pyproject.toml
index bf1ef3d..883b172 100644
--- a/python/pyproject.toml
+++ b/python/pyproject.toml
@@ -43,7 +43,7 @@ tests = [
[project.urls]
"Homepage" = "https://github.com/JeanExtreme002/FlightRadarAPI"
"Source Code" = "https://github.com/JeanExtreme002/FlightRadarAPI"
-"Documentation" = "https://jeanextreme002.github.io/FlightRadarAPI/"
+"Documentation" = "https://flightradarapi.readthedocs.io/"
"Bug Reports" = "https://github.com/JeanExtreme002/FlightRadarAPI/issues"
[tool.hatch.version]
FlightRadarAPI
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+