Subscribe
curl --request POST \
--url https://api.example.com/v1/subscribe \
--header 'Content-Type: application/json' \
--data '
{
"topics": [
"peer_connected",
"validator_opted_in"
]
}
'import requests
url = "https://api.example.com/v1/subscribe"
payload = { "topics": ["peer_connected", "validator_opted_in"] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({topics: ['peer_connected', 'validator_opted_in']})
};
fetch('https://api.example.com/v1/subscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/subscribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'topics' => [
'peer_connected',
'validator_opted_in'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/subscribe"
payload := strings.NewReader("{\n \"topics\": [\n \"peer_connected\",\n \"validator_opted_in\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/subscribe")
.header("Content-Type", "application/json")
.body("{\n \"topics\": [\n \"peer_connected\",\n \"validator_opted_in\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/subscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"topics\": [\n \"peer_connected\",\n \"validator_opted_in\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"topic": "peer_connected",
"value": {
"ethAddress": "0x123...",
"type": "provider"
}
},
"error": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}API Reference
Subscribe
Subscribe to notifications for given topics. The client will receive notifications for the topics it has subscribed to. The client can subscribe to multiple topics.
POST
/
v1
/
subscribe
Subscribe
curl --request POST \
--url https://api.example.com/v1/subscribe \
--header 'Content-Type: application/json' \
--data '
{
"topics": [
"peer_connected",
"validator_opted_in"
]
}
'import requests
url = "https://api.example.com/v1/subscribe"
payload = { "topics": ["peer_connected", "validator_opted_in"] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({topics: ['peer_connected', 'validator_opted_in']})
};
fetch('https://api.example.com/v1/subscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/subscribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'topics' => [
'peer_connected',
'validator_opted_in'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/subscribe"
payload := strings.NewReader("{\n \"topics\": [\n \"peer_connected\",\n \"validator_opted_in\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/subscribe")
.header("Content-Type", "application/json")
.body("{\n \"topics\": [\n \"peer_connected\",\n \"validator_opted_in\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/subscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"topics\": [\n \"peer_connected\",\n \"validator_opted_in\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"topic": "peer_connected",
"value": {
"ethAddress": "0x123...",
"type": "provider"
}
},
"error": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Body
application/json
List of topics to subscribe to. Available topics:
- peer_connected: Emitted when a peer connects to the network
- peer_disconnected: Emitted when a peer disconnects from the network
- validator_opted_in: Emitted before an upcoming L1 block proposer has opted in to the mev-commit protocol
- epoch_validators_opted_in: Emitted at the beginning of an epoch, specifying any slots where the L1 validator is opted-in to mev-commit
- provider_slashed: Emitted when the provider node is slashed.
- commitment_store_failed: Emitted when the commitment storing transaction fails.
- commitment_open_failed: Emitted when the commitment opening transaction fails.
Example:
["peer_connected", "validator_opted_in"]