# Local Service Guide (Demo Download)

## Do you want to join the group chat?

If you would like to join the \[API Developers] group (for developers only; non-developers will be removed), or the \[Custom Script Development] group, [please click here to contact customer service](https://www.bitbrowser.net/contact), and we will arrange for you to join the group!

Kind reminder: Please select the appropriate group according to your needs to ensure the relevance and quality of the communication.

## Introduction

Call the local API to operate the app to open, configure the proxy, etc., to help users realize the automatic script function.

### JavaScript demo

Note: The request data is only for demo, for details, please refer to the API document.

{% file src="<https://1346224839-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDG17bXYc9SCTUw90LCSz%2Fuploads%2FQRGgkoLMAAT29n2bqJ1p%2Fnodejs-demo.zip?alt=media&token=e02b04cd-7711-4e92-8607-23aca0c7e2d5>" %}

### Python demo

Note: The request data is only for demo, for details, please refer to the API document.

{% file src="<https://1346224839-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDG17bXYc9SCTUw90LCSz%2Fuploads%2Foy0OUe72R4ludoFNeWgk%2Fpython-demo.zip?alt=media&token=4b0d5715-8e9b-40e7-9958-662b17ad16ab>" %}

### Postman debug demo, import to use

{% file src="<https://1346224839-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDG17bXYc9SCTUw90LCSz%2Fuploads%2FgpDafZ0h3q3WwKfx9ERn%2FBitnet%20Export.postman_collection.json?alt=media&token=38da6c2f-674f-4611-8d94-da502647dc02>" %}

### Service Introduction

Support the use of browser functions via Local API to help users run their own automation scripts.

### How to use

1. Install and log in to BitBrowser.
2. To Settings, find Local API url and port.
3. Download and run demo.

### Interface instructions

* Request method is post, and the parameter passing method is responseBody.
* The interface returns a json object, success is true and the operation is successful. If there is any returned data, it will be appended to the data object
* When the interface returns success as false, it means that the business failed, which may be due to program reasons or parameter verification, etc., and the failure information will be appended to msg

```
// success example
{
  success: true,
  data: {
    id: '2c9c29a28sdd33dds8026f78e380142',
    groupName: 'name'
  }
}

// failed example
{ success: false, msg: 'Id is required' }
```

### API Quick Start

<figure><img src="https://1346224839-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDG17bXYc9SCTUw90LCSz%2Fuploads%2FWa1AgWgEphhcxAaCuWCS%2FLocal%20Api%20Quick%20Start.svg?alt=media&#x26;token=1516dd46-6da5-49a7-82c2-80efc0990d6d" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.bitbrowser.net/api-docs/local-service-guide-demo-download.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.