Skip to main content
Ctrl+K
freva user guide 2504.0.0 documentation - Home freva user guide 2504.0.0 documentation - Home
  • Freva python module
  • The Freva command line interface
  • API Reference
  • Plugin Developer Guide
  • Examples
    • Frequently Ask Questions and best practices
    • What’s new
  • GitHub
  • Freva python module
  • The Freva command line interface
  • API Reference
  • Plugin Developer Guide
  • Examples
  • Frequently Ask Questions and best practices
  • What’s new
  • GitHub

Section Navigation

  • Plugin API Reference
  • Parameter API Reference
  • Databrowser Rest API
  • API Reference

API Reference#

This chapter introduces various freva API’s here you can get an overview over the plugin API and the parameter API for getting to know how to set up your own data analysis plugins as well as the databrowser REST API that let’s you search the databrowser via simple REST requests.

  • Plugin API Reference
    • PluginAbstract
  • Parameter API Reference
    • Bool
    • CacheDirectory
    • Date
    • File
    • Float
    • InputDirectory
    • Integer
    • ParameterBaseType
    • ParameterDictionary
    • ParameterType
    • Range
    • SelectField
    • SolrField
    • String
    • Unknown
  • Databrowser Rest API
    • Getting an overview
    • Searching for datasets locations
    • Searching for metadata
    • Generating a STAC Catalogue
    • Generating an intake-esm catalogue
    • Creating zarr endpoints for streaming data
    • Adding and deleting User Data in Databrowser

previous

The Freva command line interface

next

Plugin API Reference

© Copyright 2025, DKRZ.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.16.1.