nodriver

https://ultrafunkamsterdam.github.io/nodriver/index.html
Admin
nodriver is an undetected, fully asynchronous Python library for web scraping and browser automation...
Tokens:34,893
Snippets:93
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /get_screen_infos

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Retrieves information about the currently connected screens and their properties.

```APIDOC
## GET /get_screen_infos

### Description
Returns a list of screen configurations including dimensions, pixel ratios, and orientation.

### Method
GET

### Endpoint
/get_screen_infos

### Response
#### Success Response (200)
- **screens** (array) - List of ScreenInfo objects containing width, height, and device_pixel_ratio.

#### Response Example
{
  "screens": [
    {
      "id_": "1",
      "width": 1920,
      "height": 1080,
      "device_pixel_ratio": 1.0
    }
  ]
}
```

--------------------------------

### PWA API

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Endpoints for managing Progressive Web App lifecycle, including installation, launching, and user settings.

```APIDOC
## PWA Commands

### Description
Manages PWA lifecycle events such as installation, uninstallation, and launching files within the app context.

### Methods
- `install()`: Triggers the PWA installation flow.
- `uninstall()`: Uninstalls the PWA.
- `launch()`: Launches the PWA.
- `launch_files_in_app()`: Opens specific files within the PWA context.
- `get_os_app_state()`: Retrieves the current application state from the OS.

### Parameters
#### Request Body
- **action** (string) - The action to perform on the PWA instance.
```

--------------------------------

### POST /Performance/enable

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Enables the performance tracking module to begin collecting metrics.

```APIDOC
## POST /Performance/enable

### Description
Enables the performance domain to start reporting metrics via events.

### Method
POST

### Endpoint
/Performance/enable

### Response
#### Success Response (200)
- **status** (string) - Confirmation of enablement.
```

--------------------------------

### GET /DOMDebugger/get_event_listeners

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Retrieves the event listeners currently attached to the DOM.

```APIDOC
## GET /DOMDebugger/get_event_listeners

### Description
Returns the list of event listeners for the specified object.

### Method
GET

### Endpoint
/DOMDebugger/get_event_listeners

### Parameters
#### Query Parameters
- **object_id** (string) - Required - The ID of the object to retrieve listeners for.

### Response
#### Success Response (200)
- **listeners** (array) - List of EventListener objects.

#### Response Example
{
  "listeners": [
    {
      "type_": "click",
      "use_capture": false,
      "passive": false
    }
  ]
}
```

--------------------------------

### POST /PerformanceTimeline/enable

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Enables the performance timeline to track events like Largest Contentful Paint and Layout Shifts.

```APIDOC
## POST /PerformanceTimeline/enable

### Description
Starts tracking timeline events including LCP and layout shifts.

### Method
POST

### Endpoint
/PerformanceTimeline/enable

### Response
#### Success Response (200)
- **status** (string) - Confirmation of enablement.
```

--------------------------------

### BluetoothEmulation Module Commands

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Provides commands for simulating various Bluetooth Low Energy (BLE) operations, including adding/removing services, characteristics, and descriptors, and simulating GATT events.

```APIDOC
## Commands: BluetoothEmulation Module

### Description

This section details the commands available for simulating Bluetooth Low Energy (BLE) peripheral behavior and interactions.

### Commands

- **`add_characteristic(service_id: string, characteristic_properties: CharacteristicProperties, value: string)`**
  Adds a characteristic to a service.
  - **`service_id`** (string) - The ID of the service to add the characteristic to.
  - **`characteristic_properties`** (CharacteristicProperties) - The properties of the characteristic.
  - **`value`** (string) - The initial value of the characteristic.

- **`add_descriptor(characteristic_id: string, descriptor_properties: object, value: string)`**
  Adds a descriptor to a characteristic.
  - **`characteristic_id`** (string) - The ID of the characteristic to add the descriptor to.
  - **`descriptor_properties`** (object) - Properties of the descriptor.
  - **`value`** (string) - The initial value of the descriptor.

- **`add_service(uuid: string)`**
  Adds a new GATT service.
  - **`uuid`** (string) - The UUID of the service to add.

- **`disable()`**
  Disables the Bluetooth emulation.

- **`enable()`**
  Enables the Bluetooth emulation.

- **`remove_characteristic(characteristic_id: string)`**
  Removes a characteristic.
  - **`characteristic_id`** (string) - The ID of the characteristic to remove.

- **`remove_descriptor(descriptor_id: string)`**
  Removes a descriptor.
  - **`descriptor_id`** (string) - The ID of the descriptor to remove.

- **`remove_service(service_id: string)`**
  Removes a service.
  - **`service_id`** (string) - The ID of the service to remove.

- **`set_simulated_central_state(state: CentralState)`**
  Sets the simulated state of the central device.
  - **`state`** (CentralState) - The desired state of the central device.

- **`simulate_advertisement(scan_record: ScanRecord)`**
  Simulates a BLE advertisement.
  - **`scan_record`** (ScanRecord) - The scan record data to simulate.

- **`simulate_characteristic_operation_response(characteristic_id: string, response_data: string)`**
  Simulates a response to a characteristic operation.
  - **`characteristic_id`** (string) - The ID of the characteristic.
  - **`response_data`** (string) - The data to send as a response.

- **`simulate_descriptor_operation_response(descriptor_id: string, response_data: string)`**
  Simulates a response to a descriptor operation.
  - **`descriptor_id`** (string) - The ID of the descriptor.
  - **`response_data`** (string) - The data to send as a response.

- **`simulate_gatt_disconnection(address: string)`**
  Simulates a GATT disconnection event.
  - **`address`** (string) - The Bluetooth address of the device to disconnect from.

- **`simulate_gatt_operation_response(address: string, operation_type: GATTOperationType, response_data: string)`**
  Simulates a response to a GATT operation.
  - **`address`** (string) - The Bluetooth address of the device.
  - **`operation_type`** (GATTOperationType) - The type of GATT operation.
  - **`response_data`** (string) - The data to send as a response.

- **`simulate_preconnected_peripheral(address: string, scan_record: ScanRecord)`**
  Simulates a peripheral that is already connected.
  - **`address`** (string) - The Bluetooth address of the peripheral.
  - **`scan_record`** (ScanRecord) - The scan record data of the peripheral.
```

--------------------------------

### GET /page/back_forward_cache_status

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Retrieves diagnostic information regarding why a page was not restored from the BackForwardCache.

```APIDOC
## GET /page/back_forward_cache_status

### Description
Returns the tree of explanations detailing why a page could not be restored from the BackForwardCache, including specific reasons like INJECTED_JAVASCRIPT or UNLOAD_HANDLER.

### Method
GET

### Endpoint
/page/back_forward_cache_status

### Response
#### Success Response (200)
- **explanations** (array) - List of BackForwardCacheNotRestoredExplanation objects.
- **tree** (object) - BackForwardCacheNotRestoredExplanationTree structure.

#### Response Example
{
  "tree": {
    "url": "https://example.com",
    "explanations": [
      {
        "type_": "CIRCUMSTANTIAL",
        "reason": "UNLOAD_HANDLER"
      }
    ],
    "children": []
  }
}
```

--------------------------------

### Address Module Commands and Events

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Details the commands available for interacting with the Address module and the events it emits.

```APIDOC
## Commands and Events: Address Module

### Description

This section outlines the commands that can be executed on the Address module and the events it generates.

### Commands

- **`disable()`**
  Disables the address form functionality.

- **`enable()`**
  Enables the address form functionality.

- **`set_addresses(addresses: array of Address)`**
  Sets the available addresses for the form.
  - **`addresses`** (array of `Address`) - An array of `Address` objects to set.

- **`trigger()`**
  Triggers an action within the address form, typically form submission or validation.

### Events

#### `AddressFormFilled`
An event triggered when the address form has been successfully filled.

- **`filled_fields`** (array of `FilledField`) - An array of fields that were filled.
- **`address_ui`** (AddressUI) - The UI representation of the filled address.
```

--------------------------------

### GET /memory/dom_counters

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Retrieves current DOM node counters for monitoring and leak detection.

```APIDOC
## GET /memory/dom_counters

### Description
Returns a list of DOM counters including name and current count.

### Method
GET

### Endpoint
/memory/get_dom_counters

### Response
#### Success Response (200)
- **counters** (array) - List of DOMCounter objects.

#### Response Example
{
  "counters": [
    { "name": "nodes", "count": 150 },
    { "name": "documents", "count": 1 }
  ]
}
```

--------------------------------

### BackgroundService Module Commands and Events

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Details the commands for controlling background service recording and observation, and the events related to recording state and event reception.

```APIDOC
## Commands and Events: BackgroundService Module

### Description

This section describes the commands for managing background service event recording and observation, along with the events emitted by the module.

### Commands

- **`clear_events()`**
  Clears all recorded background service events.

- **`set_recording(enabled: boolean)`**
  Enables or disables the recording of background service events.
  - **`enabled`** (boolean) - `true` to enable recording, `false` to disable.

- **`start_observing()`**
  Starts observing background service events.

- **`stop_observing()`**
  Stops observing background service events.

### Events

#### `RecordingStateChanged`
An event triggered when the recording state of the background service changes.

- **`is_recording`** (boolean) - `true` if recording is now enabled, `false` otherwise.
- **`service`** (ServiceName) - The background service whose recording state changed.

#### `BackgroundServiceEventReceived`
An event triggered when a new background service event is received.

- **`background_service_event`** (BackgroundServiceEvent) - The received background service event object.
```

--------------------------------

### Heap Profiler Commands

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Commands for monitoring and analyzing heap memory usage, taking snapshots, and tracking objects.

```APIDOC
## POST /take_heap_snapshot

### Description
Triggers a heap snapshot for memory analysis.

### Method
POST

### Endpoint
/take_heap_snapshot

### Response
#### Success Response (200)
- **snapshot_id** (string) - The identifier for the generated heap snapshot.
```

```APIDOC
## POST /start_sampling

### Description
Starts sampling heap allocations to track memory growth.

### Method
POST

### Endpoint
/start_sampling

### Response
#### Success Response (200)
- **status** (string) - Confirmation that sampling has started.
```

--------------------------------

### POST /FedCm/select_account

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Simulates user interaction by selecting a specific account in the FedCm dialog.

```APIDOC
## POST /FedCm/select_account

### Description
Selects an account from the currently displayed FedCm dialog.

### Method
POST

### Endpoint
/FedCm/select_account

### Request Body
- **dialog_id** (string) - Required - The ID of the active dialog.
- **account_index** (integer) - Required - The index of the account to select.

### Request Example
{
  "dialog_id": "dialog_123",
  "account_index": 0
}

### Response
#### Success Response (200)
- **status** (string) - Confirmation of the selection action.
```

--------------------------------

### Browser Events API

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

This section details the events emitted by the browser, such as download progress and when a download is about to begin.

```APIDOC
## Browser Events API

### Description
Defines the structure and data associated with events emitted by the browser, particularly related to downloads.

### Events

#### `DownloadWillBegin`
- **Description**: Fired when a download is about to begin.
- **Fields**:
  - **frame_id** (string) - The ID of the frame where the download originated.
  - **guid** (string) - The unique identifier for the download.
  - **url** (string) - The URL of the file being downloaded.
  - **suggested_filename** (string) - The suggested filename for the download.

#### `DownloadProgress`
- **Description**: Fired to report the progress of an ongoing download.
- **Fields**:
  - **guid** (string) - The unique identifier for the download.
  - **total_bytes** (integer) - The total size of the file in bytes.
  - **received_bytes** (integer) - The number of bytes received so far.
  - **state** (string) - The current state of the download (e.g., 'in_progress', 'completed', 'canceled').
  - **file_path** (string) - The local path where the file is being saved.

```

--------------------------------

### DeviceAccess API

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Commands and events for managing device access prompts and permissions.

```APIDOC
## POST /DeviceAccess/enable

### Description
Enables the DeviceAccess domain to start receiving device-related events.

### Method
POST

### Endpoint
/DeviceAccess/enable

### Response
#### Success Response (200)
- **status** (string) - Confirmation of domain enablement.

## POST /DeviceAccess/cancel_prompt

### Description
Cancels an active device request prompt.

### Method
POST

### Endpoint
/DeviceAccess/cancel_prompt

### Request Body
- **id_** (RequestId) - Required - The ID of the prompt to cancel.
```

--------------------------------

### Origin Trial Token With Status

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Combines an Origin Trial token with its validation status.

```APIDOC
## Origin Trial Token With Status

### Description
This object pairs a raw Origin Trial token string with its validation status and parsed details.

### Method
N/A (Object structure)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **OriginTrialTokenWithStatus.raw_token_text** (string) - The original, unparsed token string.
- **OriginTrialTokenWithStatus.status** (OriginTrialTokenStatus) - The validation status of the token.
- **OriginTrialTokenWithStatus.parsed_token** (OriginTrialToken) - The parsed details of the token, if valid.

### Response Example
{
  "raw_token_text": "some.base64.encoded.token",
  "status": "SUCCESS",
  "parsed_token": {
    "origin": "https://example.com",
    "match_sub_domains": true,
    "trial_name": "MyFeatureTrial",
    "expiry_time": 1678886400,
    "is_third_party": false,
    "usage_restriction": "NONE"
  }
}
```

--------------------------------

### POST /attribution-reporting/source

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Registers a new attribution reporting source with specific timing, expiry, and event report windows.

```APIDOC
## POST /attribution-reporting/source

### Description
Registers a source for attribution reporting, defining the lifecycle and reporting parameters.

### Method
POST

### Endpoint
/attribution-reporting/source

### Request Body
- **time** (string) - Required - Registration timestamp.
- **expiry** (integer) - Required - Expiry duration in seconds.
- **type_** (enum) - Required - NAVIGATION or EVENT.
- **source_origin** (string) - Required - The origin of the source.
- **reporting_origin** (string) - Required - The origin that will receive reports.

### Request Example
{
  "time": "2023-10-27T10:00:00Z",
  "expiry": 86400,
  "type_": "NAVIGATION",
  "source_origin": "https://publisher.com",
  "reporting_origin": "https://adtech.com"
}

### Response
#### Success Response (200)
- **registered** (boolean) - Confirmation of registration.

#### Response Example
{
  "registered": true
}
```

--------------------------------

### Cast Control API

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Endpoints for managing desktop and tab mirroring via casting sinks.

```APIDOC
## POST /cast/start_tab_mirroring

### Description
Initiates mirroring of the current browser tab to a specified sink.

### Method
POST

### Endpoint
/cast/start_tab_mirroring

### Parameters
#### Request Body
- **sink_id** (string) - Required - The ID of the target sink device.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if mirroring started successfully.
```

--------------------------------

### Input API

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Provides commands and event definitions for handling user input, including touch, mouse, and drag events.

```APIDOC
## Input API

### Description
This API allows for the dispatching and management of various input events, such as touch, mouse, and drag operations. It also provides functionality to emulate touch events from mouse events and manage input event interception.

### Commands

#### `cancel_dragging()`

- **Description**: Not specified.
- **Method**: Not specified.
- **Endpoint**: Not specified.

#### `dispatch_drag_event(data, drag_operations_mask, files)`

- **Description**: Dispatches a drag event.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **data** (DragData) - Required - Description of the drag data.
  - **drag_operations_mask** (integer) - Required - Bitmask for drag operations.
  - **files** (array of string) - Optional - List of files associated with the drag event.

#### `dispatch_key_event(type, modifiers, timestamp, text, windowsVirtualKeyCode, nativeVirtualKeyCode, macOsVirtualKeyCode)`

- **Description**: Dispatches a key event.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **type** (string) - Required - Type of key event (e.g., 'keyDown', 'keyUp').
  - **modifiers** (integer) - Optional - Bitmask for modifier keys.
  - **timestamp** (number) - Optional - Timestamp of the event.
  - **text** (string) - Optional - Text associated with the key event.
  - **windowsVirtualKeyCode** (integer) - Optional - Windows virtual key code.
  - **nativeVirtualKeyCode** (integer) - Optional - Native virtual key code.
  - **macOsVirtualKeyCode** (integer) - Optional - macOS virtual key code.

#### `dispatch_mouse_event(type, x, y, modifiers, timestamp, button, click_count, movement_x, movement_y)`

- **Description**: Dispatches a mouse event.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **type** (string) - Required - Type of mouse event (e.g., 'mousePressed', 'mouseReleased', 'mouseMoved').
  - **x** (number) - Required - X coordinate of the event.
  - **y** (number) - Required - Y coordinate of the event.
  - **modifiers** (integer) - Optional - Bitmask for modifier keys.
  - **timestamp** (number) - Optional - Timestamp of the event.
  - **button** (MouseButton) - Optional - Mouse button involved.
  - **click_count** (integer) - Optional - Number of clicks.
  - **movement_x** (integer) - Optional - Mouse movement in X direction.
  - **movement_y** (integer) - Optional - Mouse movement in Y direction.

#### `dispatch_touch_event(type, touch_points, timestamp, modifiers)`

- **Description**: Dispatches a touch event.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **type** (string) - Required - Type of touch event (e.g., 'mousePressed', 'mouseReleased', 'mouseMoved').
  - **touch_points** (array of TouchPoint) - Required - Array of touch points.
  - **timestamp** (number) - Optional - Timestamp of the event.
  - **modifiers** (integer) - Optional - Bitmask for modifier keys.

#### `emulate_touch_from_mouse_event(type, x, y, modifiers, timestamp, button, click_count, movement_x, movement_y)`

- **Description**: Emulates a touch event from a mouse event.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **type** (string) - Required - Type of mouse event.
  - **x** (number) - Required - X coordinate.
  - **y** (number) - Required - Y coordinate.
  - **modifiers** (integer) - Optional - Modifier keys bitmask.
  - **timestamp** (number) - Optional - Event timestamp.
  - **button** (MouseButton) - Optional - Mouse button.
  - **click_count** (integer) - Optional - Click count.
  - **movement_x** (integer) - Optional - Mouse movement X.
  - **movement_y** (integer) - Optional - Mouse movement Y.

#### `ime_set_composition(text, cursor_pos, selection_start, selection_end)`

- **Description**: Sets the Input Method Editor (IME) composition.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **text** (string) - Required - The composition text.
  - **cursor_pos** (integer) - Required - Cursor position within the composition.
  - **selection_start** (integer) - Required - Start of selection.
  - **selection_end** (integer) - Required - End of selection.

#### `insert_text(text)`

- **Description**: Inserts text into the current input field.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **text** (string) - Required - The text to insert.

#### `set_ignore_input_events(ignore)`

- **Description**: Sets whether to ignore input events.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **ignore** (boolean) - Required - True to ignore input events, false otherwise.

#### `set_intercept_drags(value)`

- **Description**: Sets whether to intercept drag events.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **value** (boolean) - Required - True to intercept drags, false otherwise.

#### `synthesize_pinch_gesture(x, y, scale, velocity)`

- **Description**: Synthesizes a pinch gesture.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **x** (number) - Required - X coordinate for the gesture center.
  - **y** (number) - Required - Y coordinate for the gesture center.
  - **scale** (number) - Required - Scale factor for the pinch.
  - **velocity** (number) - Required - Velocity of the pinch gesture.

#### `synthesize_scroll_gesture(x, y, offset_x, offset_y, speed)`

- **Description**: Synthesizes a scroll gesture.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **x** (number) - Required - X coordinate for the gesture start.
  - **y** (number) - Required - Y coordinate for the gesture start.
  - **offset_x** (number) - Required - Scroll offset in X direction.
  - **offset_y** (number) - Required - Scroll offset in Y direction.
  - **speed** (number) - Optional - Speed of the scroll gesture.

#### `synthesize_tap_gesture(x, y, duration, tap_count, tap_end_x, tap_end_y)`

- **Description**: Synthesizes a tap gesture.
- **Method**: Not specified.
- **Endpoint**: Not specified.
- **Parameters**:
  - **x** (number) - Required - X coordinate for the tap.
  - **y** (number) - Required - Y coordinate for the tap.
  - **duration** (number) - Optional - Duration of the tap.
  - **tap_count** (integer) - Optional - Number of taps.
  - **tap_end_x** (number) - Optional - End X coordinate of the tap.
  - **tap_end_y** (number) - Optional - End Y coordinate of the tap.

### Events

#### `DragIntercepted`

- **Description**: Fired when a drag operation is intercepted.
- **Parameters**:
  - **data** (DragData) - Required - The intercepted drag data.

### Types

#### `TouchPoint`

- **Description**: Represents a single touch point.
- **Fields**:
  - **x** (number) - X coordinate.
  - **y** (number) - Y coordinate.
  - **radius_x** (number) - X radius of the touch point.
  - **radius_y** (number) - Y radius of the touch point.
  - **rotation_angle** (number) - Rotation angle of the touch point.
  - **force** (number) - Force of the touch.
  - **tangential_pressure** (number) - Tangential pressure of the touch.
  - **tilt_x** (number) - Tilt in the X direction.
  - **tilt_y** (number) - Tilt in the Y direction.
  - **twist** (number) - Twist value.
  - **id_** (number) - Unique identifier for the touch point.

#### `GestureSourceType`

- **Description**: Defines the source type for gestures.
- **Values**:
  - `DEFAULT`
  - `TOUCH`
  - `MOUSE`

#### `MouseButton`

- **Description**: Defines the mouse buttons.
- **Values**:
  - `NONE`
  - `LEFT`
  - `MIDDLE`
  - `RIGHT`
  - `BACK`
  - `FORWARD`

#### `TimeSinceEpoch`

- **Description**: Represents time since epoch (likely a number).

#### `DragDataItem`

- **Description**: Represents an item within drag data.
- **Fields**:
  - **mime_type** (string) - MIME type of the data.
  - **data** (string) - The actual data.
  - **title** (string) - Title of the data item.
  - **base_url** (string) - Base URL for the data item.

#### `DragData`

- **Description**: Represents the data associated with a drag operation.
- **Fields**:
  - **items** (array of DragDataItem) - List of drag data items.
  - **drag_operations_mask** (integer) - Bitmask for drag operations.
  - **files** (array of string) - List of files associated with the drag data.
```

--------------------------------

### Overlay Configuration Types

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Details on various overlay configuration types used for visualizing CSS Grid and Flexbox layouts.

```APIDOC
## Overlay Configuration Types

### SourceOrderConfig

#### Description
Configuration for source order highlighting in overlays.

#### Properties
- `parent_outline_color` (string) - Color for the parent outline.
- `child_outline_color` (string) - Color for the child outline.

### GridHighlightConfig

#### Description
Configuration for highlighting CSS Grid layouts.

#### Properties
- `show_grid_extension_lines` (boolean) - Whether to show grid extension lines.
- `show_positive_line_numbers` (boolean) - Whether to show positive line numbers.
- `show_negative_line_numbers` (boolean) - Whether to show negative line numbers.
- `show_area_names` (boolean) - Whether to show grid area names.
- `show_line_names` (boolean) - Whether to show grid line names.
- `show_track_sizes` (boolean) - Whether to show track sizes.
- `grid_border_color` (string) - Color of the grid border.
- `cell_border_color` (string) - Color of the cell border.
- `row_line_color` (string) - Color of the row lines.
- `column_line_color` (string) - Color of the column lines.
- `grid_border_dash` (array) - Dash pattern for the grid border.
- `cell_border_dash` (array) - Dash pattern for the cell border.
- `row_line_dash` (array) - Dash pattern for the row lines.
- `column_line_dash` (array) - Dash pattern for the column lines.
- `row_gap_color` (string) - Color of the row gap.
- `row_hatch_color` (string) - Hatch color for the row gap.
- `column_gap_color` (string) - Color of the column gap.
- `column_hatch_color` (string) - Hatch color for the column gap.
- `area_border_color` (string) - Color of the area border.
- `grid_background_color` (string) - Background color of the grid.

### FlexContainerHighlightConfig

#### Description
Configuration for highlighting CSS Flexbox containers.

#### Properties
- `container_border` (string) - Style of the container border.
- `line_separator` (string) - Style of the line separator.
- `item_separator` (string) - Style of the item separator.
- `main_distributed_space` (string) - Visualization of main axis distributed space.
- `cross_distributed_space` (string) - Visualization of cross axis distributed space.
- `row_gap_space` (string) - Visualization of row gap space.
- `column_gap_space` (string) - Visualization of column gap space.
- `cross_alignment` (string) - Visualization of cross axis alignment.

### FlexItemHighlightConfig

#### Description
Configuration for highlighting individual CSS Flexbox items.

#### Properties
- `base_size_box` (string) - Visualization of the item's base size box.
- `base_size_border` (string) - Visualization of the item's base size border.
- `flexibility_arrow` (string) - Visualization of the item's flexibility.

```

--------------------------------

### Browser Commands API

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

This section outlines the various commands available for controlling browser behavior, such as managing tabs, downloads, and permissions.

```APIDOC
## Browser Commands API

### Description
Provides a set of commands to interact with and control browser functionalities like opening/closing tabs, managing downloads, and setting permissions.

### Methods

#### `add_privacy_sandbox_coordinator_key_config()`
- **Description**: Adds a key configuration for the Privacy Sandbox coordinator.
- **Method**: POST
- **Endpoint**: `/browser/add_privacy_sandbox_coordinator_key_config`

#### `add_privacy_sandbox_enrollment_override()`
- **Description**: Adds an enrollment override for the Privacy Sandbox.
- **Method**: POST
- **Endpoint**: `/browser/add_privacy_sandbox_enrollment_override`

#### `cancel_download()`
- **Description**: Cancels an ongoing download.
- **Method**: POST
- **Endpoint**: `/browser/cancel_download`
- **Parameters**:
  - **guid** (string) - Required - The unique identifier for the download.

#### `close()`
- **Description**: Closes the browser or a specific tab.
- **Method**: POST
- **Endpoint**: `/browser/close`
- **Parameters**:
  - **window_id** (string) - Optional - The ID of the window to close.

#### `crash()`
- **Description**: Forces a crash of the browser process.
- **Method**: POST
- **Endpoint**: `/browser/crash`

#### `crash_gpu_process()`
- **Description**: Forces a crash of the GPU process.
- **Method**: POST
- **Endpoint**: `/browser/crash_gpu_process`

#### `execute_browser_command()`
- **Description**: Executes a specific browser command.
- **Method**: POST
- **Endpoint**: `/browser/execute_browser_command`
- **Parameters**:
  - **command_id** (BrowserCommandId) - Required - The ID of the command to execute.

#### `get_browser_command_line()`
- **Description**: Retrieves the browser's command line arguments.
- **Method**: GET
- **Endpoint**: `/browser/get_browser_command_line`

#### `get_histogram()`
- **Description**: Retrieves a specific histogram by name.
- **Method**: GET
- **Endpoint**: `/browser/get_histogram`
- **Parameters**:
  - **name** (string) - Required - The name of the histogram.

#### `get_histograms()`
- **Description**: Retrieves all available histograms.
- **Method**: GET
- **Endpoint**: `/browser/get_histograms`

#### `get_version()`
- **Description**: Retrieves the browser version information.
- **Method**: GET
- **Endpoint**: `/browser/get_version`

#### `get_window_bounds()`
- **Description**: Retrieves the bounds (position and size) of a browser window.
- **Method**: GET
- **Endpoint**: `/browser/get_window_bounds`
- **Parameters**:
  - **window_id** (WindowID) - Required - The ID of the window.

#### `get_window_for_target()`
- **Description**: Gets the window associated with a specific target.
- **Method**: GET
- **Endpoint**: `/browser/get_window_for_target`
- **Parameters**:
  - **target_id** (string) - Required - The ID of the target.

#### `grant_permissions()`
- **Description**: Grants specified permissions to the browser context.
- **Method**: POST
- **Endpoint**: `/browser/grant_permissions`
- **Parameters**:
  - **permissions** (Array<PermissionDescriptor>) - Required - A list of permissions to grant.
  - **origin** (string) - Required - The origin for which to grant permissions.

#### `reset_permissions()`
- **Description**: Resets all granted permissions.
- **Method**: POST
- **Endpoint**: `/browser/reset_permissions`

#### `set_contents_size()`
- **Description**: Sets the content size of a browser window.
- **Method**: POST
- **Endpoint**: `/browser/set_contents_size`
- **Parameters**:
  - **window_id** (WindowID) - Required - The ID of the window.
  - **width** (integer) - Required - The new width.
  - **height** (integer) - Required - The new height.

#### `set_dock_tile()`
- **Description**: Sets the dock tile for the application.
- **Method**: POST
- **Endpoint**: `/browser/set_dock_tile`
- **Parameters**:
  - **tile_name** (string) - Required - The name of the dock tile.

#### `set_download_behavior()`
- **Description**: Sets the behavior for downloads.
- **Method**: POST
- **Endpoint**: `/browser/set_download_behavior`
- **Parameters**:
  - **behavior** (string) - Required - The download behavior (e.g., 'allow', 'deny').
  - **download_path** (string) - Optional - The path for downloads.

#### `set_permission()`
- **Description**: Sets a specific permission for a given origin.
- **Method**: POST
- **Endpoint**: `/browser/set_permission`
- **Parameters**:
  - **permission** (PermissionDescriptor) - Required - The permission to set.
  - **setting** (PermissionSetting) - Required - The permission setting (GRANTED, DENIED, PROMPT).
  - **origin** (string) - Required - The origin for which to set the permission.

#### `set_window_bounds()`
- **Description**: Sets the bounds (position and size) of a browser window.
- **Method**: POST
- **Endpoint**: `/browser/set_window_bounds`
- **Parameters**:
  - **window_id** (WindowID) - Required - The ID of the window.
  - **bounds** (Bounds) - Required - The new bounds for the window.

```

--------------------------------

### Network Commands

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

This section outlines the available commands for interacting with the browser's network stack, such as clearing cache, managing cookies, and intercepting requests.

```APIDOC
## Network Commands API

### Description
Provides methods to control and query network-related features of the browser.

### Commands

*   `can_clear_browser_cache()`: Checks if the browser cache can be cleared.
*   `can_clear_browser_cookies()`: Checks if browser cookies can be cleared.
*   `can_emulate_network_conditions()`: Checks if network conditions can be emulated.
*   `clear_accepted_encodings_override()`: Clears the accepted encodings override.
*   `clear_browser_cache()`: Clears the browser cache.
*   `clear_browser_cookies()`: Clears browser cookies.
*   `continue_intercepted_request(interception_id, error_reason, raw_response, url, status, headers, base64_encoded_response, stage_type)`: Continues an intercepted request.
*   `delete_cookies(name, url, domain, path)`: Deletes specified cookies.
*   `disable()`: Disables the network domain.
*   `emulate_network_conditions(offline, latency, download_throughput, upload_throughput)`: Emulates network conditions.
*   `enable()`: Enables the network domain.
*   `enable_reporting_api()`: Enables the Reporting API.
*   `get_all_cookies()`: Retrieves all cookies.
*   `get_certificate()`: Retrieves the browser's certificate.
*   `get_cookies(urls, domain, path)`: Retrieves cookies for specified URLs.
*   `get_ip_protection_proxy_status()`: Gets the IP protection proxy status.
*   `get_request_post_data(request_id)`: Gets the POST data of a request.
*   `get_response_body(request_id)`: Gets the response body of a request.
*   `get_response_body_for_interception(interception_id)`: Gets the response body for interception.
*   `get_security_isolation_status()`: Gets the security isolation status.
*   `load_network_resource(url, options)`: Loads a network resource.
*   `replay_xhr(request_id)`: Replays an XHR request.
*   `search_in_response_body(request_id, search_string, case_sensitive, is_regex)`: Searches within a response body.
*   `set_accepted_encodings(encodings)`: Sets the accepted encodings.
*   `set_attach_debug_stack(enabled)`: Sets whether to attach a debug stack.
*   `set_blocked_ur_ls(urls)`: Sets blocked URLs.
*   `set_bypass_service_worker(bypass)`: Sets whether to bypass the service worker.
*   `set_cache_disabled(cache_disabled)`: Sets whether cache is disabled.
*   `set_cookie(cookie)`: Sets a cookie.
*   `set_cookie_controls(cookie_controls)`: Sets cookie controls.
*   `set_cookies(cookies)`: Sets multiple cookies.
*   `set_extra_http_headers(headers)`: Sets extra HTTP headers.
*   `set_ip_protection_proxy_bypass_enabled(enabled)`: Enables or disables IP protection proxy bypass.
*   `set_request_interception(enabled)`: Enables or disables request interception.
*   `set_user_agent_override(user_agent, accept_language, platform)`: Sets the user agent override.
*   `stream_resource_content(request_id)`: Streams the content of a resource.
*   `take_response_body_for_interception_as_stream(interception_id)`: Takes the response body for interception as a stream.

### Data Structures

*   `ContentSecurityPolicySource`: Enum for CSP sources (`HTTP`, `META`).
*   `ContentSecurityPolicyStatus`: Represents CSP status (`effective_directives`, `is_enforced`, `source`).
*   `SecurityIsolationStatus`: Represents security isolation status (`coop`, `coep`, `csp`).
*   `ReportStatus`: Enum for report statuses (`QUEUED`, `PENDING`, `MARKED_FOR_REMOVAL`, `SUCCESS`).
*   `ReportId`: Represents a report ID.
*   `ReportingApiReport`: Represents a Reporting API report (`id_`, `initiator_url`, `destination`, `type_`, `timestamp`, `depth`, `completed_attempts`, `body`, `status`).
*   `ReportingApiEndpoint`: Represents a Reporting API endpoint (`url`, `group_name`).
*   `LoadNetworkResourcePageResult`: Result of loading a network resource (`success`, `net_error`, `net_error_name`, `http_status_code`, `stream`, `headers`).
*   `LoadNetworkResourceOptions`: Options for loading a network resource (`disable_cache`, `include_credentials`).
```

--------------------------------

### CSS Style and Property Models

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Definitions for CSS style objects and individual property structures.

```APIDOC
## CSSStyle Object

### Description
Represents a CSS style block including properties and shorthand entries.

### Fields
- **css_properties** (array) - List of CSSProperty objects
- **shorthand_entries** (array) - List of shorthand property entries
- **style_sheet_id** (string) - ID of the associated stylesheet
- **css_text** (string) - Full text of the CSS rule

## CSSProperty Object

### Description
Represents an individual CSS property declaration.

### Fields
- **name** (string) - Property name
- **value** (string) - Property value
- **important** (boolean) - Whether the property is marked !important
- **disabled** (boolean) - Whether the property is currently disabled
```

--------------------------------

### Font Configuration Models

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Definitions for font-face and platform font usage data structures.

```APIDOC
## FontFace Object

### Description
Represents a @font-face rule definition.

### Fields
- **font_family** (string) - Font family name
- **font_style** (string) - Font style (e.g., italic)
- **font_weight** (string) - Font weight
- **src** (string) - Font source URL
- **font_variation_axes** (array) - List of FontVariationAxis objects

## PlatformFontUsage

### Description
Details about fonts used by the underlying platform.

### Fields
- **family_name** (string) - Name of the font family
- **is_custom_font** (boolean) - Whether the font is a custom web font
```

--------------------------------

### POST /shared-storage/access

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Configures parameters for accessing shared storage, including script sources, operation definitions, and private aggregation settings.

```APIDOC
## POST /shared-storage/access

### Description
Configures the parameters required to perform operations within the Shared Storage worklet environment.

### Method
POST

### Endpoint
/shared-storage/access

### Request Body
- **script_source_url** (string) - Required - The URL of the worklet script.
- **operation_name** (string) - Required - The name of the operation to execute.
- **private_aggregation_config** (object) - Optional - Configuration for private aggregation.
- **key** (string) - Optional - Storage key.
- **value** (string) - Optional - Value to store.

### Request Example
{
  "script_source_url": "https://example.com/worklet.js",
  "operation_name": "run-operation",
  "key": "my-key",
  "value": "my-value"
}

### Response
#### Success Response (200)
- **status** (string) - Operation success status.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### POST /DOMStorage/get_dom_storage_items

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Retrieves all items from the specified DOM storage.

```APIDOC
## POST /DOMStorage/get_dom_storage_items

### Description
Fetches all key-value pairs stored in the specified DOM storage area.

### Method
POST

### Endpoint
/DOMStorage/get_dom_storage_items

### Parameters
#### Request Body
- **storageId** (StorageId) - Required - The identifier for the storage.

### Response
#### Success Response (200)
- **items** (array) - List of storage items.

#### Response Example
{
  "items": [["key1", "value1"], ["key2", "value2"]]
}
```

--------------------------------

### IndexedDB Commands

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Commands for interacting with browser IndexedDB databases and object stores.

```APIDOC
## POST /clear_object_store

### Description
Clears all data from a specific object store in IndexedDB.

### Method
POST

### Endpoint
/clear_object_store

### Request Body
- **database_name** (string) - Required - Name of the database.
- **object_store_name** (string) - Required - Name of the object store to clear.

### Response
#### Success Response (200)
- **status** (string) - Confirmation that the object store was cleared.
```

--------------------------------

### Origin Trial Token

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Details of a parsed Origin Trial token.

```APIDOC
## Origin Trial Token

### Description
This object contains the parsed details of an Origin Trial token.

### Method
N/A (Object structure)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **OriginTrialToken.origin** (string) - The origin for which the token is valid.
- **OriginTrialToken.match_sub_domains** (boolean) - Whether the token also matches subdomains.
- **OriginTrialToken.trial_name** (string) - The name of the trial.
- **OriginTrialToken.expiry_time** (number) - The expiry time of the token as a Unix timestamp.
- **OriginTrialToken.is_third_party** (boolean) - Whether this is a third-party token.
- **OriginTrialToken.usage_restriction** (OriginTrialUsageRestriction) - The usage restriction applied to the token.

### Response Example
{
  "origin": "https://example.com",
  "match_sub_domains": true,
  "trial_name": "MyFeatureTrial",
  "expiry_time": 1678886400,
  "is_third_party": false,
  "usage_restriction": "NONE"
}
```

--------------------------------

### ResourceTiming Properties

Source: https://ultrafunkamsterdam.github.io/nodriver/index.html

Details the timing properties available for resources.

```APIDOC
## ResourceTiming Properties

### Description
Provides timing information related to resource loading.

### Properties
- **push_start** (number) - The start time of the push.
- **push_end** (number) - The end time of the push.
- **receive_headers_start** (number) - The start time of receiving headers.
- **receive_headers_end** (number) - The end time of receiving headers.
- **worker_router_evaluation_start** (number) - The start time of worker router evaluation.
- **worker_cache_lookup_start** (number) - The start time of worker cache lookup.
```
Tokens:
Raw