fuelplanner api


The fuelplanner api (FAPI) was developed to facilitate access to flight simulation fuel planning services. The primary audience includes virtual airline organizations, flight simulation users, and application developers who integrate the capability to communicate with FAPI, and use the the results for further processing, or present them through their own user interface.

Requesting Access: First register on the website. Registered users can create one or more FAPI accounts.

FAPI Usage: Send an appropriately formatted HTTP POST request to http://fuelplanner.com/api/fuelapi.php
(see below for a description of input parameters)

FAPI Output: The body of the output response is an XML document containing one or more variables
(see below for a description of output variables)

Pricing: Newly created FAPI accounts come with a free license to evaluate the service for a 24-hour period. The annual renewal fee for premium access is a very reasonable $20 USD for an entire year-long subscription.

Example usage: curl --data "QUERY=FUEL&EQPT=B752&ORIG=KLAX&DEST=KJFK&USER=[your e-mail address]&ACCOUNT=[your account]&LICENSE=[your license]" http://fuelplanner.com/api/fuelapi.php

Example (using PHP and curl): PHP Source Code

Example (using VB6): VB6 Source Code

Terms of Service and Use: Click here to access the FAPI terms of service and use document.
InputDescription of input parameters
QUERY
  • FUEL : indicates a standard fuel request with default aircraft weights.
  • LIST_E : indicates a request for a list of aircraft codes and corresponding descriptions.
USERUsername - typically this is your e-mail address, or the login-id used for accessing the website
ACCOUNTUsers can have multiple API accounts. This parameter corresponds with the API account for which the request is made.
LICENSEUnique API account authorization is required for requests.
ORIGOrigination airport code in ICAO format. For example: KORD for Chicago OHare
DESTDestination airport code in ICAO format. For example: KMCO for Orlando International Airport
EQPTThe equipment code for the aircraft For example: B763 for the Boeing 767-300
RULESOptional. Default is FARDOM. Can also specify INTL or JAR
TTLOptional. Total traffic load
OEWOptional. Operating empty weight
MTANKOptional. Fuel capacity (i.e., maximum fuel weight)
TANKEROptional. Extra fuel, pounds (default). Use keyword AUTO to calculate tankering fuel for a round-trip. Use keyword MAX to calculate maximum tankering fuel
METAROptional. If YES, then fueplanner will attempt to find weather data for ORIG and DEST.
UNITSOptional. Default is LBS. If METRIC then weights will be in kilograms (including any weight inputs options above)
OutputDescription of output variables
DESCRIPEquipment descriptor
NMNautical miles between between ORIG and DEST (great circle distance)
HEADING_TCInitial direct true heading from ORIG to DEST
OEWOperating empty weight, pounds (default)
TTLTotal traffic load, pounds (default)
ZFWZero fuel weight, pounds (default)
FUEL_EFUEstimated fuel usage, pounds (default)
FUEL_RSVReserve fuel, pounds (default)
FUEL_TOFTakeoff fuel, pounds (default)
TOWTakeoff weight, pounds (default)
UNDERLOADCalculated underload, pounds (default)
LWTEstimated landing weight, pounds (default)
TIME_BLKEstimated time enroute, HH:MM. Note this is total block time from time-out to time-in.
TIME_RSVReserve fuel time, HH:MM
TIME_TTETotal time enroute, HH:MM
METAR_ORIGAviation weather for ORIG
METAR_DESTAviation weather for DEST
MESSAGESInternal messages and warnings; each of the messages encoded with a MESG token.
ERRORError code or description of error associated with the request.
EQPTLISTThis is a LIST_E response variable and contains identifiers and descriptions of supported aircraft:
  • ID : Aircraft equipment identifier (may or may not be ICAO)
  • DESCRIP : Description of aircraft corresponding with ID