Documentation/canton-network-docs/Splice APIsScan APIsScan APIView on canton-network-docs ↗
canton-network-docs/Splice APIsScan APIsScan API

GET /v0/domains/:domain_id/members/:member_id/traffic

GET
/
v0
/
domains
/
{domain_id}
/
members
/
{member_id}
/
traffic-status
Try it
GET /v0/domains/:domain_id/members/:member_id/traffic-status

cURL

curl --request GET \
  --url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status
200
400
404
500
{
  "traffic_status": {
    "actual": {
      "total_consumed": 123,
      "total_limit": 123
    },
    "target": {
      "total_purchased": 123
    }
  }
}

Path Parameters

​
domain_id
string
required

The synchronizer ID to look up traffic for.

​
member_id
string
required

The participant or mediator whose traffic to look up, in the format code::id::fingerprint where code is PAR or MED.

Response

200
application/json

ok

​
traffic_status
object
required

The current traffic state for the member on the synchronizer under actual, and the total purchased traffic under target. The purchased traffic may exceed the actual limit as purchases take time to be incorporated into the limit.

Show child attributes