---
sd_hide_title: true
---

```{raw} html
<style>
  #pst-primary-sidebar, #pst-secondary-sidebar {
    display: none;
  }
  .bd-sidebar-secondary {
    display: none;
  }
  .bd-article-container {
    margin: 0 auto;
    max-width: 100% !important;
  }
</style>
```

# Welcome to the api-24sea project documentation!

```{topic} Release Prod
Version {sub-ref}`release`
```

**api_24sea** is a Python project designed to provide aid for the interaction
with data from the [24SEA API](https://api.24sea.eu/docs/v1).

Since the [API](https://api.24sea.eu/docs/v1) returns data in JSON format,
which is not very user-friendly, we have created a package that allows you to
interact with the data in a more efficient way. The package is designed to
perform queries asynchronously through the [httpx](https://www.python-httpx.org/)
library, which allows you to make multiple requests at the same time.
Furthermore, the interaction with the data is facilitated by transforming the
output of the queries into
[pandas DataFrames](https://pandas.pydata.org/docs/reference/frame.html#dataframe)
for easy manipulation and analysis.

:::{note}
Some pages have been protected with a master password. If you are
interested in accessing them, please contact 24SEA at
[support.api@24sea.eu](mailto:support.api@24sea.eu), and we will
see what we can do 😊.
:::

---

::::{grid} 1 2 3 3
:gutter: 3 3 4 5

:::{grid-item-card}
![manual](_static/img/user-manual.png) &nbsp;&nbsp;&nbsp;&nbsp; **Tutorials**

New to api_24sea? Start here with step-by-step learning guides.

+++

```{button-ref} tutorials/index
:expand:
:color: primary
:click-parent:

To the tutorials
```
:::

:::{grid-item-card}
![howto](_static/img/book.png) &nbsp;&nbsp;&nbsp;&nbsp; **How-to Guides**

Practical recipes for solving specific problems with the package.

+++

```{button-ref} how-to/index
:expand:
:color: primary
:click-parent:

To the how-to guides
```
:::

:::{grid-item-card}
![ref](_static/img/package.png) &nbsp;&nbsp;&nbsp;&nbsp; **API Reference**

Technical descriptions of every class, method, and function in api_24sea.

+++

```{button-ref} autoapi/index
:expand:
:color: primary
:click-parent:

To the reference guide
```
:::

:::{grid-item-card}
![plugin](_static/img/plugin.png) &nbsp;&nbsp;&nbsp;&nbsp; **Package Plugins**

The package plugins allow to extend the package functionalities
by adding new features.

+++

```{button-ref} how-to/install-plugins
:expand:
:color: primary
:click-parent:

To the plugins installation guide
```
:::

:::{grid-item-card}
![changelog](_static/img/changelog.png) &nbsp;&nbsp;&nbsp;&nbsp; **Changelog**

Release notes and changelog for all versions of the package.

+++

```{button-ref} explanation/changelog
:expand:
:color: primary
:click-parent:

To the changelog
```
:::

:::{grid-item-card}
![python](_static/img/python.png) &nbsp;&nbsp;&nbsp;&nbsp; **Interactive Example**

Test the package functionalities directly in the documentation
by running Python in the browser.

+++

```{button-ref} tutorials/interactive-example
:expand:
:color: primary
:click-parent:

To the interactive example
```
:::

:::{grid-item-card}
![dashboard](_static/img/dashboard.png) &nbsp;&nbsp;&nbsp;&nbsp; **Dashboard**

A simple web application that allows you to visualize the data retrieved
from the API.

+++

```{button-ref} tutorials/dashboard
:expand:
:color: primary
:click-parent:

To the dashboard
```
:::

::::

---

```{toctree}
:hidden:

tutorials/index
how-to/index
autoapi/index
explanation/index
```

## License

The package is licensed under the
[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).

## Miscellaneous Pages

- {ref}`genindex`
- {ref}`modindex`
- {ref}`search`