Local API V2 – Fingerprint Interface

Get a Profile Fingerprint

Endpoint

GET /openapi/v2/profiles/{profileId}/fingerprint

Returns the Fingerprint configuration for a single Profile.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Replace a Profile Fingerprint

Endpoint

PUT /openapi/v2/profiles/{profileId}/fingerprint

Replaces the Fingerprint configuration for a single Profile.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Request Parameters

Name	Type	Required	Description
fingerprint	object	No	Fingerprint configuration. See Fingerprint Parameters.

Refresh a Profile Fingerprint

Endpoint

POST /openapi/v2/profiles/{profileId}/fingerprint/refresh

Refreshes the Fingerprint for a single Profile.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Request Parameters

Name	Type	Required	Description
fingerprint	object	No	Fingerprint configuration. See Fingerprint Parameters.

Generate a Fingerprint

Endpoint

POST /openapi/v2/fingerprints/generate

Generates a temporary Fingerprint.

Request Parameters

Name	Type	Required	Description
fingerprint	object	No	Fingerprint configuration. See Fingerprint Parameters.

Request Example

{
  "fingerprint": {
    "os": "windows",
    "kernel_version": "142",
    "language": {
      "mode": "ip"
    },
    "timezone": {
      "mode": "ip"
    },
    "webrtc": {
      "mode": "replace",
      "ip_source": "proxy",
      "keep_random_internal_ip": false
    }
  }
}

Refresh Profile Fingerprints in Bulk

Endpoint

PATCH /openapi/v2/profiles/fingerprints

Refreshes Fingerprints for multiple Profiles.

Request Parameters

Name	Type	Required	Description
profile_ids	string[]	No	List of Profile IDs.
fingerprint	object	No	Fingerprint configuration. See Fingerprint Parameters.

Get Fingerprint Options

Endpoint

GET /openapi/v2/fingerprints/options

Returns the Fingerprint enum options supported by the system, such as operating system types, kernel versions, Proxy types, and WebRTC modes.

Parameter Reference

Fingerprint Parameters

fingerprint configures a Profile Fingerprint. All fields are optional. If omitted, the system generates values according to its rules or retains the existing configuration.

Name	Type	Description
os	string	Operating system type. Allowed values: random, windows, macos, linux, android, ios.
kernel_version	string	Browser kernel version. Allowed values: 120, 134, 142, 143, 147.
ua	string	User Agent. If left empty, the system generates one randomly. If provided, it must match the operating system type and kernel version.
language	object	Browser language configuration.
ui_language	object	UI language configuration.
timezone	object	Time zone configuration.
geolocation	object	Geolocation configuration.
fonts	object	Font configuration.
webrtc	object	WebRTC configuration.
screen	object	Screen configuration.
webgl	object	WebGL configuration.
webgpu	object	General Fingerprint module configuration.
audio_context	object	General Fingerprint module configuration.
client_rects	object	General Fingerprint module configuration.
speech_voices	object	General Fingerprint module configuration.
media_devices	object	General Fingerprint module configuration.
hardware	object	Hardware configuration.
privacy	object	Privacy configuration.
launch	object	Launch parameter configuration.

language

Name	Type	Description
mode	string	Browser language mode. Allowed values: ip, custom.
languages	string[]	Browser language list. Required when mode=custom, for example ["en-US", "en"].

ui_language

Name	Type	Description
mode	string	UI language mode. Allowed values: follow_browser_language, current_device_language, custom.
value	string	Custom UI language. Required when mode=custom, for example en-US.

timezone

Name	Type	Description
mode	string	Time zone source. Allowed values: ip, custom, real.
value	string	Time zone value. Effective only when mode=custom.

geolocation

Name	Type	Description
permission	string	Geolocation permission. Allowed values: ask, allow, block.
source	string	Coordinate source. Allowed values: ip, custom.
coordinates.longitude	number	Longitude.
coordinates.latitude	number	Latitude.
coordinates.accuracy	number	Accuracy.

fonts

Name	Type	Description
mode	string	Font mode. Allowed values: real, random, custom.
values	string[]	Font list. Effective only when mode=custom.

webrtc

Name	Type	Description
mode	string	WebRTC mode. Allowed values: real, replace, forward, disabled.
ip_source	string	Source used in replace mode. Effective only when mode=replace. Allowed values: manual, proxy, random.
ip	string	Manually specified internal IP address. Effective only when ip_source=manual.
keep_random_internal_ip	boolean	Whether the random internal IP address remains unchanged. Effective only when ip_source=random.

screen

Name	Type	Description
resolution_mode	string	Resolution mode. Allowed values: recommended, random, custom, real.
resolution.width	integer	Resolution width.
resolution.height	integer	Resolution height.
window_size_mode	string	Window size mode. Allowed values: recommended, custom.
window_size.width	integer	Window width.
window_size.height	integer	Window height.

webgl

Name	Type	Description
image_mode	string	WebGL image mode. Allowed values: real, mask.
metadata_mode	string	WebGL metadata mode. Allowed values: real, random, custom.
manufacturer	string	WebGL manufacturer. Effective only when metadata_mode=custom.
renderer	string	WebGL renderer. Effective only when metadata_mode=custom.

webgpu

Name	Type	Description
mode	string	WebGPU mode. Allowed values: real, mask, disabled.

Noise-based Fingerprint Modules

audio_context, client_rects, speech_voices, and media_devices use the same structure:

Name	Type	Description
mode	string	Module mode. Allowed values: real, mask.

hardware

Name	Type	Description
cpu_cores.mode	string	CPU core count mode. Allowed values: random, custom, real.
cpu_cores.value	string	Custom CPU core count. Effective only when mode=custom.
memory_gb.mode	string	Memory size mode. Allowed values: random, custom, real.
memory_gb.value	string	Custom memory size in GB. Effective only when mode=custom.
device_name_mode	string	Device name mode. Allowed values: real, random, custom.
device_name	string	Device name. Effective only when device_name_mode=custom.
mac_address_mode	string	MAC address mode. Allowed values: real, random, custom.
mac_address	string	MAC address. Effective only when mac_address_mode=custom.

privacy

Name	Type	Description
do_not_track_mode	string	Do Not Track. Allowed values: default, enabled, disabled.
battery_mode	string	Battery mode. Allowed values: real, mask, disabled.
port_scan_protection_enabled	boolean	Whether port scan protection is enabled.
hardware_acceleration_mode	string	Hardware acceleration. Allowed values: default, enabled, disabled.

launch

Name	Type	Description
start_params	string	Browser launch parameters, separated by commas.

Fingerprint Options Response Fields

data returned by GET /openapi/v2/fingerprints/options may contain:

Name	Type	Description
os_options	string[]	Operating system type options.
kernel_version_options	string[]	Browser kernel version options.
proxy_type_options	string[]	Proxy type options.
ip_check_provider_options	string[]	IP check provider options.
restore_session_options	string[]	Session restore options.
fingerprint_language_mode_options	string[]	Browser language mode options.
fingerprint_ui_language_mode_options	string[]	UI language mode options.
timezone_mode_options	string[]	Time zone mode options.
geolocation_permission_options	string[]	Geolocation permission options.
geolocation_source_options	string[]	Geolocation source options.
font_mode_options	string[]	Font mode options.
webgl_image_mode_options	string[]	WebGL image mode options.
webgl_metadata_mode_options	string[]	WebGL metadata mode options.
webgpu_mode_options	string[]	WebGPU mode options.
audio_context_mode_options	string[]	AudioContext mode options.
client_rects_mode_options	string[]	ClientRects mode options.
speech_voices_mode_options	string[]	SpeechVoices mode options.
media_devices_mode_options	string[]	MediaDevices mode options.
cpu_cores_mode_options	string[]	CPU core count mode options.
memory_mode_options	string[]	Memory size mode options.
device_name_mode_options	string[]	Device name mode options.
mac_address_mode_options	string[]	MAC address mode options.
battery_mode_options	string[]	Battery mode options.
do_not_track_mode_options	string[]	Do Not Track mode options.
hardware_acceleration_mode_options	string[]	Hardware acceleration mode options.
web_rtc_mode_options	string[]	WebRTC mode options.
web_rtc_ip_source_options	string[]	WebRTC IP source options.
resolution_mode_options	string[]	Screen resolution mode options.
window_size_mode_options	string[]	Window size mode options.