{
  "opencollection": "1.0.0",
  "info": {
    "name": "DTN PIREP API",
    "version": "1.9.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "PIREP",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get active PIREPs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://aviation.api.dtn.com/v1/pireps/",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Skip over this many into the response set; used for paginated results."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Provide no more than this many items in the response set."
              },
              {
                "name": "unitSystem",
                "value": "",
                "type": "query",
                "description": "Identifier for units system used for numerical output values in PIREP.  Must be either `default` or `metric`.  Default is `default`.  Field units depending on unit system:<br>                * `temperature`: default=`degC`, metric=`degC`<br>                * `visibility`: default=`mi`, metric=`m`<br>                * `windSpeed`: default=`kts`, metric=`m/s`<br>                * `flightLevel`: default=`ft`, metric=`m`<br>                * `turbulenceBase#`/`turbulenceTop#`: default=`ft`, metric=`m`<br>                * `icingBase#`/`icingTop#`: default=`ft`, metric=`m`<br>                * `weatherBase#`/`weatherTop#`: default=`ft`, metric=`m`<br>                * `coverageBase#`/`coverageTop#`: default=`ft`, metric=`m`"
              },
              {
                "name": "bbox",
                "value": "",
                "type": "query",
                "description": "Bounding box coordinates in the format `<min_X>,<min_Y>,<max_X>,<max_Y>`.  The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default).  Limits to objects within or intersecting the area so defined.  No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.  Requests with bbox definition of area that crosses antimeridian will fail."
              },
              {
                "name": "polygon",
                "value": "",
                "type": "query",
                "description": "Polygon coordinates in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>`.  The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default).  Must provide between 3 and 40 coordinates.  If the last `X,Y` does not match the first `X,Y`, the first `X,Y` is copied to the end to close the polygon.  Limits to objects within or intersecting the area so defined.  No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.  Requests with polygon definition of area that crosses antimeridian will fail or give unexpected results."
              },
              {
                "name": "circle",
                "value": "",
                "type": "query",
                "description": "Circle coordinates and radius distance in the format `<X>,<Y>,<RADIUS>`.  The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default).  The `<RADIUS>` defines the distance (in default or `distanceUnits`-specified units) from the defined point.  Limits to objects within or intersecting the area so defined.  No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.  Requests with circle definition of area that crosses antimeridian will fail.  The larger the defined area, the more its shape on projected map will differ from true circle on spherical coordinates.  Maximum allowed <RADIUS> is 400nm (and equal lengths for different `distanceUnits`)."
              },
              {
                "name": "corridor",
                "value": "",
                "type": "query",
                "description": "Line coordinates and distance from the line in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>,<HALFWIDTH>`.  The `X,Y` coordinates must be consistent with the `srid` (`4326` for longitude/latitude by default).  Must provide between 2 and 40 coordinates for the line.  The `<HALFWIDTH>` defines the distance (in default or `distanceUnits`-specified units) from the line defined by the coordinates out to which to create encompassing shape.  Limits to objects within or intersecting the area so defined.  No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.  Requests with corridor definition of area that crosses antimeridian will fail or give unexpected results.  The larger the defined area, the more its shape on projected map will differ from true corridor on spherical coordinates.  Maximum allowed <HALFWIDTH> is 200nm (and equal lengths for different `distanceUnits`)."
              },
              {
                "name": "distanceUnits",
                "value": "",
                "type": "query",
                "description": "Units identifier for distances in definition for circle or corridor spatial filter.  Default is `nm` (nautical miles)."
              },
              {
                "name": "isValidAt",
                "value": "",
                "type": "query",
                "description": "UTC timestamp in format `YYYY-MM-DD hh:mm:ss`.  Limits to objects whose `validDateTime` is not earlier than the specified value and whose `expirationDateTime` is later than that specified value.  Allowed values relative to the current time vary depending on the data type.  A valid time value being accepted through this parameter does not mean there will be applicable data to return in response."
              },
              {
                "name": "insertedAfter",
                "value": "",
                "type": "query",
                "description": "UTC timestamp in format `YYYY-MM-DD hh:mm:ss.fff`.  Limits to objects whose `insertedDateTime` is later than that specified value.  This allows to acquire only data that became available after this time.  Requires use of fractional seconds for full precision.  Allowed values relative to the current time vary depending on the data type.  A data insertion time value being accepted through this parameter does not mean there will be applicable data to return in response."
              },
              {
                "name": "insertedThrough",
                "value": "",
                "type": "query",
                "description": "UTC timestamp in format `YYYY-MM-DD hh:mm:ss.fff`.  Limits to objects whose `insertedDateTime` is not later than that specified value.  This allows to acquire only data that became available through this time.  Requires use of fractional seconds for full precision.  Allowed values relative to the current time vary depending on the data type.  A data insertion time value being accepted through this parameter does not mean there will be applicable data to return in response."
              },
              {
                "name": "aircraftTypes",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of aircraft type values.  Limits to objects whose `aircraftType` value matches one of specified parameter values.  Note that aircraftType is not specified properly and cannot be obtained for all reports."
              },
              {
                "name": "aircraftSizes",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of aircraft size values.  Limits to objects whose `aircraftSize` value matches one of specified parameter values.  Note that aircraftSize cannot be determined based on aircraftType for all reports, but can use `null` to include reports with undefined aircraftSize."
              },
              {
                "name": "navaidIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of Navaid identifier values.  Limits to objects whose `navaidId` value matches one of specified parameter values."
              },
              {
                "name": "minFlightLevelFt",
                "value": "",
                "type": "query",
                "description": "Minimum flight level in feet.  Limits to objects whose `flightLevel` is greater than or equal to this.  Must set value in feet even if output `unitSystem` would not give response in feet."
              },
              {
                "name": "maxFlightLevelFt",
                "value": "",
                "type": "query",
                "description": "Maximum flight level in feet.  Limits to objects whose `flightLevel` value is less than or equal to this.  Must set value in knots even if output `unitSystem` would not give response in feet."
              },
              {
                "name": "minTurbulenceScore",
                "value": "",
                "type": "query",
                "description": "Minimum turbulence score.  Limits to objects whose `turbulenceScore` is greater than or equal to this."
              },
              {
                "name": "maxTurbulenceScore",
                "value": "",
                "type": "query",
                "description": "Maximum turbulence score.  Limits to objects whose `turbulenceScore` value is less than or equal to this."
              },
              {
                "name": "minIcingScore",
                "value": "",
                "type": "query",
                "description": "Minimum icing score.  Limits to objects whose `icingScore` is greater than or equal to this."
              },
              {
                "name": "maxIcingScore",
                "value": "",
                "type": "query",
                "description": "Maximum icing score.  Limits to objects whose `icingScore` value is less than or equal to this."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get all available PIREPs, potentially filtered by various query parameters.  All specified filter parameters must be satisfied for an object to be returned in the response.  For some PIREPs coordinate locations can not be determined, thus they will have longitude=0 & latitude=0 in output and thus would not be correctly obtained by a spatial filter.  Most data fields will not be present when they have no defined value."
        }
      ]
    }
  ],
  "bundled": true
}