HurricaneData
=============



The HurricaneData service provides access to the revised Atlantic hurricane
database (HURDAT2) from the National Hurricane Center (NHC).

For more information, check out https://www.aoml.noaa.gov/hrd/data_sub/re_anal.html



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: HurricaneData.getHurricaneData(name: String, year: YearSince<1850>)

    Get hurricane data including location, maximum winds, and central pressure.

    **Arguments:**

    - ``name: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - name of the hurricane
    - ``year: YearSince<1850>`` (`YearSince </docs/fundamentals/rpc-arg-types.html#YearSince>`__) - year that the hurricane occurred in

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - All recorded data for the given hurricane


.. function:: HurricaneData.getHurricanesInYear(year: YearSince<1850>)

    Get the names of all hurricanes occurring in the given year.

    **Arguments:**

    - ``year: YearSince<1850>`` (`YearSince </docs/fundamentals/rpc-arg-types.html#YearSince>`__) 

    **Returns:** ``List<String>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - names


.. function:: HurricaneData.getYearsWithHurricaneNamed(name: String)

    Get the years in which a hurricane with the given name occurred.

    **Arguments:**

    - ``name: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - name of the hurricane to find the year(s) of

    **Returns:** ``List<Integer>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Integer </docs/fundamentals/rpc-arg-types.html#Integer>`__) - years - list with all of the years that a particular name has been used for a hurricane