Skip to contents

API Client

Core functions for interacting with the FlowFabric API.

flowfabric_list_datasets()
List all available datasets
flowfabric_streamflow_estimate()
Estimate streamflow result size and get export_url when available
flowfabric_streamflow_query()
Query streamflow
flowfabric_ratings_query()
Query REM ratings (stage-discharge relationships)
flowfabric_stage_query()
Query stage data (Arrow IPC)
flowfabric_get_token()
Get a JWT Bearer Token for FlowFabric API
flowfabric_token()
Manage global FlowFabric API token
flowfabric_get_dataset()
Get dataset details from catalog
flowfabric_get_latest_run()
Get latest run for a dataset
flowfabric_healthz()
Health check
flowfabric_inundation_ids()
Query inundation ids
flowfabric_ratings_estimate()
Estimate size of ratings query
get_bearer_token()
Retrieve Bearer Token
flowfabricr flowfabricr-package
flowfabricr: R Client for FlowFabric API

Catalog Utilities

auto_streamflow_params()
Auto-populate streamflow query params from catalog

HTTP Utilities

flowfabric_get()
Perform a GET request to the FlowFabric API
flowfabric_post()
Perform a POST request to the FlowFabric API

Auth Utilities

flowfabric_refresh_token()
Force refresh the token