> For the complete documentation index, see [llms.txt](https://docs.9proxy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.9proxy.com/getting-started/residential-proxy-by-ips/for-linux/start-api.md).

# Start API

Follow these steps to enable and use the 9Proxy API on your Linux server.

## 1. Start 9Proxy

To start 9Proxy, run the following command:

```
systemctl start 9proxyd.service
```

### Enable API Function

Activate the API feature by entering:

```
9proxy api
```

<figure><img src="/files/GWB0fYNlGuJPrRPfRZqN" alt=""><figcaption></figcaption></figure>

## 2. Set API port

Specify the port you want the API to listen on:

```
9proxy api -p [port]
```

* \[port] : your preferred port number

## 3. Check API Status (Optional)

To check the API status at any time, use:

```
9proxy api -d
```

## 4. Start the API

Run the API with:

```
9proxy api -s
```

## 5. Get API URL

Once the API is running, copy the API url shown in the terminal. You can now use this URL to integrate with your system.

## 6. Stop the API

To stop the API when needed, use:

```
9proxy api -c
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.9proxy.com/getting-started/residential-proxy-by-ips/for-linux/start-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
