API Data Provider - Online Help

Connecting to Browserless

Browserless uses HTTP API token authentication. Your Browserless API token is sent as the token query parameter on every request. You can generate or view your token in the Browserless dashboard at https://account.browserless.io/.

Using ApiKey Authentication

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Browserless API token.

Example connection string:

Profile=C:\profiles\Browserless.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_token";

Available Tables

The Browserless API Profile provides access to browser-automation services across 5 tables. The profile targets the production-sfo.browserless.io region; clients needing other regions (production-lon, production-ams) can override the host via standard CData API Driver URL configuration.

  • Scrape - Selector-based extraction of text, HTML, attributes, and bounding-box metadata from a target URL. One row per CSS selector queried.
  • SmartScrape - Multi-strategy scrape that returns content in requested formats (html, markdown, screenshot, pdf, links) with automatic fallbacks for blocked sites.
  • Map - URL discovery on a target site (sitemap and crawl-based) ranked optionally by a search query. One row per discovered URL.
  • Unblock - Bypass CAPTCHAs and bot detection on a target URL; optionally returns content, cookies, screenshot, and a WebSocket endpoint for handoff to Puppeteer or Playwright.
  • Performance - Lighthouse audit (performance, accessibility, SEO, best-practices, PWA) for a target URL. Returns the full Lighthouse report under the data column tree.

Usage Examples

Map:

SELECT * FROM Map WHERE Url = 'https://www.example.com'

Performance:

SELECT * FROM Performance WHERE Url = 'https://www.example.com'

Scrape:

SELECT * FROM Scrape WHERE Url = 'https://www.example.com' AND Elements = '[{"selector":"h1"}]'

SmartScrape:

SELECT * FROM SmartScrape WHERE Url = 'https://www.example.com'

Unblock:

SELECT * FROM Unblock WHERE Url = 'https://www.example.com'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey The API token used to authenticate to Browserless.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655.0