Overview
========

The FloatHub API is accessed via HTTPS in a similar fashion to many other
APIs.  We will show examples using `curl <https://curl.se/>`_ on the command
line, but any system, package, or language that makes standard HTTPS calls
can be used to implement access to the system.

To run any of the examples, you will need a FloatHub username (or,
equivalently, the email address used to register a FloatHub account) and
password.  These are available for free at the `FloatHub Signup Page
<https://floathub.com/signup>`_.


Versioning and the API Base URL
-------------------------------

The current version of the FloatHub API is 2.0. All HTTPS calls are made
against a Base URL which includes the current version, so that current value
is::

  https://api.floathub.com/v2

The sections which follow cover :doc:`authentication <authentication>`,
retrieving current :doc:`status <status>`, searching for nearby
:doc:`vessels <vessels>`, and then accessing your vessel's :doc:`historical
data <history>`.