Skip to main content
GET
/
usage
List browser session usage
curl --request GET \
  --url https://api.browser.tinyfish.ai/usage \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.browser.tinyfish.ai/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.browser.tinyfish.ai/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.browser.tinyfish.ai/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.browser.tinyfish.ai/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.browser.tinyfish.ai/usage")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.browser.tinyfish.ai/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
{
  "items": [
    {
      "session_id": "tf-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "user_id": "cus_abc123",
      "sub_user_id": "user_abc123",
      "mode": "tf-browser",
      "start_time": "2026-03-18T16:18:35Z",
      "end_time": "2026-03-18T16:28:36Z",
      "duration_ms": 600543,
      "proxy_trg_rx_bytes": 38006,
      "proxy_trg_tx_bytes": 952337,
      "status": "ended",
      "created_at": "2026-03-18T16:18:12Z",
      "updated_at": "2026-03-18T16:28:36Z"
    }
  ],
  "total": 1,
  "limit": 100,
  "page": 1,
  "total_pages": 1,
  "has_more": false
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
}
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
}
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
}
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
}
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
}
}

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Query Parameters

session_id
string
start_after
string<date-time>
end_before
string<date-time>
status
enum<string>
Available options:
running,
ended
limit
integer
default:100
Required range: 1 <= x <= 1000
page
integer
default:1
Required range: x >= 1

Response

Browser usage retrieved successfully.

Paginated browser usage response

items
object[]
required
total
integer
required
limit
integer
required
page
integer
required
total_pages
integer
required
has_more
boolean
required