AeroModel

AeroModel

Documentation

FAQ

How many aircraft and airlines?

31 aircraft models and around 1500 airline liveries. The full list is dynamic: query /v1/catalog/planes and /v1/catalog/airlines.

What happens if the livery doesn't exist for that aircraft?

The API automatically applies a fallback cascade:

  1. The requested livery (liveryType=special)
  2. The airline's base livery
  3. The blank model (aircraft without livery)
  4. A default image (default/base.jpg)

The x-fallback-reason header indicates why a fallback was applied. See Errors and fallbacks.

Can I use IATA or ICAO codes instead of slugs?

Yes. Three aliases are supported for plane and airline:

ParamFormatExample
planeslug or code (auto-detect)A320, airbus-a320-200
plane_iatastrict IATA code320
plane_icaostrict ICAO codeA320

See plane and airline.

What is the typical latency?

  • Edge cache hit: ~30 ms (Cloudflare Cache API)
  • Cache miss: ~100-300 ms (R2 read + serialization)
  • On-the-fly composition (pitch, scale, background, align): +50-200 ms first time, then cache hit

See Edge cache.

What's the typical image size?

PresetWidthPNG sizeWebP size
thumb512 px30-80 KB15-40 KB
card1024 px80-200 KB40-100 KB
hd2048 px200-600 KB100-300 KB
ultra4096 px800 KB-2 MB400 KB-1 MB

See resolution.

Is there a quota or rate limit?

No application-level rate limit. Cloudflare Free / Workers Paid plan limits apply at infra level. For massive usage, contact the maintainer.

Which image formats are available?

png (with alpha if the source asset has it), jpg (opaque), webp (alpha + better compression ratio). See filetype.

How do I generate a solid color or gradient background?

With the background (hex color) or backgroundGradient (multi-stop linear) parameters. Examples:

Is pitch (nose-up / nose-down) pre-rendered or computed on the fly?

Computed on the fly by the Worker (2D rotation around the fuselage center). Output is forced to PNG when pitch is used. See pitch.

Can I get multiple aircraft at the same relative scale?

Yes via scale=fleet, which sizes each aircraft proportionally to a reference model. Combine with align=bottom for a shared baseline. See scale.

How do I know which special liveries exist for Plane × Airline?

GET /v1/catalog/liveries?plane=A380&airline=EK

Response: the list of available liveryType values. See Catalog.

Are the images royalty-free?

Aircraft visuals are original 3D renders. Commercial usage requires an agreement. Airline logo rights are the user's responsibility.