Skip to main content

Getting Started with Aviationstack

Introduction

Quick Start Guide

Step 1: Your API Access Key

To get started quickly, you need to fork the Aviationstack Postman Collection. Simply click the button below to fork it.

Step 2: Get your API Access Key
  1. Go to the Aviationstack website and choose the right subscription plan for your particular project.
  2. Get your personal API Access Key on the Dashboard to authenticate with the API. Keep it safe! You can reset it at any time in your Account Dashboard.

Step 3: Make your first API call

Aviationstack Postman collection contains all the endpoints supported by Aviationstack API.

  1. Flights
  2. Routes
  3. Airports
  4. Airlines
  5. Airplanes
  6. Aircraft Types
  7. Taxes
  8. Cities
  9. Countries
  10. Flights Schedules
  11. Flights Future Schedules

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install aviation-stack-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/aviation-stack-sdk/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
custom_query_authentication_credentials CustomQueryAuthenticationCredentials The credential object for Custom Query Parameter

The API client can be initialized as follows:

from aviationstack.aviationstack_client import AviationstackClient
from aviationstack.configuration import Environment
from aviationstack.http.auth.custom_query_authentication import CustomQueryAuthenticationCredentials

client = AviationstackClient(
    custom_query_authentication_credentials=CustomQueryAuthenticationCredentials(
        access_key='access_key'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

HTTP

Utilities

Metadata

Release files for aviation-stack-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aviation-stack-sdk 1.0.0
File Size Uploaded Provenance Actions
aviation_stack_sdk-1.0.0.tar.gz 30.0 kB Without provenance Details for aviation_stack_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aviation-stack-sdk 1.0.0
File Interpreter ABI Platform Actions
aviation_stack_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for aviation_stack_sdk-1.0.0-py3-none-any.whl

Total release size: 123.9 kB

Release files / aviation_stack_sdk-1.0.0.tar.gz

Download URL aviation_stack_sdk-1.0.0.tar.gz
Size 30.0 kB
Tags Source
SHA-256 checksum
How to use checksums
0d0f3f9995547a4d79a5e10714567e64a3c5b2a43a627513296c6dc61d1676b4
BLAKE2b-256 checksum
How to use checksums
e8c7b0523ebb9390968eafde14ef6ceae24e77c41cec572c55a8ad97ea2d9b10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / aviation_stack_sdk-1.0.0-py3-none-any.whl

Download URL aviation_stack_sdk-1.0.0-py3-none-any.whl
Size 93.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
786fee5b667c887cf999c8086a5ab5c0ec77837290e6f3a8b9248493feccef97
BLAKE2b-256 checksum
How to use checksums
3ed97ce7e5d21f68c7fb8030434d4695b3d9c751b2627594fa51ef9e117e3e6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Security for aviation-stack-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page