AviationStack Data Source

AviationStack
Create a New Data Flow
-
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.
-
Select the AviationStack connector tile from the list of available connectors. Then, select the credential that will be used to connect to AviationStack, and click Next; or, create a new AviationStack credential for use in this flow.
-
In Nexla, AviationStack data sources can be created using pre-built endpoint templates, which expedite source setup for common AviationStack endpoints. Each template is designed specifically for the corresponding AviationStack endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.AviationStack sources can also be configured manually, allowing you to ingest data from AviationStack endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.
Configure Using a Template
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common AviationStack endpoints. Each template is designed specifically for the corresponding AviationStack endpoint, making data source setup easy and efficient.
Endpoint Settings
-
Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
Endpoint Testing
Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Configure Manually
AviationStack data sources can be manually configured to ingest data from any valid AviationStack API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom query parameters.
With manual configuration, you can also create more complex AviationStack sources, such as sources that chain calls together — for example, using a list of airport IATA codes to drive the Airport Timetable endpoint for each airport.
API Method
-
To manually configure this source, select the Advanced tab at the top of the configuration screen.
-
Select the API method that will be used for calls to the AviationStack API from the Method pulldown menu. All AviationStack read endpoints use GET:
- GET: For retrieving data from the API (the only method supported by the AviationStack v1 API)
API Endpoint URL
- Enter the URL of the AviationStack API endpoint from which this source will fetch data in the Set API URL field. All AviationStack endpoints use the base
https://api.aviationstack.com/v1/followed by the resource path (for example,https://api.aviationstack.com/v1/flights). Theaccess_keyURL parameter is appended automatically from your credential.
HTTPS access requires a paid AviationStack plan (Basic or higher). Free Tier accounts must use the HTTP base URL (http://api.aviationstack.com/v1/). Confirm your plan in the AviationStack dashboard before configuring the protocol.
Date/Time Macros (API URL)
Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods. They are particularly useful for AviationStack endpoints that filter by flight_date or by future-schedule date.
For example, set the API URL to https://api.aviationstack.com/v1/flights?flight_date={now} with the YYYY-MM-DD date format and a Day time unit to always fetch live flights for the current day.
-
To add a macro, type
{at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.-
{now}– The current datetime -
{now-1}– The datetime one time unit before the current datetime -
{now+1}– The datetime one time unit after the current datetime -
custom– Datetime macros can reference any number of time units before or after the current datetime—for example, enter(now-4)to indicate the datetime four time units before the current datetime
-
-
Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. AviationStack expects
YYYY-MM-DDforflight_dateand future scheduledateparameters, so the format must match the endpoint being called. -
Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro
{now-1}, whenDayis selected,{now-1}will be converted to the datetime one day before the current datetime.
Lookup-Based Macros (API URL)
Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data. For AviationStack, this is useful when you have a Nexla dataset of airport IATA codes, airline IDs, or flight numbers and want to drive per-record API calls.
A common pattern is to combine the List Airports endpoint with a lookup-based macro on the Airport Timetable URL — fetching the timetable for every IATA code in your reference dataset.
-
To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.
-
Type
{at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.
Path to Data
If only a subset of the data returned by an AviationStack endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) by specifying the path to the relevant data within the response.
AviationStack responses are returned in JSON format. Every endpoint wraps the result set inside a top-level data array, with pagination metadata as a sibling, so the path to the underlying records is $.data[*].
Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.
-
To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.
- For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. AviationStack uses
$.data[*]to access every record in the response array.
Path to Data Example:For an AviationStack endpoint that returns a top-level array of records inside a
dataproperty (for example,GET /flights), enter$.data[*]as the path to data. This is the default used by every pre-built AviationStack endpoint template. - For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. AviationStack uses
Autogenerate Path Suggestions
Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.
-
To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.
-
Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

Metadata
If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.
For AviationStack responses, the top-level pagination object (containing limit, offset, count, and total) is a sibling of data. Capturing it as metadata can be helpful when downstream consumers need to know the total record count or page position.
To attach AviationStack pagination details to each record, enter $.pagination in the Path to Metadata in Response field.
-
To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.
- For responses in JSON format, enter the JSON path to the object or array that contains the metadata.
Request Headers
-
If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example,
header1:value1,header2:value2).You do not need to include any headers already present in the credentials. AviationStack authenticates using the
access_keyURL parameter rather than a header, so additional headers are only needed for custom integrations.
Endpoint Testing
After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Save & Activate the Source
- Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new AviationStack data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.