# fr24-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
- Package version: 1.0.0
- Generator version: 7.10.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import fr24_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import fr24_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import fr24_client
from fr24_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fr24api.flightradar24.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fr24_client.Configuration(
host = "https://fr24api.flightradar24.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: Authorization
configuration = fr24_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with fr24_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = fr24_client.AirlinesLightApi(api_client)
accept_version = 'v1' # str | Specifies the FR24 API version. The currently available version is `v1`. (default to 'v1')
icao = 'SAS' # str | Airline ICAO code.
try:
# Get basic airline information by ICAO code
api_response = api_instance.get_airlines_light(accept_version, icao)
print("The response of AirlinesLightApi->get_airlines_light:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AirlinesLightApi->get_airlines_light: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://fr24api.flightradar24.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AirlinesLightApi* | [**get_airlines_light**](docs/AirlinesLightApi.md#get_airlines_light) | **GET** /api/static/airlines/{icao}/light | Get basic airline information by ICAO code
*AirportsFullApi* | [**get_airports_full**](docs/AirportsFullApi.md#get_airports_full) | **GET** /api/static/airports/{code}/full | Get detailed airport information by code
*AirportsLightApi* | [**get_airports_light**](docs/AirportsLightApi.md#get_airports_light) | **GET** /api/static/airports/{code}/light | Get basic airline information by code
*FlightTracksApi* | [**get_flights_tracks**](docs/FlightTracksApi.md#get_flights_tracks) | **GET** /api/flight-tracks | Get positional tracks for a specific live flight
*HistoricFlightPositionsFullApi* | [**get_historic_flight_positions_full**](docs/HistoricFlightPositionsFullApi.md#get_historic_flight_positions_full) | **GET** /api/historic/flight-positions/full | Get historical flight positions
*HistoricFlightPositionsLightApi* | [**get_historic_flight_positions_light**](docs/HistoricFlightPositionsLightApi.md#get_historic_flight_positions_light) | **GET** /api/historic/flight-positions/light | Get historical flight positions with basic details
*LiveFlightPositionsFullApi* | [**get_live_flight_positions_full**](docs/LiveFlightPositionsFullApi.md#get_live_flight_positions_full) | **GET** /api/live/flight-positions/full | Get real-time flight positions with detailed information
*LiveFlightPositionsLightApi* | [**get_live_flight_positions_light**](docs/LiveFlightPositionsLightApi.md#get_live_flight_positions_light) | **GET** /api/live/flight-positions/light | Get real-time flight positions
*UsageApi* | [**get_api_usage**](docs/UsageApi.md#get_api_usage) | **GET** /api/usage | Get info on API account usage
## Documentation For Models
- [Airline](docs/Airline.md)
- [Airport](docs/Airport.md)
- [AirportDetailed](docs/AirportDetailed.md)
- [Country](docs/Country.md)
- [Flight](docs/Flight.md)
- [FlightPositions](docs/FlightPositions.md)
- [FlightTracks](docs/FlightTracks.md)
- [FlightTracksTracksInner](docs/FlightTracksTracksInner.md)
- [GetAirlinesLight400Response](docs/GetAirlinesLight400Response.md)
- [GetAirlinesLight404Response](docs/GetAirlinesLight404Response.md)
- [GetAirportsFull400Response](docs/GetAirportsFull400Response.md)
- [GetAirportsFull404Response](docs/GetAirportsFull404Response.md)
- [GetApiUsage200Response](docs/GetApiUsage200Response.md)
- [GetFlightsTracks400Response](docs/GetFlightsTracks400Response.md)
- [GetFlightsTracks404Response](docs/GetFlightsTracks404Response.md)
- [GetLiveFlightPositionsFull200Response](docs/GetLiveFlightPositionsFull200Response.md)
- [GetLiveFlightPositionsFull400Response](docs/GetLiveFlightPositionsFull400Response.md)
- [GetLiveFlightPositionsLight200Response](docs/GetLiveFlightPositionsLight200Response.md)
- [Timezone](docs/Timezone.md)
- [UsageLogSummary](docs/UsageLogSummary.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="Authorization"></a>
### Authorization
- **Type**: Bearer authentication
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "fr24_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Flightradar24 API endpoints",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/9f/77/240f60f69f35279ee1c5ff82105c53d167af3b3b1adbd60f98da94ab1a51/fr24_client-1.0.0.tar.gz",
"platform": null,
"description": "# fr24-client\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 1.0.0\n- Generator version: 7.10.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport fr24_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport fr24_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport fr24_client\nfrom fr24_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://fr24api.flightradar24.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = fr24_client.Configuration(\n host = \"https://fr24api.flightradar24.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: Authorization\nconfiguration = fr24_client.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith fr24_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = fr24_client.AirlinesLightApi(api_client)\n accept_version = 'v1' # str | Specifies the FR24 API version. The currently available version is `v1`. (default to 'v1')\n icao = 'SAS' # str | Airline ICAO code.\n\n try:\n # Get basic airline information by ICAO code\n api_response = api_instance.get_airlines_light(accept_version, icao)\n print(\"The response of AirlinesLightApi->get_airlines_light:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AirlinesLightApi->get_airlines_light: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://fr24api.flightradar24.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AirlinesLightApi* | [**get_airlines_light**](docs/AirlinesLightApi.md#get_airlines_light) | **GET** /api/static/airlines/{icao}/light | Get basic airline information by ICAO code\n*AirportsFullApi* | [**get_airports_full**](docs/AirportsFullApi.md#get_airports_full) | **GET** /api/static/airports/{code}/full | Get detailed airport information by code\n*AirportsLightApi* | [**get_airports_light**](docs/AirportsLightApi.md#get_airports_light) | **GET** /api/static/airports/{code}/light | Get basic airline information by code\n*FlightTracksApi* | [**get_flights_tracks**](docs/FlightTracksApi.md#get_flights_tracks) | **GET** /api/flight-tracks | Get positional tracks for a specific live flight\n*HistoricFlightPositionsFullApi* | [**get_historic_flight_positions_full**](docs/HistoricFlightPositionsFullApi.md#get_historic_flight_positions_full) | **GET** /api/historic/flight-positions/full | Get historical flight positions\n*HistoricFlightPositionsLightApi* | [**get_historic_flight_positions_light**](docs/HistoricFlightPositionsLightApi.md#get_historic_flight_positions_light) | **GET** /api/historic/flight-positions/light | Get historical flight positions with basic details\n*LiveFlightPositionsFullApi* | [**get_live_flight_positions_full**](docs/LiveFlightPositionsFullApi.md#get_live_flight_positions_full) | **GET** /api/live/flight-positions/full | Get real-time flight positions with detailed information\n*LiveFlightPositionsLightApi* | [**get_live_flight_positions_light**](docs/LiveFlightPositionsLightApi.md#get_live_flight_positions_light) | **GET** /api/live/flight-positions/light | Get real-time flight positions\n*UsageApi* | [**get_api_usage**](docs/UsageApi.md#get_api_usage) | **GET** /api/usage | Get info on API account usage\n\n\n## Documentation For Models\n\n - [Airline](docs/Airline.md)\n - [Airport](docs/Airport.md)\n - [AirportDetailed](docs/AirportDetailed.md)\n - [Country](docs/Country.md)\n - [Flight](docs/Flight.md)\n - [FlightPositions](docs/FlightPositions.md)\n - [FlightTracks](docs/FlightTracks.md)\n - [FlightTracksTracksInner](docs/FlightTracksTracksInner.md)\n - [GetAirlinesLight400Response](docs/GetAirlinesLight400Response.md)\n - [GetAirlinesLight404Response](docs/GetAirlinesLight404Response.md)\n - [GetAirportsFull400Response](docs/GetAirportsFull400Response.md)\n - [GetAirportsFull404Response](docs/GetAirportsFull404Response.md)\n - [GetApiUsage200Response](docs/GetApiUsage200Response.md)\n - [GetFlightsTracks400Response](docs/GetFlightsTracks400Response.md)\n - [GetFlightsTracks404Response](docs/GetFlightsTracks404Response.md)\n - [GetLiveFlightPositionsFull200Response](docs/GetLiveFlightPositionsFull200Response.md)\n - [GetLiveFlightPositionsFull400Response](docs/GetLiveFlightPositionsFull400Response.md)\n - [GetLiveFlightPositionsLight200Response](docs/GetLiveFlightPositionsLight200Response.md)\n - [Timezone](docs/Timezone.md)\n - [UsageLogSummary](docs/UsageLogSummary.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"Authorization\"></a>\n### Authorization\n\n- **Type**: Bearer authentication\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Flightradar24 API endpoints",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" flightradar24 api endpoints"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2529a29bcdda6a6b1cdbdb93eb9cca683e0047100f95b82f613524c63150694c",
"md5": "9d796718de1dadc0c4ae50f8dbe7bee1",
"sha256": "7135f0d8984eed1a4d4db6810f74e3497f3c957278b058705cd2d5d39b6405cd"
},
"downloads": -1,
"filename": "fr24_client-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d796718de1dadc0c4ae50f8dbe7bee1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 76852,
"upload_time": "2024-10-25T13:09:31",
"upload_time_iso_8601": "2024-10-25T13:09:31.275334Z",
"url": "https://files.pythonhosted.org/packages/25/29/a29bcdda6a6b1cdbdb93eb9cca683e0047100f95b82f613524c63150694c/fr24_client-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f77240f60f69f35279ee1c5ff82105c53d167af3b3b1adbd60f98da94ab1a51",
"md5": "86728f7355228108aacd280648f5bcf2",
"sha256": "5715d3c383ed65adee5d44299af74b80e4ebecf27f61d787423c759d4eb1ea1f"
},
"downloads": -1,
"filename": "fr24_client-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "86728f7355228108aacd280648f5bcf2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 34753,
"upload_time": "2024-10-25T13:09:33",
"upload_time_iso_8601": "2024-10-25T13:09:33.232626Z",
"url": "https://files.pythonhosted.org/packages/9f/77/240f60f69f35279ee1c5ff82105c53d167af3b3b1adbd60f98da94ab1a51/fr24_client-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 13:09:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "fr24_client"
}
JSON
