Method: getGrids

  • The main goal of this API is to get a grid of contrail predictions.

  • The response for a successful request will be a NetCDF file containing contrail forcing values.

  • The HTTP request uses a GET method and requires a name path parameter to specify the grid type.

  • Query parameters allow filtering the results by boundaries (bbox), time, aircraft type, flight level, format, aircraft class, and specific data variables to include.

  • The request body should be empty.

Get a grid of contrail predictions.

If successful, the response will be a NetCDF of contrail forcing values.

HTTP request

GET https://contrails.googleapis.com/v2/{name=grids}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the grid to retrieve. Format: grid/{grid_type} Currently 'ef' is the only supported grid type

Query parameters

Parameters
bbox[]

number

Optional. Boundaries of region to return, (lng_min, lat_min, lng_max, lat_max).
time

string

Required. Time of request [int: unix epoch; str: ISO 8601]
aircraftType

string

Optional. 4-character aicraft code e.g. A320.
flightLevel[]

integer

Optional. Flight levels to return.
format

string

Optional. Requested format. Passing in a value other than 'netcdf4' will raise an UNIMPLEMENTED error since polygons are not supported.
aircraftClass

string

Optional. Aircraft class. Currently only 'default' is supported.
data[]

string

Optional. This field specifies which data variables to include in the response. It can handle one or multiple data variables. e.g. ["contrails", "expected_effective_energy_forcing"] or ["contrails"] If this field is empty or not provided, it defaults to ["contrails"].

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.