Movebank
========



Access to Movebank, a free, online database of animal tracking data hosted by the Max Planck Institute of Animal Behavior.



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





RPCS
----

.. function:: Movebank.getAnimals(study: Object)

    Get a list of all the animals that participated in a specific study.

    **Arguments:**

    - ``study: Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - A study object returned by :func:`Movebank.getStudies`

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - A list of animals


.. function:: Movebank.getEvents(study: Object, animal: Object, minDistance: BoundedNumber<0>?)

    Get a chronological list of all the migration events for an animal in a specific study.

    **Arguments:**

    - ``study: Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - A study object returned by :func:`Movebank.getStudies`
    - ``animal: Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - An animal object returned by :func:`Movebank.getAnimals`. The animal should be part of the same study.
    - ``minDistance: BoundedNumber<0>?`` (`BoundedNumber </docs/fundamentals/rpc-arg-types.html#BoundedNumber>`__) - The minimum distance (in meters) between consecutive returned events (default 0, which gives all available data).

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - A list of chronological migration events for the animal


.. function:: Movebank.getSensorTypes()

    Get a list of all the sensor types supported by Movebank.

    **Returns:** ``List<String>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - A list of supported sensor types


.. function:: Movebank.getStudies()

    Get a list of all the studies available for (public) viewing.

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - A list of available studies


.. function:: Movebank.getStudiesNear(latitude: Latitude, longitude: Longitude, distance: BoundedNumber<0>)

    Get a list of all the studies available for (public) viewing within a certain max distance of a point of interest.
    Note that some of the animals involved in these studies may travel outside of this distance.

    **Arguments:**

    - ``latitude: Latitude`` (`Latitude </docs/fundamentals/rpc-arg-types.html#Latitude>`__) - Latitude of the point of interest
    - ``longitude: Longitude`` (`Longitude </docs/fundamentals/rpc-arg-types.html#Longitude>`__) - Longitude of the point of interest
    - ``distance: BoundedNumber<0>`` (`BoundedNumber </docs/fundamentals/rpc-arg-types.html#BoundedNumber>`__) - Max distance from the point of interest (in meters)

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - A list of available studies near the point of interest