Department of Interior Alerts API

openapi: 3.2.0
info:
  description: This API is designed to provide authoritative National Park Service (NPS) data and content about parks and their facilities, events, news, alerts, and more. Explore the NPS API below and even try to make API calls. In order to try an API call, you'll need to click on the "Authorize" button below and add your API key. If you don't have an API key yet, visit our Get Started page.
  version: 1.0.0
  title: National Park Service Alerts API
servers:
- url: https://developer.nps.gov/api/v1
tags:
- name: Alerts
  description: Retrieve alerts (danger, closure, caution, and information) posted by parks.
paths:
  /alerts:
    get:
      tags:
      - Alerts
      description: Returns park alerts, with optional filters for park codes, state codes, or a search term.
      operationId: getAlerts
      parameters:
      - name: parkCode
        in: query
        description: A comma delimited list of park codes (each 4-10 characters in length).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: stateCode
        in: query
        description: A comma delimited list of 2 character state codes.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: Number of results to return per request. Default is 50.
        required: false
        schema:
          type: integer
      - name: start
        in: query
        description: Get the next [limit] results starting with this number. Default is 0.
        required: false
        schema:
          type: integer
      - name: q
        in: query
        description: Term to search on
        required: false
        schema:
          type: string
      security:
      - api_key: []
      - api_key_header: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
        '400':
          description: Invalid status value
      summary: Get alerts
      x-summary-source: derived
components:
  schemas:
    Alert:
      type: object
      properties:
        total:
          type: string
          example: '474'
        data:
          type: array
          items:
            type: object
            properties:
              category:
                type: string
                description: 'Alert type: Danger, Caution, Information, or Park Closure'
                enum:
                - Danger
                - Caution
                - Information
                - Park Closure
              description:
                type: string
                description: Alert description
              id:
                type: string
                description: Unique identifier for an alert record
              parkCode:
                type: string
                description: A variable width character code that uniquely identifies a specific park
              title:
                type: string
                description: Alert title
              url:
                type: string
                description: Link to more information about the alert, if available
              lastIndexedDate:
                type: string
                description: date/time stamp of when this alert was last indexed
              relatedRoadEvents:
                type: array
                description: more information about a road event related to this alert (if any)
                items:
                  type: object
                  properties:
                    title:
                      type: string
                      description: title of this related road event
                    id:
                      type: string
                      description: UUID for this related road event
                    type:
                      type: string
                      description: what type of related road event is this
                    url:
                      type: string
                      description: URL for more information about this related road event
          example:
          - category: Information
            description: Some destinations are unavailable because of construction related to the Canyon Overlooks and Trails Restoration Project.
            id: 4C3095E2-1DD8-B71B-0BAC8E16AABF3113
            parkCode: yell
            title: Area Closures in Canyon
            url: https://www.nps.gov/yell/planyourvisit/canyonprojects.htm
            lastIndexedDate: '2023-06-27 14:10:21.0'
            relatedRoadEvents: []
          - category: Caution
            description: The road between Roaring Mountain and Willow Park is under construction. Expect delays up to 30 minutes and night closures June 11–September 10 from 10pm–7am (excluding Saturday nights).
            id: 696FC8C9-1DD8-B71B-0BF3D47A2BF92890
            parkCode: yell
            title: Construction & Nightly Closures between Norris & Mammoth Hot Springs
            url: https://www.nps.gov/yell/planyourvisit/parkroads.htm
            lastIndexedDate: '2023-06-27 14:10:21.0'
            relatedRoadEvents:
            - title: Crazy Squirrels
              id: 68BC589E-7FFC-4AFC-AD02-85E123C4C145
              type: roadevent
              url: https://www.nps.gov/yose/planyourvisit/conditions.htm
        limit:
          type: string
          example: '50'
        start:
          type: string
          example: '0'
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: query
    api_key_header:
      type: apiKey
      name: X-Api-Key
      in: header
x-provenance:
  method: harvested
  publisher: Department of Interior
  source: https://www.nps.gov/subjects/developer/customcf/swagger.json?03142019
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)