Developers: API

This section documents the CKAN API for developers who want to write code that interacts with CKAN sites and their data.

The CKAN Action API is a powerful RPC-style API that exposes all the core features of CKAN to API clients. All the main functionality of a CKAN website (everything that can be done through the web interface and more) can be used through external code calling the CKAN API. For example, using the CKAN API, your application can:

• Get JSON-formatted lists of datasets, organizations, groups, or other CKAN objects:
  • https://opendata.lloret.cat/api/3/action/package_list
  • https://opendata.lloret.cat/api/3/action/organization_list
  • https://opendata.lloret.cat/api/3/action/group_list
  • https://opendata.lloret.cat/api/3/action/tag_list
• Get a complete JSON representation of a dataset, a resource, or another object:
  • https://opendata.lloret.cat/api/3/action/tag_show?id=energía
  • https://opendata.lloret.cat/api/3/action/organization_show?id=ayuntamiento-de-lloret-de-mar
• Search for packages or resources that match a query:
  • https://opendata.lloret.cat/api/3/action/package_search?q=educativos
  • https://opendata.lloret.cat/api/3/action/resource _search?query=name:face

For detailed information about the CKAN API, you can access the following URL: https://docs.ckan.org/en/2.8/api/