openapi: "3.0.3"
info:
  title: FDSN Event Web Service
  description: >-
    API documentation of the FDSNWS Event service which provides access to
    event parameters and related data.
  termsOfService: https://www.orfeus-eu.org/data/eida/webservices/
  version: 1.2.0
servers:
  - url: http://rdsa.knmi.nl/fdsnws/event/1
tags:
  - name: Event
externalDocs:
  description: API Documentation
  url: http://www.fdsn.org/webservices/fdsnws-event-1.1.pdf
paths:
  /query:
    get:
      tags:
        - Event
      summary: Query event parameters
      parameters:
        - name: starttime
          in: query
          description: Limit to events on or after the specified start time.
          example: '2020-01-01T22:06:00'
          schema:
            type: string
            format: date-time
        - name: endtime
          in: query
          description: Limit to events on or before the specified end time.
          example: '2020-01-02T00:06:00'
          schema:
            type: string
            format: date-time
        - name: minlatitude
          in: query
          description: Limit to events with a latitude larger than or equal to the specified minimum.
          schema:
            type: number
            format: float
            default: -90.0
        - name: maxlatitude
          in: query
          description: Limit to events with a latitude smaller than or equal to the specified maximum.
          schema:
            type: number
            format: float
            default: 90.0
        - name: minlongitude
          in: query
          description: Limit to events with a longitude larger than or equal to the specified minimum.
          schema:
            type: number
            format: float
            default: -180.0
        - name: maxlongitude
          in: query
          description: Limit to events with a longitude smaller than or equal to the specified maximum.
          schema:
            type: number
            format: float
            default: 180.0
        - name: latitude
          in: query
          description: Specify the latitude to be used for a radius search.
          schema:
            type: number
            format: float
        - name: longitude
          in: query
          description: Specify the longitude to be used for a radius search.
          schema:
            type: number
            format: float
        - name: maxradius
          in: query
          description: >-
            Limit results to events within the specified maximum number of degrees from the
            geographic point defined by the latitude and longitude parameters.
          schema:
            type: number
            format: float
        - name: minradius
          in: query
          description: >-
            Limit results to events within the specified minimum number of degrees from the
            geographic point defined by the latitude and longitude parameters.
          schema:
            type: number
            format: float
        - name: mindepth
          in: query
          example: 1.0
          description: Limit to events with depth more than the specified minimum (in kilometers).
          schema:
            type: number
            format: float
        - name: maxdepth
          in: query
          example: 4.0
          description: Limit to events with depth less than the specified maximum (in kilometers).
          schema:
            type: number
            format: float
        - name: minmagnitude
          in: query
          example: 1.5
          description: Limit to events with a magnitude larger than or equal to the specified minimum.
          schema:
            type: number
            format: float
        - name: maxmagnitude
          in: query
          example: 3.5
          description: Limit to events with a magnitude smaller than or equal to the specified maximum.
          schema:
            type: number
            format: float
        - name: magnitudetype
          in: query
          example: MLn
          description: Specify a magnitude type to use for testing the minimum and maximum limits.
          schema:
            type: string
        - name: eventtype
          in: query
          example: induced or triggered event
          description: >-
            Limit to events with a specified eventType. The parameter value can be a single item,
            or a comma-separated list of items. Allowed values are from QuakeML or unknown if
            eventType is not given.
          schema:
            type: string
            enum:
              - induced or triggered event
              - earthquake
        - name: includeallorigins
          in: query
          description: Specify if all origins for the event should be included.
          schema:
            type: boolean
            format: boolean
            default: false
            enum:
              - true
              - false
        - name: includeallmagnitudes
          in: query
          description: Specify if all magnitudes for the event should be included.
          schema:
            type: boolean
            format: boolean
            default: false
            enum:
              - true
              - false
        - name: includearrivals
          in: query
          description: Specify if phase arrivals should be included.
          schema:
            type: boolean
            format: boolean
            default: false
            enum:
              - true
              - false
        - name: includepicks
          in: query
          description: Specify if picks should be included with phase arrivals.
          schema:
            type: boolean
            format: boolean
            default: true
            enum:
              - true
              - false
        - name: eventid
          in: query
          example: knmi2017abcd
          description: Select a specific event by ID.
          schema:
            type: string
        - name: limit
          in: query
          example: 15
          description: Limit the results to the specified number of events.
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          description: Return results starting at the event count specified, starting at 1.
          schema:
            type: integer
            format: int32
            default: 1
        - name: orderby
          in: query
          description: Order the result by time or magnitude.
          schema:
            type: string
            default: time
            enum:
              - time
              - time-asc
              - magnitude
              - magnitude-asc
        - name: contributor
          in: query
          example: KNMI
          description: Limit to events contributed by a specified contributor.
          schema:
            type: string
        - name: format
          in: query
          description: Specify format of result.
          schema:
            type: string
            default: xml
            enum:
              - xml
              - text
              - qml
              - qml-rt
              - sc3ml
              - csv
              - json
        - name: nodata
          in: query
          description: Select status code for "no data".
          schema:
            type: string
            default: '204'
            enum:
              - '204'
              - '404'
      responses:
        '200':
          description: >-
            The request was successful and has returned plain text in the
            corresponding format.
          content:
            application/xml: {}
            text/plain: {}
            application/json:
              schema:
                $ref: '#/components/schemas/EventCollection'
        '204':
          description: The request returns no content.
          content: {}
        '400':
          description: 'The request was bad, check the filled in parameters.'
          content: {}
        '401':
          description: The request requires user authentication.
          content: {}
        '403':
          description: >-
            Forbidden: 'The server understood the request, but is refusing to
            fulfill it.'
          content: {}
        '404':
          description: >-
            Not Found: The server has not found anything matching the
            Request-URL.
          content: {}
        '413':
          description: >-
            Request Entity Too Large: The request entity is larger than the
            server is willing or able to process.
          content: {}
        '414':
          description: >-
            Request-URL Too Long: The request-URL is longer than the server is
            willing to interpret.
          content: {}
        '500':
          description: >-
            Internal Server Error: The server encountered an unexpected
            condition which prevented it from fulfilling the request.
          content: {}
        '503':
          description: >-
            Service Unavailable: The server is currently unable to handle the
            request due to a temporary overloading or maintenance of the server.
          content: {}
  /catalogs:
    get:
      tags:
        - Event
      summary: Request the list of available catalogs.
      responses:
        '200':
          description: Returns the list of available catalogs.
          content:
            application/xml: {}
  /contributors:
    get:
      tags:
        - Event
      summary: Request the list of available contributors.
      responses:
        '200':
          description: Returns the list of available contributors.
          content:
            application/xml: {}
  /version:
    get:
      tags:
        - Event
      summary: Request the service version.
      responses:
        '200':
          description: Returns the application version.
          content:
            text/plain: {}
  /application.wadl:
    get:
      tags:
        - Event
      summary: The application documentation in a .wadl file.
      responses:
        '200':
          description: >-
            The documentation of the event application will be returned in a
            *.wadl format.
          content:
            application/xml: {}
components: 
  schemas:
    EventCollection:
      type: object
      properties:
        type:
          type: string
        features:
          type: array
          items:
            $ref: '#/components/schemas/EventFeature'
        metadata:
          $ref: '#/components/schemas/EventMetadata'
    EventFeature:
      type: object
      properties:
        type:
          type: string
        id:
          type: string
          example:
        properties:
          $ref: '#/components/schemas/EventProperties'
        geometry:
          $ref: '#/components/schemas/EventGeometry'
    EventProperties:
      type: object
      properties:
        time:
          type: string
          format: date-time
          example: "2023-06-20T05:22:36.899999"
        lat:
          type: number
          format: float
          example: 53.154
        lon:
          type: number
          format: float
          example: 6.892
        depth:
          type: number
          format: float
          example: 3.0
        site_name:
          type: string
          example: Muntendam
        mag:
          type: number
          format: float
          example: 0.9512691142
        mag_type:
          type: string
          example: MLn
        catalog:
          type: string
        contributor:
          type: string
          example: KNMI
        location:
          type: string
          example: Muntendam
        event_type:
          type: string
          example: induced or triggered event
    EventGeometry:
      type: object
      properties:
        type:
          type: string
        coordinates:
          type: array
          items:
            type: number
            format: float
    EventMetadata:
      type: object
      properties:
        created:
          type: string
          format: date-time
        url:
          type: string
        sender:
          type: string
        source:
          type: string
        count:
          type: integer
          format: int32