Run a stream now
curl --request POST \
--url https://api.example.com/api/v2/streams/{streamId}/runimport requests
url = "https://api.example.com/api/v2/streams/{streamId}/run"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v2/streams/{streamId}/run', 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/api/v2/streams/{streamId}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/streams/{streamId}/run"
req, _ := http.NewRequest("POST", url, nil)
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/api/v2/streams/{streamId}/run")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/streams/{streamId}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyStreams (campaigns)
Run a stream now
Trigger a sync across every pair in a campaign
POST
/
api
/
v2
/
streams
/
{streamId}
/
run
Run a stream now
curl --request POST \
--url https://api.example.com/api/v2/streams/{streamId}/runimport requests
url = "https://api.example.com/api/v2/streams/{streamId}/run"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v2/streams/{streamId}/run', 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/api/v2/streams/{streamId}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/streams/{streamId}/run"
req, _ := http.NewRequest("POST", url, nil)
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/api/v2/streams/{streamId}/run")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/streams/{streamId}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyTriggers a sync (X-API follower fetch + classification) across every active pair in the stream. Consumes one daily sync slot per account.
For re-test-only (cached profiles, no follower fetch) use Re-test a stream.
Body
None.Response
{
"queued": [
{ "trackedAccountId": 7, "syncRunId": 123 }
],
"skipped": [
{ "trackedAccountId": 8, "reason": "budget_exhausted" }
]
}
skipped.reason is one of budget_exhausted (daily sync cap hit) or account_sleeping.
Poll each queued runId with GET /streams//runs/.
Errors
| Code | HTTP | When |
|---|---|---|
Stream not found | 404 | |
Stream is archived | 400 | Restore the stream first |
Auth
Bearer or session cookie.⌘I