Current SmartBrowse plan caps and 30-day usage
curl --request GET \
--url https://api.webscrape.ai/v1/smartbrowse/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.webscrape.ai/v1/smartbrowse/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.webscrape.ai/v1/smartbrowse/usage', 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.webscrape.ai/v1/smartbrowse/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.webscrape.ai/v1/smartbrowse/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.webscrape.ai/v1/smartbrowse/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.webscrape.ai/v1/smartbrowse/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "completed",
"request_id": "req_aB3xY9Kp",
"data": {
"runs_used_30d": 123,
"runs_per_month_cap": 123,
"pages_per_run_cap": 123,
"cost_per_page": 123,
"schedules_count": 123,
"schedules_allowed": true,
"last_run": {
"id": "k7Xb9dRmQ2p",
"pages_extracted": 123,
"effective_cap": 123,
"clamped_by_credits": true,
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
},
"credits_used": 0,
"credits_remaining": 123
}{
"status": "error",
"error": {
"code": "unauthorized",
"message": "missing or invalid credentials"
},
"request_id": "req_aB3xY9Kp"
}{
"status": "error",
"error": {
"code": "internal_error",
"message": "internal error"
},
"request_id": "req_aB3xY9Kp"
}SmartBrowse
Current SmartBrowse plan caps and 30-day usage
Returns the caller’s rolling-30-day run count, plan caps (runs/month, pages/run, cost/page), schedule allowance, and a summary of their last run (if any).
Polling is free — credits_used is always 0.
GET
/
smartbrowse
/
usage
Current SmartBrowse plan caps and 30-day usage
curl --request GET \
--url https://api.webscrape.ai/v1/smartbrowse/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.webscrape.ai/v1/smartbrowse/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.webscrape.ai/v1/smartbrowse/usage', 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.webscrape.ai/v1/smartbrowse/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.webscrape.ai/v1/smartbrowse/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.webscrape.ai/v1/smartbrowse/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.webscrape.ai/v1/smartbrowse/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "completed",
"request_id": "req_aB3xY9Kp",
"data": {
"runs_used_30d": 123,
"runs_per_month_cap": 123,
"pages_per_run_cap": 123,
"cost_per_page": 123,
"schedules_count": 123,
"schedules_allowed": true,
"last_run": {
"id": "k7Xb9dRmQ2p",
"pages_extracted": 123,
"effective_cap": 123,
"clamped_by_credits": true,
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
},
"credits_used": 0,
"credits_remaining": 123
}{
"status": "error",
"error": {
"code": "unauthorized",
"message": "missing or invalid credentials"
},
"request_id": "req_aB3xY9Kp"
}{
"status": "error",
"error": {
"code": "internal_error",
"message": "internal error"
},
"request_id": "req_aB3xY9Kp"
}Authorizations
Response
Usage returned.
Discriminator for the envelope variant.
Available options:
completed Per-request id. Also returned as the X-Request-ID response
header. Include it when reporting issues.
Example:
"req_aB3xY9Kp"
Show child attributes
Show child attributes
Always 0 — polling usage is free.
Example:
0
⌘I