API Documentation

Understanding the basics of our REST API

Introduction

Our REST API provides programmatic access to all the functionality you need to manage browsers, run tasks, and collect data. This guide explains core concepts and provides examples to help you get started.

API Endpoints

All API requests should be made to the following base URL:

URL

https://browserize.com/api

The API is organized around REST principles. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Response Format

All responses are returned in JSON format. A typical success response looks like this:

json

{
  "success": true,
  "data": {
    "id": "browser_123456",
    "name": "Chrome Instance",
    "status": "active",
    "created_at": "2023-04-15T12:30:45Z"
  }
}

Error responses include details about what went wrong:

json

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "The browser ID provided does not exist",
    "status": 404
  }
}

Rate Limiting

To ensure stability for all users, the API implements rate limiting. Current limits are:

Plan	Requests per minute	Requests per day
Free	60	10,000
Professional	120	50,000
Enterprise	500	Unlimited

Rate limit information is included in the response headers:

http

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 56
X-RateLimit-Reset: 1616999999

Next Steps

Now that you understand the basics, you can explore: