---
updatedAt: 2026-08-27T13:58:27.000Z
agentTools:
  projectIndex: https://docs.noves.fi/llms.txt
---

# /{chain}/validators/{validatorParty}/trafficBalance

Returns the validator’s traffic balance in bytes, including purchased traffic remaining and the network’s free traffic allowance.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Canton API",
    "description": "Query public and private Canton updates, balances, prices, rewards, verdicts, and Featured App activity. Create stream subscriptions and alerts for ongoing delivery.",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.canton.noves.fi/"
    }
  ],
  "paths": {
    "/{chain}/validators/{validatorParty}/trafficBalance": {
      "get": {
        "tags": [
          "Validators"
        ],
        "summary": "/{chain}/validators/{validatorParty}/trafficBalance",
        "description": "Returns the validator’s traffic balance in bytes, including purchased traffic remaining and the network’s free traffic allowance.",
        "parameters": [
          {
            "name": "chain",
            "in": "path",
            "description": "Canton chain name. Use a name returned by `GET /chains`.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string",
              "default": "canton",
              "example": "canton"
            }
          },
          {
            "name": "validatorParty",
            "in": "path",
            "description": "Full Canton validator party ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "apiKey",
            "in": "header",
            "description": "API Key for Canton API. To generate an API Key, visit https://app.noves.fi",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string",
              "default": "demokey"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidatorTrafficBalanceDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "502": {
            "description": "Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      },
      "TrafficBalanceDto": {
        "type": "object",
        "properties": {
          "purchased": {
            "type": "integer",
            "description": "Total extra traffic purchased.",
            "format": "int64"
          },
          "limit": {
            "type": "integer",
            "description": "Total extra traffic currently credited.",
            "format": "int64"
          },
          "consumed": {
            "type": "integer",
            "description": "Total credited extra traffic consumed.",
            "format": "int64"
          },
          "available": {
            "type": "integer",
            "description": "Remaining purchased traffic: credited limit minus consumed extra traffic.",
            "format": "int64"
          },
          "pendingPurchasedNotCredited": {
            "type": "integer",
            "description": "Purchased extra traffic not yet credited.",
            "format": "int64"
          },
          "freeTrafficAllowance": {
            "type": "integer",
            "description": "Maximum free traffic allowance configured by the network, in bytes. This is not a point-in-time remaining balance.",
            "format": "int64"
          },
          "freeTrafficReplenishWindowSeconds": {
            "type": "integer",
            "description": "Window over which the network's free traffic allowance replenishes, in seconds.",
            "format": "int64"
          }
        },
        "additionalProperties": false,
        "description": "Point-in-time synchronizer traffic counters, in bytes."
      },
      "ValidatorTrafficBalanceDto": {
        "type": "object",
        "properties": {
          "validatorPartyId": {
            "type": "string",
            "description": "Full Canton validator party ID used for the lookup.",
            "nullable": true
          },
          "participantId": {
            "type": "string",
            "description": "Participant member ID hosting the validator party.",
            "nullable": true
          },
          "synchronizerId": {
            "type": "string",
            "description": "Synchronizer ID to which the traffic counters apply.",
            "nullable": true
          },
          "trafficBalance": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TrafficBalanceDto"
              }
            ],
            "description": "Point-in-time synchronizer traffic counters, in bytes.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Point-in-time synchronizer traffic balance and byte counters for a validator."
      }
    }
  }
}
```