# Superfluid Reporter

> Superfluid Reporter (https://reporter.superfluid.org) is a Vite + React SPA with a single `/` path.
> All shareable state lives in URL query parameters.
> Use the machine-readable contract below to programmatically construct valid deep-link URLs.
> Account balance data is provided by the Superfluid Balances API (OpenAPI spec: https://balances.superfluid.dev/doc, explorer: https://balances.superfluid.dev/ui).

## Form Parameters

- [account](/url-params.schema.json#/properties/account) - EVM account address to report on.
- [chain](/url-params.schema.json#/properties/chain) (aliases: chainId) - Canonical Superfluid chain slug. Numeric chain IDs are accepted as the deprecated `chainId` alias and resolved at parse time.
- [tokens](/url-params.schema.json#/properties/tokens) (aliases: token) - Comma-separated EVM Super Token addresses to include in the report.
- [startDate](/url-params.schema.json#/properties/startDate) - Report start date in YYYY-MM-DD format (inclusive).
- [endDate](/url-params.schema.json#/properties/endDate) - Report end date in YYYY-MM-DD format (inclusive).
- [period](/url-params.schema.json#/properties/period) - Aggregation period for the report.
- [forecast](/url-params.schema.json#/properties/forecast) - When `true`, project balances past the current time from the current net flow rate: summary cards show a projected balance and the report includes future periods (sent to the balance API as `extrapolate=true`). Omit (the default) for a non-speculative report that is capped at now, with the in-progress period flagged as not finalized.

## Display Parameters

- [decimals](/url-params.schema.json#/properties/decimals) - Number of decimal places used for token amount display.
- [tab](/url-params.schema.json#/properties/tab) - Active report tab.
- [theme](/url-params.schema.json#/properties/theme) - UI color theme override. Omit to inherit the system preference.
- [t_hide_zero](/url-params.schema.json#/properties/t_hide_zero) - When set to 1, hides rows with a zero net flow in the Totals tab.

## Filter Parameters

- [mv_counterparties](/url-params.schema.json#/properties/mv_counterparties) - Comma-separated EVM addresses to filter the Movements tab by counterparty.
- [mv_categories](/url-params.schema.json#/properties/mv_categories) - Comma-separated movement categories to show in the Movements tab. Valid values: transfer, cfa, gda, ida, wrap, unwrap, mint, burn, liquidation, gda_distributor, gda_adjustment, gda_member, ida_publisher, ida_subscriber.
- [mv_direction](/url-params.schema.json#/properties/mv_direction) - Flow direction filter for the Movements tab.
- [mv_connection](/url-params.schema.json#/properties/mv_connection) - Connection status filter for the Movements tab.
- [cp_counterparties](/url-params.schema.json#/properties/cp_counterparties) - Comma-separated EVM addresses to filter the Counterparty tab.
- [cat_categories](/url-params.schema.json#/properties/cat_categories) - Comma-separated movement categories to filter the Category tab. Valid values: transfer, cfa, gda, ida, wrap, unwrap, mint, burn, liquidation, gda_distributor, gda_adjustment, gda_member, ida_publisher, ida_subscriber.

## Export Parameters

- [e_profile](/url-params.schema.json#/properties/e_profile) - Export profile that sets the overall CSV format and column structure. Required to activate export params; all other e_* params are optional overrides.
- [e_asym](/url-params.schema.json#/properties/e_asym) - Asset symbol mode: use the Super Token symbol or the underlying ERC-20 symbol.
- [e_cagg](/url-params.schema.json#/properties/e_cagg) - Counterparty aggregation: emit one row per counterparty, net into one row, or both.
- [e_gran](/url-params.schema.json#/properties/e_gran) *(deprecated)* - Granularity (deprecated - now derived from the report period; parsed for backward compatibility but never written back).
- [e_dverb](/url-params.schema.json#/properties/e_dverb) - Description column verbosity.
- [e_rname](/url-params.schema.json#/properties/e_rname) - Resolve on-chain ENS / Superfluid metadata to human-readable names.
- [e_wwrap](/url-params.schema.json#/properties/e_wwrap) - Wrap/unwrap event handling: suppress from output or emit as transfer rows.
- [e_bdate](/url-params.schema.json#/properties/e_bdate) - Booking date used as the row timestamp for stream-period rows.
- [e_dfmt](/url-params.schema.json#/properties/e_dfmt) - Date format for date columns in the CSV.
- [e_dsep](/url-params.schema.json#/properties/e_dsep) - Decimal separator for amount columns.
- [e_tsep](/url-params.schema.json#/properties/e_tsep) - Thousands separator for amount columns.
- [e_nprec](/url-params.schema.json#/properties/e_nprec) *(deprecated)* - Number precision / decimal places (deprecated - now derived from the Decimals display setting; parsed for backward compatibility but never written back).
- [e_wkst](/url-params.schema.json#/properties/e_wkst) - Week start day for weekly granularity. 0=Sunday, 1=Monday, …, 6=Saturday.
- [e_fystart](/url-params.schema.json#/properties/e_fystart) - Fiscal year start as MM-DD (e.g. 04-01 for April 1). Affects annual granularity bucketing.
- [e_fntpl](/url-params.schema.json#/properties/e_fntpl) - Filename template for downloaded CSVs. Supports {entity}, {period}, {profile}, {timestamp}, {chain}, {token} placeholders.
- [e_addrcols](/url-params.schema.json#/properties/e_addrcols) - Include raw EVM address columns alongside human-readable name columns.

## Resources

- [/url-params.schema.json](/url-params.schema.json) - Full JSON Schema 2020-12 contract for all URL parameters
- [docs/url-params.md](https://github.com/superfluid-org/superfluid-reporter/blob/main/docs/url-params.md) - Human-readable URL parameter documentation
- [Superfluid Balances API](https://balances.superfluid.dev/doc) - OpenAPI spec for the balance indexer that powers the reports (explorer: https://balances.superfluid.dev/ui)