<commit_before>Introduction
============

.. important::

   This API is currently in BETA and important changes can be made until finale release.

   Don't hesitate to report any problem you encounter when using it.


.. note::

   If you are already familiar with the structure of the data within the platform and are a seasoned developer or data
   scientist, you may want to dive right in and checkout the `API console <https://data.opendatasoft.com/api/v2/console>`_
   and/or the `API Swagger definition <https://data.opendatasoft.com/api/v2/swagger.json>`_.

   Both these links point to OpenDataSoft's central repository of open data but if you have a portal, you can access
   the same page at ``http://<youropendatasoftportal>/api/``.

In the following section, we'll assume that you know what HTTP verbs (``GET``, ``POST``, ``PUT``...) are and that you
are familiar with HTTP-related vocabulary such as *call*, *request*, *response* *body payload*, *query parameters* etc.
If you are not then please refer to the :doc:`glossary </platform_glossary>` whenever you find a term you do not understand.


OpenDataSoft's API V2 is a full-REST, HATEOAS-enabled, JSON-first API designed to provide access in a coherent,
hierarchical way to all the data available through the platform.

This means that all API endpoints will return JSON data unless required otherwise, that endpoints are organized in a
hierarchical way describing the relative relationship between objects and that all responses will contain a list of
links allowing for easy and relevant navigation through the API endpoints.<commit_msg>Add deprecation warning to previous APIv2 doc<commit_after>Introduction
============

.. important::

   A new version of APIv2 will be available before the end of May. Major breaking changes will occur, which means that action will be needed on your side if you use it. Please contact us if you need additional information.


.. note::

   If you are already familiar with the structure of the data within the platform and are a seasoned developer or data
   scientist, you may want to dive right in and checkout the `API console <https://data.opendatasoft.com/api/v2/console>`_
   and/or the `API Swagger definition <https://data.opendatasoft.com/api/v2/swagger.json>`_.

   Both these links point to OpenDataSoft's central repository of open data but if you have a portal, you can access
   the same page at ``http://<youropendatasoftportal>/api/``.

In the following section, we'll assume that you know what HTTP verbs (``GET``, ``POST``, ``PUT``...) are and that you
are familiar with HTTP-related vocabulary such as *call*, *request*, *response* *body payload*, *query parameters* etc.
If you are not then please refer to the :doc:`glossary </platform_glossary>` whenever you find a term you do not understand.


OpenDataSoft's API V2 is a full-REST, HATEOAS-enabled, JSON-first API designed to provide access in a coherent,
hierarchical way to all the data available through the platform.

This means that all API endpoints will return JSON data unless required otherwise, that endpoints are organized in a
hierarchical way describing the relative relationship between objects and that all responses will contain a list of
links allowing for easy and relevant navigation through the API endpoints.
{'fraction_non_alphanumeric': 0.07397342995169082, 'fraction_numerical': 0.0024154589371980675, 'mean_word_length': 4.4311475409836065, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5433307', 'n_tokens_mistral': 866, 'n_tokens_neox': 818, 'n_words': 463}