Airframes

An airframe represents an individual pyhsical aircraft.

Entry point
https://www.avdelphi.com/api/1.0/airframes.svc
Parameter Type Values
api_key
mandatory Your API Key
api_password
mandatory Your API Password. Send this OR an access_token
api_access_token
mandatory Your API access token which can be used instead of sending your password.
cmd
mandatory API Command
itemlist
optional List of fields to return. Each command has a specific list of items that can be returned.
format
optional Data return type XML,JSON,CSV or CSV-
  • JSON is the default when no format parameter is specified
  • CSV output starts with a series of comment lines - starting with the # character. You may need to remove these before importing the CSV data.
  • CSV- output omits the comment lines - including any error messages.
search parameter
see note below Each command has a set of parameters that can be specified to identify the target data, such as registration, serial number etc.

Examples

Note When using the TEST credentials (TESTAPIKEY & TESTAPIKEYPASSWORD) the resulting aircraft will always be HB-JNB / ICAO=4B1917

Get a specific set of fields for an airframe by registration
https://www.avdelphi.com/api/1.0/airframes.svc?api_key=TESTAPIKEY&api_password=TESTAPIKEYPASSWORD&cmd=info&registration=hb-jnb&itemlist=type_short;type_long;manufacturer


Result (JSON)
{
	"api":"airframe",
	"version":1.0,
	"command":"get",
	"num_results":1,
	"result_type":"valid",
	"result":[
		{
		"type_short":"B773",
		"type_long":"Boeing 777 3DE",
		"manufacturer":"Boeing"
		}]
}


https://www.avdelphi.com/api/1.0/airframes.svc?api_key=TESTAPIKEY&api_password=TESTAPIKEYPASSWORD&cmd=info&registration=hb-jnb&itemlist=type_short;type_long;manufacturer&format=csv


Result (CSV)
#api=airframe
#version=1
#command=id
#result_type=valid
#type_short,type_long,manufacturer
B77W,B777-3DEER,Boeing



https://www.avdelphi.com/api/1.0/airframes.svc?api_key=TESTAPIKEY&api_password=TESTAPIKEYPASSWORD&cmd=info&registration=hb-jnb&itemlist=type_short;type_long;manufacturer&format=xml


Result (XML)
<?xml version="1.0"?>
	<data>
		<api>airframe</api>
		<version>1</version>
		<command>info</command>
		<num_results>2</num_results>
		<result_type>valid</result_type>
		<results_limit>5</results_limit>
		<rate_limit>
			<airframes>
				<current>1</current>
				<maximum>5</maximum>
			</airframes>
		</rate_limit>
		<result>
			<item0>
				<type_short>B77W</type_short>
				<type_long>B777-3DEER</type_long>
				<manufacturer>Boeing</manufacturer>
			</item0>
		</result>
	</data>

Pricing

Access to this API is based on a per airframe per month pricing plan. Volume discounts apply. Contact your API team using the contact form below to create or edit your plan.

Mandatory Parameters

api_key

TypeMandatory
ContentHexadecimal value of your API key.
Get your API key here if you don't have one.
Case sensitiveYES
Example
api_key=NTlhZGUl7kZW

Back to top 

api_password

TypeMandatory (You must send either password or access token with each request)
ContentHexadecimal value of your API password.
Get your API key here if you don't have one.
Case sensitiveYES
Example
api_password=ciUyQmdPWTJaTGNQc2pkU05tRlVNaWZZ11NpdCUyRmVpVEF6THBm7SUzRA

Back to top 

api_access_token

TypeMandatory (You must send either password or access token with each request)
ContentHexadecimal value of your API access token.
Click on any API Key here to manage access tokens.
Case sensitiveYES
Example
api_access_token=2d1a099fd880c0fcfd6fd5e63a769e11b2c2db92

Back to top 

Commands

cmd

TypeMandatory
ContentAPI command to execute
Case sensitiveNo
Command Purpose
info Retrieve information about a specific airframe. The list of data fields returned is specified using the itemlist parameter.
position Gets the latest position report for the airframe. The return field list is set - latitude, longitude, altitude and timestamp of that position report.
news Show any recent news items relating to this airframe.
images Get images for this airframe.
id_tag Get the unique AvDelphi identification plate for this airframe.
unid_to_id Return the record id for a given airframe UNID
Example
cmd=info
cmd=position
cmd=news

Back to top 

info

FunctionRetrieve information about a specific airframe. The list of data fields returned is specified using the itemlist parameter.
Search ParameterUse any ONE of the following parameters to specify which airport to return data for.

ParameterDescription
registrationRegistration of this airframe, without any punctuation, such as HBJNB
registration_rawRegistration of this airframe, including punctuation, such as HB-JNB
serial_number The aircraft serial_number, such as 850
Back to commands 

position

FunctionGets the latest position report for the airframe. The return field list is set - latitude, longitude, altitude and timestamp of that position report.
Search ParameterUse any ONE of the following parameters to specify which airport to return data for.

ParameterDescription
registrationRegistration of this airframe, without any punctuation, such as HBJNB
registration_rawRegistration of this airframe, including punctuation, such as HB-JNB
serial_number The aircraft serial_number, such as 850
Back to commands 

news

FunctionShow any recent news items relating to this airframe.
Search ParameterUse any ONE of the following parameters to specify which airport to return data for.

ParameterDescription
registrationRegistration of this airframe, without any punctuation, such as HBJNB
registration_rawRegistration of this airframe, including punctuation, such as HB-JNB
Back to commands 

images

FunctionGet images for this airframe.
Search ParameterUse any ONE of the following parameters to specify which airport to return data for.

ParameterDescription
registrationRegistration of this airframe, without any punctuation, such as HBJNB
registration_rawRegistration of this airframe, including punctuation, such as HB-JNB
Back to commands 

id_tag

FunctionGet the unique AvDelphi identification plate for this airframe.
Search ParameterUse any ONE of the following parameters to specify which airport to return data for.

ParameterDescription
Back to commands 

unid_to_id

FunctionReturn the record id for a given airframe UNID
Search ParameterUse any ONE of the following parameters to specify which airport to return data for.

ParameterDescription
Back to commands 

Optional Parameters

format

TypeOptional
ContentSpecifies the data return format JSON,XML or CSV(-). By default, data is returned as JSON.
Case sensitiveNo
Example
format=xml
format=csv
format=csv-
format=json

Back to top 

itemlist

TypeOptional depending on command used. Some commands return default data, others allow you to specify which fields to return.
ContentList of fields to retrieve separated with semi-colons.
Case sensitiveNo
Fieldname Description
mode_s_code_hex Transponder mode_s code as 6 hex characters, i.e. 4b1967
registration Registration of this airframe, without any punctuation, such as HBJNB
registration_raw Registration of this airframe, including punctuation, such as HB-JNB
selcal The last known SELCAL code for this airframe such as ABED
type_short The aircraft type code - short form, such as A320
type_long The aircraft type code - long form, such as Airbus A320-200
type_specific Longer form of the aircraft type including any special designators
serial_number The aircraft serial_number, such as 850
line_number The aircraft line_number, such as 17
construction_number The aircraft construction number, such as 1300
manufacturer_model_code The model code used by the manufacturer to describe this airframe, such as 777-DEER
manufacturer Name of the primary manufacturer, such as Airbus
ceremonial_name A name given to this airframe by the operator, if any
year_manufacture Year of manufacturer such as 2016
owner_name Name of the owner if available
operator Operator name if available
operator_icao Operators ICAO code if available
status Last known status, such as Active
last_known_state Last known state such as Stored
country Country of registration
first_flight Date of first flight
delivery_date Date of delivery from the manufacturer
owner_type Owner type as in Fract for fractional ownership
location Notable location
Example
itemlist=mode_s_code_hex;registration;registration_raw

Back to top