Get Browser Data

Public API

Endpoints

Get Browser Data

The Get Browser Data endpoint returns information about your Browser API access, including your browser API key, remaining credits, concurrency limit, maximum session length, and the browser WebSocket endpoint URL.

Endpoint

GET https://api.evomi.com/public/browser

Authentication

Requires API key in either:

x-apikey header
apikey query parameter

Example Request

curl -X GET "https://api.evomi.com/public/browser" \
  -H "x-apikey: YOUR_API_KEY"

Or via query parameter:

curl -X GET "https://api.evomi.com/public/browser?apikey=YOUR_API_KEY"

Response (User Has Access)

{
  "success": true,
  "has_access": true,
  "credits": 1000,
  "concurrency": 3,
  "api_key": "browser_key_xyz",
  "max_session_length_seconds": 60,
  "endpoint_url": "wss://browser.evomi.com"
}

Response (User Has No Access)

{
  "success": true,
  "has_access": false,
  "credits": 0,
  "concurrency": 0,
  "api_key": null,
  "max_session_length_seconds": 0,
  "endpoint_url": "wss://browser.evomi.com"
}

Fields in the Response

Field	Type	Description
`success`	boolean	Whether the request was processed successfully
`has_access`	boolean	Whether the user has access to the Browser API
`credits`	integer	Remaining browser credits
`concurrency`	integer	Maximum number of concurrent browser sessions
`api_key`	string \| null	Your Browser API key, or `null` if you don’t have access
`max_session_length_seconds`	integer	Maximum allowed duration for a single browser session, in seconds
`endpoint_url`	string	The Browser API WebSocket endpoint URL

ℹ️

The api_key returned here is your Browser API key, used to authenticate browser sessions against the browser endpoint. It is distinct from the Evomi public API key used to call this endpoint.

Error Responses

401 Unauthorized: The API key provided is either missing or invalid. Ensure that you are passing the correct API key either in the URL or in the request header.
500 Internal Server Error: This indicates a problem on our server side. Please contact support if you encounter this error.

For more information on how to authenticate your requests, check out the Authentication page.

Get Scraper Data