aviationstack-serversdk

Getting Started with Aviationstack

Introduction

AviationStack API provides real-time and historical aviation data including flights, airports, airlines, and more. This API allows you to access comprehensive aviation information for various use cases.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install aviationstack-serversdk@1.0.0

For additional package details, see the Npm page for the aviationstack-serversdk@1.0.0 npm.

Test the SDK

To validate the functionality of this SDK, you can execute all tests located in the test directory. This SDK utilizes Jest as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

npm run test

Or you can also run tests with coverage report:

npm run test:coverage

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
timeout	number	Timeout for API calls. Default: 0
httpClientOptions	Partial<HttpClientOptions>	Stable configurable http client options.
unstableHttpClientOptions	any	Unstable configurable http client options.
customQueryAuthenticationCredentials	CustomQueryAuthenticationCredentials	The credential object for customQueryAuthentication

The API client can be initialized as follows:

import { Client } from 'aviationstack-serversdk';

const client = new Client({
  customQueryAuthenticationCredentials: {
    'access_key': 'access_key'
  },
  timeout: 0,
});

Authorization

This API uses the following authentication schemes.

• ApiKeyAuth (Custom Query Parameter)

List of APIs

• Aircraft Types
• Flight Schedules
• Flight Future Schedules
• Flights
• Routes
• Airports
• Airlines
• Airplanes
• Taxes
• Cities
• Countries

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError