AeroModel

Documentation

`GET /v1/images/plane`

Main API endpoint. Serves a pre-rendered aircraft image, optionally composed on the fly (pitch, scale, background, align, ...).

Overview

GET /v1/images/plane?<params> HTTP/1.1
Host: api.aeromodel.dash-systems.fr
x-api-key: <key>

Response:

200 OK + image/png|jpeg|webp (binary) in standard mode
200 OK + application/json if format=json
400 if invalid parameters (in format=json only — in image mode the API always tries to serve a fallback)

Parameters

Each parameter has its own page with visual examples and full URL examples:

Selection

Parameter	Page
`plane`, `plane_iata`, `plane_icao`	`plane`
`airline`, `airline_iata`, `airline_icao`	`airline`
`liveryType`	`liveryType`

View

Parameter	Page
`angle`	`angle`
`gear`	`gear`

Format / size

Parameter	Page
`filetype`	`filetype`
`width`	`width`
`resolution`	`resolution`
`zoomType`	`zoomType`
`zoomLevel`	`zoomLevel`
`marginPercent`	`marginPercent`

On-the-fly composition (output forced to PNG)

Parameter	Page
`pitch`	`pitch`
`align` (alias `verticalAlign`)	`align`
`scale`, `referencePlane`	`scale`
`background`	`background`
`backgroundGradient`	`backgroundGradient`

Mode

Parameter	Page
`format`	`format`

Defaults

angle           = 90
gear            = down
filetype        = png
width           = 1280
zoomType        = contain
zoomLevel       = 1
marginPercent   = 8
liveryType      = base
pitch           = 0
scale           = none
align           = center (implicit; not present unless explicitly requested)
background      = none
format          = image

Quick examples

Basic right profile

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF

High-resolution view with navy background

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A380&airline=EK&resolution=hd&background=%23001a33

3/4 nose-up view for product card

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=B789&airline=UA&angle=345&pitch=15&resolution=card

Fleet comparison (3 calls, same scale + same baseline)

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&scale=fleet&referencePlane=airbus-a380-800&align=bottom&resolution=hd
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A380&airline=EK&scale=fleet&referencePlane=airbus-a380-800&align=bottom&resolution=hd
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=B789&airline=UA&scale=fleet&referencePlane=airbus-a380-800&align=bottom&resolution=hd

Documentation

GET /v1/images/plane