ixBrowser Local API

https://ixbrowser.com/doc/v2/local-api/en
Admin
ixBrowser Local API enables programmatic management of browser profiles, automation control, proxy...
Tokens:5,300
Snippets:15
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Node.js Script Example for ixBrowser Local API

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

This example demonstrates how to interact with the ixBrowser Local API using Node.js. Ensure you have the 'axios' library installed (`npm install axios`). The API base URL and port can be customized.

```javascript
const axios = require('axios');

// Default API address: http://127.0.0.1:53200
const API_URL = 'http://127.0.0.1:53200';

// Function to send POST requests to the API
async function sendRequest(method, params = {}) {
    try {
        const response = await axios.post(`${API_URL}/${method}`, params, {
            headers: {
                'Content-Type': 'application/json'
            }
        });
        return response.data;
    } catch (error) {
        console.error(`Error sending request to ${method}:`, error.response ? error.response.data : error.message);
        throw error;
    }
}

// Example: Get Profile List
async function getProfileList() {
    console.log('Getting profile list...');
    const data = await sendRequest('getProfileList');
    console.log('Profile List:', JSON.stringify(data, null, 2));
    return data;
}

// Example: Create Profile
async function createProfile(profileName) {
    console.log(`Creating profile: ${profileName}...`);
    const data = await sendRequest('createProfile', {
        name: profileName
    });
    console.log('Create Profile Response:', JSON.stringify(data, null, 2));
    return data;
}

// Example: Open Profile
async function openProfile(profileId) {
    console.log(`Opening profile with ID: ${profileId}...`);
    const data = await sendRequest('openProfile', {
        ెంprofileId: profileId
    });
    console.log('Open Profile Response:', JSON.stringify(data, null, 2));
    return data;
}

// Example: Close Profile
async function closeProfile(profileId) {
    console.log(`Closing profile with ID: ${profileId}...`);
    const data = await sendRequest('closeProfile', {
        ెంprofileId: profileId
    });
    console.log('Close Profile Response:', JSON.stringify(data, null, 2));
    return data;
}

// Main execution function
async function main() {
    try {
        // await getProfileList();
        // await createProfile('My New Profile');
        // Replace 'YOUR_PROFILE_ID' with an actual profile ID
        // await openProfile('YOUR_PROFILE_ID');
        // await closeProfile('YOUR_PROFILE_ID');
    } catch (error) {
        console.error('An error occurred during main execution:', error);
    }
}

main();

```

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

### Script Examples

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Examples demonstrating how to use the ixBrowser Local API with Node.js and Python.

```APIDOC
## Script Example

### Node.js Script Example
Provides sample Node.js code for interacting with the API.

### Python Script Example
Provides sample Python code for interacting with the API.
```

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

### Python Script Example for ixBrowser Local API

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

This example demonstrates how to interact with the ixBrowser Local API using Python. It uses the `requests` library. The API base URL and port can be customized.

```python
import requests
import json

# Default API address: http://127.0.0.1:53200
API_URL = 'http://127.0.0.1:53200'

def send_request(method, params={}):
    """Sends a POST request to the ixBrowser Local API."""
    url = f"{API_URL}/{method}"
    headers = {'Content-Type': 'application/json'}
    try:
        response = requests.post(url, headers=headers, data=json.dumps(params))
        response.raise_for_status()  # Raise an exception for bad status codes
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error sending request to {method}: {e}")
        return None

# Example: Get Profile List
def get_profile_list():
    print('Getting profile list...')
    data = send_request('getProfileList')
    if data:
        print(f"Profile List: {json.dumps(data, indent=2)}")
    return data

# Example: Create Profile
def create_profile(profile_name):
    print(f'Creating profile: {profile_name}...')
    data = send_request('createProfile', {'name': profile_name})
    if data:
        print(f"Create Profile Response: {json.dumps(data, indent=2)}")
    return data

# Example: Open Profile
def open_profile(profile_id):
    print(f'Opening profile with ID: {profile_id}...')
    data = send_request('openProfile', {'ెంprofileId': profile_id})
    if data:
        print(f"Open Profile Response: {json.dumps(data, indent=2)}")
    return data

# Example: Close Profile
def close_profile(profile_id):
    print(f'Closing profile with ID: {profile_id}...')
    data = send_request('closeProfile', {'ెంprofileId': profile_id})
    if data:
        print(f"Close Profile Response: {json.dumps(data, indent=2)}")
    return data

if __name__ == '__main__':
    # Uncomment the lines below to run the examples
    # get_profile_list()
    # create_profile('My Python Profile')
    # Replace 'YOUR_PROFILE_ID' with an actual profile ID
    # open_profile('YOUR_PROFILE_ID')
    # close_profile('YOUR_PROFILE_ID')
    pass

```

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

### API Overview

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Provides general information about the ixBrowser Local API, including its purpose, usage guidelines, and limitations.

```APIDOC
## API Overview

**Update Time**: 2025-09-23 07:30:42

Our API can assist users in programmatically reading and writing account configuration information, starting and stopping browsers, querying accounts, and other basic interfaces. It can also be used with automation frameworks such as Selenium and Puppeteer to achieve browser operation automation.

**API Description**

1.  **Preparation before usage**:
    *   Check if the logged-in account has API permissions.
    *   The default access address for the API interface is http://127.0.0.1:53200 , and the port can be customized.

2.  **Parameter Description**:
    *   The request method is POST.
    *   POST content is in JSON format.
    *   Optional parameters are not required and can be omitted.

3.  **Interface Limit**:
    *   The number of concurrent requests to the interface is limited to 3.
```

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

### Appendix Information

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

References for error codes, time zones, languages, fonts, countries, enum variables, and WebGL metadata.

```APIDOC
## Appendix

### Error Code Appendix
Provides a list of possible error codes and their meanings.

### Time Zone Appendix
Lists supported time zones.

### Language Appendix
Lists supported languages.

### Font Appendix
Lists supported fonts.

### Country Appendix
Lists supported countries.

### Enum Variable Appendix
Details of enum variables used in the API.

### WebGL Metadata Appendix
Information regarding WebGL metadata.
```

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

### Fingerprint Configuration API Endpoints

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Endpoints for managing random fingerprint configurations.

```APIDOC
## POST /api/randomFingerprintConfiguration

### Description
Configures random fingerprint settings.

### Method
POST

### Endpoint
/api/randomFingerprintConfiguration

### Parameters
#### Request Body
- **config** (object) - Required - The configuration object for random fingerprints.
```

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

### Profile Management API Endpoints

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Endpoints for managing browser profiles, including creation, copying, opening, closing, and updating profiles.

```APIDOC
## POST /api/getProfileList

### Description
Retrieves a list of all available browser profiles.

### Method
POST

### Endpoint
/api/getProfileList

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/createProfile

### Description
Creates a new browser profile.

### Method
POST

### Endpoint
/api/createProfile

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new profile.
- **group_id** (string) - Optional - The ID of the group to which the profile belongs.
- **tag** (string) - Optional - A tag to associate with the profile.
```

```APIDOC
## POST /api/copyProfile

### Description
Copies an existing browser profile.

### Method
POST

### Endpoint
/api/copyProfile

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to copy.
- **new_name** (string) - Required - The name for the new copied profile.
```

```APIDOC
## POST /api/openProfile

### Description
Opens a specified browser profile.

### Method
POST

### Endpoint
/api/openProfile

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to open.
```

```APIDOC
## POST /api/getOpenedProfile

### Description
Retrieves information about currently opened browser profiles.

### Method
POST

### Endpoint
/api/getOpenedProfile

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/retrieveOpenedProfiles

### Description
Retrieves profiles that were opened via the local API.

### Method
POST

### Endpoint
/api/retrieveOpenedProfiles

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/customizeProfileLayout

### Description
Customizes the layout for profiles that are already opened.

### Method
POST

### Endpoint
/api/customizeProfileLayout

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile whose layout needs customization.
- **layout_config** (object) - Required - Configuration object for the layout customization.
```

```APIDOC
## POST /api/resetBrowserOpenStatus

### Description
Resets the open status for browser profiles.

### Method
POST

### Endpoint
/api/resetBrowserOpenStatus

### Parameters
#### Request Body
- **profile_id** (string) - Optional - The ID of the profile to reset. If omitted, all profiles will be reset.
```

```APIDOC
## POST /api/openProfileWithRandomFingerprint

### Description
Opens a profile with a randomly generated fingerprint configuration.

### Method
POST

### Endpoint
/api/openProfileWithRandomFingerprint

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to open.
- **fingerprint_config** (object) - Optional - Specific fingerprint configuration to apply.
```

```APIDOC
## POST /api/closeProfile

### Description
Closes a specified browser profile.

### Method
POST

### Endpoint
/api/closeProfile

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to close.
```

```APIDOC
## POST /api/closeProfilesBatch

### Description
Closes multiple browser profiles in a batch.

### Method
POST

### Endpoint
/api/closeProfilesBatch

### Parameters
#### Request Body
- **profile_ids** (array of strings) - Required - A list of profile IDs to close.
```

```APIDOC
## POST /api/clearProfileCache

### Description
Clears the cache for a specified browser profile.

### Method
POST

### Endpoint
/api/clearProfileCache

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile whose cache needs to be cleared.
```

```APIDOC
## POST /api/clearProfileCacheAndCookies

### Description
Clears both the cache and cookies for a specified browser profile.

### Method
POST

### Endpoint
/api/clearProfileCacheAndCookies

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile whose cache and cookies need to be cleared.
```

```APIDOC
## POST /api/clearSavedAccountAndPassword

### Description
Clears saved account and password information within a browser profile.

### Method
POST

### Endpoint
/api/clearSavedAccountAndPassword

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to clear saved credentials from.
```

```APIDOC
## POST /api/updateProfile

### Description
Updates the settings of an existing browser profile.

### Method
POST

### Endpoint
/api/updateProfile

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **updates** (object) - Required - An object containing the fields to update and their new values.
```

```APIDOC
## POST /api/updateProfileProxyResidential

### Description
Updates the proxy information for a profile using a purchased residential proxy.

### Method
POST

### Endpoint
/api/updateProfileProxyResidential

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **proxy_details** (object) - Required - Details of the purchased residential proxy.
```

```APIDOC
## POST /api/updateProfileProxyStatic

### Description
Updates the proxy information for a profile using a purchased static proxy.

### Method
POST

### Endpoint
/api/updateProfileProxyStatic

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **proxy_details** (object) - Required - Details of the purchased static proxy.
```

```APIDOC
## POST /api/updateProfileProxyCustom

### Description
Updates the proxy information for a profile using a custom proxy configuration.

### Method
POST

### Endpoint
/api/updateProfileProxyCustom

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **proxy_details** (object) - Required - Details of the custom proxy configuration.
```

```APIDOC
## POST /api/updateProfileProxyAPI

### Description
Updates the proxy information for a profile using API extraction for proxy details.

### Method
POST

### Endpoint
/api/updateProfileProxyAPI

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **api_details** (object) - Required - Details for API extraction of proxy information.
```

```APIDOC
## POST /api/updateProfileGroupsBatch

### Description
Updates the group assignments for multiple profiles in a batch.

### Method
POST

### Endpoint
/api/updateProfileGroupsBatch

### Parameters
#### Request Body
- **profile_ids** (array of strings) - Required - A list of profile IDs to update.
- **group_id** (string) - Required - The ID of the group to assign the profiles to.
```

```APIDOC
## POST /api/getProfileCookies

### Description
Retrieves the cookies for a specified browser profile.

### Method
POST

### Endpoint
/api/getProfileCookies

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile from which to retrieve cookies.
```

```APIDOC
## POST /api/updateProfileCookies

### Description
Updates the cookies for a specified browser profile.

### Method
POST

### Endpoint
/api/updateProfileCookies

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **cookies** (array of objects) - Required - A list of cookies to set for the profile.
```

```APIDOC
## POST /api/deleteProfile

### Description
Deletes a specified browser profile.

### Method
POST

### Endpoint
/api/deleteProfile

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to delete.
```

```APIDOC
## POST /api/emptyRecycleBin

### Description
Empties the recycle bin, permanently deleting profiles that were previously marked for deletion.

### Method
POST

### Endpoint
/api/emptyRecycleBin

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/createProfileTransferCode

### Description
Creates a transfer code for a profile, allowing it to be imported into another instance.

### Method
POST

### Endpoint
/api/createProfileTransferCode

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to create a transfer code for.
```

```APIDOC
## POST /api/cancelProfileTransferCode

### Description
Cancels an existing profile transfer code.

### Method
POST

### Endpoint
/api/cancelProfileTransferCode

### Parameters
#### Request Body
- **transfer_code** (string) - Required - The transfer code to cancel.
```

```APIDOC
## POST /api/importProfileViaTransferCode

### Description
Imports a profile using a previously generated transfer code.

### Method
POST

### Endpoint
/api/importProfileViaTransferCode

### Parameters
#### Request Body
- **transfer_code** (string) - Required - The transfer code to use for importing the profile.
- **profile_name** (string) - Optional - The desired name for the imported profile.
```

```APIDOC
## POST /api/getProfileTransferRecordsList

### Description
Retrieves a list of records for profile transfers.

### Method
POST

### Endpoint
/api/getProfileTransferRecordsList

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

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

### Proxy Management API Endpoints

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Endpoints for managing proxy configurations, including retrieving proxy lists, creating, updating, and deleting custom proxies.

```APIDOC
## POST /api/getResidentialProxyList

### Description
Retrieves a list of available residential proxies.

### Method
POST

### Endpoint
/api/getResidentialProxyList

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/getProxyList

### Description
Retrieves a list of all configured proxies.

### Method
POST

### Endpoint
/api/getProxyList

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/createCustomProxy

### Description
Creates a new custom proxy configuration.

### Method
POST

### Endpoint
/api/createCustomProxy

### Parameters
#### Request Body
- **proxy_details** (object) - Required - The details for the custom proxy configuration.
```

```APIDOC
## POST /api/updateCustomProxy

### Description
Updates an existing custom proxy configuration.

### Method
POST

### Endpoint
/api/updateCustomProxy

### Parameters
#### Request Body
- **proxy_id** (string) - Required - The ID of the custom proxy to update.
- **proxy_details** (object) - Required - The updated details for the custom proxy configuration.
```

```APIDOC
## POST /api/deleteCustomProxy

### Description
Deletes a specified custom proxy configuration.

### Method
POST

### Endpoint
/api/deleteCustomProxy

### Parameters
#### Request Body
- **proxy_id** (string) - Required - The ID of the custom proxy to delete.
```

```APIDOC
## POST /api/getProxyTag

### Description
Retrieves a list of tags associated with proxies.

### Method
POST

### Endpoint
/api/getProxyTag

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/createProxyTag

### Description
Creates a new tag for proxies.

### Method
POST

### Endpoint
/api/createProxyTag

### Parameters
#### Request Body
- **tag_name** (string) - Required - The name for the new proxy tag.
```

```APIDOC
## POST /api/updateProxyTag

### Description
Updates an existing proxy tag.

### Method
POST

### Endpoint
/api/updateProxyTag

### Parameters
#### Request Body
- **tag_id** (string) - Required - The ID of the proxy tag to update.
- **new_tag_name** (string) - Required - The new name for the proxy tag.
```

```APIDOC
## POST /api/deleteProxyTag

### Description
Deletes a specified proxy tag.

### Method
POST

### Endpoint
/api/deleteProxyTag

### Parameters
#### Request Body
- **tag_id** (string) - Required - The ID of the proxy tag to delete.
```

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

### Access Gateway API Endpoints

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Endpoints for managing access gateways, including retrieving lists and switching gateways.

```APIDOC
## POST /api/getGatewayList

### Description
Retrieves a list of available access gateways.

### Method
POST

### Endpoint
/api/getGatewayList

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/switchAccessGateway

### Description
Switches the active access gateway.

### Method
POST

### Endpoint
/api/switchAccessGateway

### Parameters
#### Request Body
- **gateway_id** (string) - Required - The ID of the gateway to switch to.
```

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

### Tag Management API Endpoints

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Endpoints for managing tags associated with profiles, including retrieval, creation, updating, and deletion of tags.

```APIDOC
## POST /api/getTag

### Description
Retrieves a list of all existing tags.

### Method
POST

### Endpoint
/api/getTag

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/createTag

### Description
Creates a new tag.

### Method
POST

### Endpoint
/api/createTag

### Parameters
#### Request Body
- **tag_name** (string) - Required - The name for the new tag.
```

```APIDOC
## POST /api/updateTag

### Description
Updates an existing tag.

### Method
POST

### Endpoint
/api/updateTag

### Parameters
#### Request Body
- **tag_id** (string) - Required - The ID of the tag to update.
- **new_tag_name** (string) - Required - The new name for the tag.
```

```APIDOC
## POST /api/deleteTag

### Description
Deletes a specified tag.

### Method
POST

### Endpoint
/api/deleteTag

### Parameters
#### Request Body
- **tag_id** (string) - Required - The ID of the tag to delete.
```

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

### Group Management API Endpoints

Source: https://ixbrowser.com/doc/v2/local-api/en?target_id=70c61be8-4100-4330-a036-23732306ef6d

Endpoints for managing profile groups, including retrieval, creation, updating, and deletion of groups.

```APIDOC
## POST /api/getGroup

### Description
Retrieves a list of all existing profile groups.

### Method
POST

### Endpoint
/api/getGroup

### Parameters
#### Request Body
- **none** (object) - No specific parameters required for this request.
```

```APIDOC
## POST /api/createGroup

### Description
Creates a new profile group.

### Method
POST

### Endpoint
/api/createGroup

### Parameters
#### Request Body
- **group_name** (string) - Required - The name for the new group.
```

```APIDOC
## POST /api/updateGroup

### Description
Updates an existing profile group.

### Method
POST

### Endpoint
/api/updateGroup

### Parameters
#### Request Body
- **group_id** (string) - Required - The ID of the group to update.
- **new_group_name** (string) - Required - The new name for the group.
```

```APIDOC
## POST /api/deleteGroup

### Description
Deletes a specified profile group.

### Method
POST

### Endpoint
/api/deleteGroup

### Parameters
#### Request Body
- **group_id** (string) - Required - The ID of the group to delete.
```
Tokens:
Raw