Skip to main content

Computed SkyPath Turbulence data (deprecated)

POST 

/v4/map

warning

This endpoint is deprecated.

For server-to-server integrations, please use For server-to-server integrations, please use Corridor API instead.

For web applications displaying SkyPath data, please use the Web SDK only.

Use this to fetch SkyPath computed turbulence data for a specific time span, severity selection and calculated for a specific aircraft type. Using this operation you can limit the query to a Geo fence. (Supports now only GeoJson fragments: Polygon)

Data

Working directly with the computed SkyPath data

Get map data is used to fetch SkyPath computed turbulence data in raw JSON format (not GeoJson). Then, to build a map layer on the client side using this data.

SkyPath Tick

Satcom communication is expensive, and in order to minimize bandwidth usage the SkyPath REST API supports incremental updates of turbulence data. This is done using a virtual time unit called “SkyPath Tick” which is attached to each calculated turbulence report. This enables the fetching of updates from a point in time. The SkyPath tick is incremented approximately every 1 minute. When getting replies from our API you will get all data for the requested time span and also get the current SkyPath tick. Leave the tick parameter empty to get all updates in the specified time (hours), or specify the desired tick in the skypath_tick parameter and leave hours empty to get only updates that occurred since that tick including ones that happened in that tick.

Pseudo algorithm when working with SkyPath tick

  1. Upon starting, request the data and specify hours back in hours parameter. 2. Observe the returned skypath tick and turbulence data. 3. Save the turbulence data in a local data structure in the app/client. 4. On the next request, send the same tick you got in the skypath_tick reply and leave hours empty. 5. You will get in the reply only updates that happened since and in that specified tick and the current SkyPath tick. 6. Merge the new turbulence update records by their index hex_id and skypath_alt, throw or overwrite duplicate records you already have, and delete old records (for example if working for 3 hours delete any record in your local array which is older than 3 hours). 7. The resulting local array represents the current turbulence conditions. fields - is used to select which data you are interested in, default is turbulence, if you wish to get other types you will add them as a comma delimited string to the fields parameter.

Request

Query Parameters

    ac_cat string

    Possible values: [C10, C20, C30, C40, C50, C60, C70, C80, C90, C100, C110]

    Default value: C60

    Aircraft category to return computed turbulence data for

    Example: C60
    hours string

    Possible values: [0.5, 1, 2, 4, 6]

    Default value: 6

    How many hours back to use for calculated turbulence data

    tick number

    Default value: 0

    minimal SkyPath tick to include updates from (including this tick)

    sev string[]

    Possible values: [0, 1, 2, 3, 4, 5]

    Severity selection to include in response

    fields string[]

    Possible values: [turbulence_h3, turbulence_polygons, pireps, traffic]

    Choose which fields to include in the response can be an array with the values turbulence_h3, turbulence_polygons, pireps, traffic

    sp_alt_from number

    Possible values: <= 52

    Default value: 0

    sp_alt_to number

    Possible values: <= 52

    Default value: 52

    traffic_limit number

    Default value: 500

    Limit amount of items in traffic array

    pireps_limit number

    Default value: 500

    Limit amount of items in pireps array

Header Parameters

    x-skypath-airline-icao string

    For web applications using this endpoint, this field should state the ICAO code of the airline using the SkyPath Layer in the application.

Body

required

    geo

    object

    required

    type stringrequired

    Possible values: [Polygon]

    coordinates array[]required

Responses

Response for get map data

Schema

    tick numberrequired

    current SkyPath tick for this data response

    turbulence_h3

    object[]

    array of calculated turbulence data returned in response

  • Array [

  • hex_id stringrequired

    H3 hexagon id in zoom 5

    sev numberrequired

    calculated max severity

    reports

    object[]

    required

    array of calculated SkyPath reports for this tile

  • Array [

  • sp_alt numberrequired

    SkyPath alt block in 1000`s of feet

    ts numberrequired

    time stamp in Linux epoch

    sev numberrequired

    sev of calculated turbulence

    tick numberrequired

    SkyPath tick where this calculation was made

  • ]

  • ]

  • turbulence_polygons

    object

    type stringrequired

    Possible values: [FeatureCollection]

    features

    object[]

    required

  • Array [

  • type string

    properties

    object

    sev int32

    geometry

    object

    type string
    coordinates array[]
  • ]

  • traffic

    object[]

    array of traffic positions for SkyPath using aircraft

  • Array [

  • lat numberrequired

    Latitude

    lng numberrequired

    Longitude

    alt numberrequired

    Altitude

    sp_alt numberrequired

    SkyPath alt block in 1000`s of feet

    hdg numberrequired

    Heading in degrees

    spd_nm_h numberrequired

    Speed in nautical miles per hour

    ts numberrequired

    Timestamp in Linux epoch

    user stringrequired

    User

    company stringrequired

    Company

    ac_cat stringrequired

    Aircraft SkyPath category

    ac_type stringrequired

    Aircraft type

    ac_size stringrequired

    Aircraft size

    flight_num stringrequired

    Flight number

    flight_num_manual booleanrequired

    Is flight number inserted manually

    dest stringrequired

    Destination

    dep stringrequired

    Description

    sp_flight_id stringrequired
  • ]

  • pireps

    object[]

    array of SkyPath reported PIREPs

  • Array [

  • id stringrequired

    UUID

    tile_x numberrequired

    SkyPath tile x - slippy map x coordinate in zoom 11

    tile_y numberrequired

    SkyPath tile x - slippy map y coordinate in zoom 11

    hex_id stringrequired

    H3 hexagon id in zoom 5

    tick numberrequired

    SkyPath tick where this calculation was made

    is_deleted numberrequired

    Is report deleted

    alt numberrequired

    Altitude in feet

    sp_alt numberrequired

    SkyPath alt block in 1000`s of feet

    ts numberrequired

    Timestamp in Linux epoch

    type stringrequired

    Possible values: [cb, icing, shear, lightning, mwave]

    Weather type

    params objectrequired

    Additional information

    sp_flight_id stringrequired

    SkyPath flight id

    user stringrequired

    User

  • ]

Loading...