Module `Pxshot`Source

Pxshot - Official OCaml SDK for the Pxshot screenshot API

Types

Sourcetype format =

| Png
| Jpeg
| Webp

Image format for screenshots

Sourcetype wait_until =

| Load
| Domcontentloaded
| Networkidle

Wait condition for page loading

Sourcetype screenshot_options = {

url : string;
format : format option;
quality : int option;
width : int option;
height : int option;
full_page : bool option;
wait_until : wait_until option;
wait_for_selector : string option;
wait_for_timeout : int option;
device_scale_factor : float option;
store : bool option;
block_ads : bool option;

}

Screenshot options

Sourcetype stored_screenshot = {

url : string;
expires_at : string;
width : int;
height : int;
size_bytes : int;

}

Result when store=true

Sourcetype screenshot_response =

| Bytes of bytes
| Stored of stored_screenshot

Screenshot response - either raw bytes or stored URL

Sourcetype usage = {

screenshots_taken : int;
screenshots_limit : int;
bytes_used : int;
bytes_limit : int;
period_start : string;
period_end : string;

}

Usage statistics

Sourcetype error =

| Unauthorized of string
| BadRequest of string
| RateLimited of string
| ServerError of string
| NetworkError of string
| ParseError of string

Error types

Client

Sourcetype t

The Pxshot client

Sourceval create : ?base_url:string -> string -> t

Create a new Pxshot client with the given API key.

parameter base_url
Optional custom API base URL (defaults to https://api.pxshot.com)

Screenshot

Source

val screenshot : 
  t ->
  url:string ->
  ?format:format ->
  ?quality:int ->
  ?width:int ->
  ?height:int ->
  ?full_page:bool ->
  ?wait_until:wait_until ->
  ?wait_for_selector:string ->
  ?wait_for_timeout:int ->
  ?device_scale_factor:float ->
  ?store:bool ->
  ?block_ads:bool ->
  unit ->
  (screenshot_response, error) result Lwt.t

Capture a screenshot of the given URL.

parameter url
The URL to capture

parameter format
Image format (default: Png)

parameter quality
JPEG/WebP quality 1-100 (default: 80)

parameter width
Viewport width in pixels (default: 1280)

parameter height
Viewport height in pixels (default: 720)

parameter full_page
Capture the full scrollable page (default: false)

parameter wait_until
Wait condition (default: Load)

parameter wait_for_selector
CSS selector to wait for before capture

parameter wait_for_timeout
Additional wait time in milliseconds

parameter device_scale_factor
Device scale factor for retina displays (default: 1.0)

parameter store
Store screenshot and return URL instead of bytes (default: false)

parameter block_ads
Block ads and trackers (default: false)

returns
Screenshot bytes or stored URL info

Usage

Sourceval get_usage : t -> (usage, error) result Lwt.t

Get current usage statistics

Helpers

Sourceval format_to_string : format -> string

Convert format to string

Sourceval wait_until_to_string : wait_until -> string

Convert wait_until to string

Sourceval error_to_string : error -> string

Convert error to human-readable string

package pxshot