GET /v0/domains/:domain_id/members/:member_id/traffic-status
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request GET \
--url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status'
import json
import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status"
response = requests.request("GET", url)
print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status', {
method: 'GET',
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status", nil)
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
200
400
404
500
{
"traffic_status": {
"actual": {
"total_consumed": 123,
"total_limit": 123
},
"target": {
"total_purchased": 123
}
}
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
GET
/
api
/
scan
/
v0
/
domains
/
{domain_id}
/
members
/
{member_id}
/
traffic-status
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request GET \
--url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status'
import json
import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status"
response = requests.request("GET", url)
print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status', {
method: 'GET',
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status", nil)
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
200
400
404
500
{
"traffic_status": {
"actual": {
"total_consumed": 123,
"total_limit": 123
},
"target": {
"total_purchased": 123
}
}
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
Get a member’s traffic status as reported by the sequencer, according to ledger state at the time of the request.
OpenAPI
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request GET \
--url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status'
import json
import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status"
response = requests.request("GET", url)
print(response.text)
const response = await fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status', {
method: 'GET',
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status", nil)
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
200
400
404
500
{
"traffic_status": {
"actual": {
"total_consumed": 123,
"total_limit": 123
},
"target": {
"total_purchased": 123
}
}
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
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.Responses
200
okapplication/json
traffic_status
MemberTrafficStatus
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
Show child attributes
actual
ActualMemberTrafficState
required
The current traffic state for the member on the synchronizer
Show child attributes
Show child attributes
400
bad requestapplication/json
error
string
required
404
not foundapplication/json
error
string
required
500
internal server errorapplication/json
error
string
required