> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trlyr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get tolling revenue for a virtual asset

> Returns tolling revenue buckets for the virtual asset between start and end (RFC3339 query parameters).



## OpenAPI

````yaml https://api.trlyr.com/revenue-reporting/docs/doc.json get /revenue-reporting/{virtualAssetID}/tolling
openapi: 3.1.0
info:
  description: >
    This API exposes revenue data and aggregated data points for virtual assets,
    portfolios, fleets, and physical assets on the terralayr platform. 
     
    Use the revenue endpoints to query wholesale, ancillary, tolling, and
    virtual-battery-auction revenue for a virtual asset over a time range.
    Data-point endpoints return aggregated revenue metrics at raw, 15-minute,
    hourly, or daily resolution. 
     
    ### Data point categories 
     
    Data-point endpoints accept an optional `datapoints` query parameter: a
    comma-separated list of category names. When omitted, all categories for the
    asset are returned. 
     
    Each category name appears as a key under `data` in the response
    (`dataPointName` in `metaData`). 
     
    #### Total and wholesale 
     
    Wholesale metrics are calculated per 15-minute delivery period. **Buy**
    means energy imported (charging); **sell** means energy exported
    (discharging). Volume-weighted average prices (VWAP) are the average
    wholesale price weighted by traded volume within each period. **Net volume**
    is sell minus buy energy (MWh). **Net-off volume** is the portfolio
    schedule-netting volume: energy attributed to internal schedule netting
    rather than wholesale market trades. 
     
    | Category | Description | 

    | --- | --- | 

    | `revenue_total_revenue` | Total revenue across wholesale, ancillary,
    tolling, and virtual battery auction products | 

    | `revenue_wholesale` | Wholesale market revenue for the period (sell
    proceeds minus buy cost) | 

    | `buy_vwap_wholesale` | Volume-weighted average buy price over the
    15-minute period (EUR/MWh) | 

    | `sell_vwap_wholesale` | Volume-weighted average sell price over the
    15-minute period (EUR/MWh) | 

    | `buy_volume_wholesale` | Energy bought on the wholesale market in the
    period (MWh) | 

    | `sell_volume_wholesale` | Energy sold on the wholesale market in the
    period (MWh) | 

    | `net_volume_wholesale` | Net wholesale energy: sell volume minus buy
    volume (MWh) | 

    | `net_off_volume_wholesale` | Schedule-netting volume from portfolio
    internal netting (MWh) | 
     
    #### FCR 
     
    FCR metrics relate to 4-hour EFA delivery blocks. **Weighted** capacity and
    settlement price values multiply each accepted capacity or price by its
    delivery hours within the block. The weighted-average categories divide
    those sums by total delivery hours in the block. 
     
    | Category | Description | 

    | --- | --- | 

    | `revenue_fcr` | FCR capacity revenue for the delivery window | 

    | `capacity_fcr` | Accepted FCR capacity (MW) | 

    | `settlement_price_fcr` | FCR settlement price (EUR/MW per hour) | 

    | `weighted_capacity_fcr` | Accepted capacity multiplied by delivery hours
    within the window | 

    | `weighted_settlement_price_fcr` | Settlement price multiplied by delivery
    hours within the window | 

    | `delivery_hours_fcr` | FCR delivery hours in the window | 

    | `capacity_fcr_weighted_avg` | Capacity-weighted average accepted FCR
    capacity over the 4-hour EFA block | 

    | `settlement_price_fcr_weighted_avg` | Capacity-weighted average FCR
    settlement price over the 4-hour EFA block | 
     
    #### aFRR 
     
    Positive and negative energy categories refer to upward and downward aFRR
    energy activation respectively. 
     
    | Category | Description | 

    | --- | --- | 

    | `revenue_afrr_capacity` | aFRR capacity revenue | 

    | `revenue_afrr_energy` | Combined aFRR energy revenue (positive plus
    negative) | 

    | `revenue_afrr_energy_pos` | aFRR positive (upward) energy revenue | 

    | `revenue_afrr_energy_neg` | aFRR negative (downward) energy revenue | 

    | `settlement_price_afrr_energy_pos` | Settlement price for positive aFRR
    energy activations | 

    | `settlement_price_afrr_energy_neg` | Settlement price for negative aFRR
    energy activations | 

    | `total_volume_afrr_energy_pos` | Total activated positive aFRR energy
    volume | 

    | `total_volume_afrr_energy_neg` | Total activated negative aFRR energy
    volume | 
     
    #### Tolling and virtual battery auction 
     
    | Category | Description | 

    | --- | --- | 

    | `revenue_tolling` | Tolling revenue | 

    | `annual_price_tolling` | Tolling annual price | 

    | `revenue_vba` | Virtual battery auction revenue | 

    | `hurdle_price_vba` | Virtual battery auction hurdle price | 
     
    #### Normalised revenue (per MW) 
     
    **Normalised** revenue divides absolute revenue (EUR) by the virtual asset's
    average rated power capacity (MW), where capacity is the mean of rated
    charge and discharge power. This allows comparison across assets of
    different sizes. 
     
    | Category | Description | 

    | --- | --- | 

    | `revenue_normalised_total` | Total revenue normalised per MW | 

    | `revenue_normalised_wholesale` | Wholesale revenue normalised per MW | 

    | `revenue_normalised_fcr` | FCR revenue normalised per MW | 

    | `revenue_normalised_afrr_capacity` | aFRR capacity revenue normalised per
    MW | 

    | `revenue_normalised_afrr_energy` | Combined aFRR energy revenue normalised
    per MW | 

    | `revenue_normalised_afrr_energy_pos` | Positive aFRR energy revenue
    normalised per MW | 

    | `revenue_normalised_afrr_energy_neg` | Negative aFRR energy revenue
    normalised per MW | 

    | `revenue_normalised_vba` | Virtual battery auction revenue normalised per
    MW | 

    | `revenue_normalised_tolling` | Tolling revenue normalised per MW | 
     
    #### Normalised revenue (per MW per year) 
     
    These categories scale the per-MW normalised values by 365 to express an
    annualised rate (EUR/MW/year). 
     
    | Category | Description | 

    | --- | --- | 

    | `revenue_normalised_per_year_total` | Total normalised revenue per MW per
    year | 

    | `revenue_normalised_per_year_wholesale` | Wholesale revenue normalised per
    MW per year | 

    | `revenue_normalised_per_year_fcr` | FCR revenue normalised per MW per year
    | 

    | `revenue_normalised_per_year_afrr_capacity` | aFRR capacity revenue
    normalised per MW per year | 

    | `revenue_normalised_per_year_afrr_energy` | Combined aFRR energy revenue
    normalised per MW per year | 

    | `revenue_normalised_per_year_afrr_energy_pos` | Positive aFRR energy
    revenue normalised per MW per year | 

    | `revenue_normalised_per_year_afrr_energy_neg` | Negative aFRR energy
    revenue normalised per MW per year | 

    | `revenue_normalised_per_year_vba` | Virtual battery auction revenue
    normalised per MW per year | 

    | `revenue_normalised_per_year_tolling` | Tolling revenue normalised per MW
    per year | 
     
    ### Authorization 
     
    All endpoints except the health check require a Bearer token. See the [Auth
    API documentation](https://api.trlyr.com/auth/docs/index.html) for how to
    authenticate. 
     
    If you have any questions, don't hesitate to contact our account manager at
    the following address: support@trlyr.com. 
  title: terralayr Revenue Reporting API
  version: 1.0.0
servers:
  - description: Production API
    url: https://api.trlyr.com
  - description: Sandbox API
    url: https://api.sandbox.trlyr.com
security: []
tags:
  - description: >-
      Query virtual-asset, portfolio, fleet, and physical-asset revenue and
      aggregated data points.
    name: revenue
externalDocs:
  description: ''
  url: ''
paths:
  /revenue-reporting/{virtualAssetID}/tolling:
    get:
      tags:
        - revenue
      summary: Get tolling revenue for a virtual asset
      description: >-
        Returns tolling revenue buckets for the virtual asset between start and
        end (RFC3339 query parameters).
      parameters:
        - description: Access token
          in: header
          name: Authorization
          required: true
          schema:
            default: Bearer <access token value>
            type: string
        - description: Virtual asset ID
          in: path
          name: virtualAssetID
          required: true
          schema:
            format: uuid
            type: string
        - description: Interval start (RFC3339)
          in: query
          name: start
          required: true
          schema:
            type: string
        - description: Interval end (RFC3339)
          in: query
          name: end
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/pkg_models_service.GetTollingRevenue'
                type: array
          description: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
components:
  schemas:
    pkg_models_service.GetTollingRevenue:
      properties:
        annualPrice:
          type: number
        endTs:
          type: string
        revenue:
          type: number
        startTs:
          type: string
        versionNumber:
          type: string
        virtualAssetID:
          type: string
      type: object

````