> For the complete documentation index, see [llms.txt](https://jollyproxy.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jollyproxy.gitbook.io/docs/residential-proxy/parameter-description.md).

# Parameter Description

{% hint style="danger" icon="exclamation" %}
**Usage Notice**: All JollyProxy proxy products must be used in an overseas network environment. Please ensure that you have configured the corresponding overseas network environment yourself.
{% endhint %}

This article demonstrates how to use `curl` to make requests through JollyProxy Residential Proxy, suitable for calling the proxy connection directly in a terminal or script.

**Parameter Format**

```yaml
<account>-<proxy type>-<location information>[-sid-<session ID>]
```

**Parameter Description**

<table data-header-hidden data-search="false"><thead><tr><th width="156.2000732421875"></th><th width="124"></th><th width="128.4000244140625"></th><th></th></tr></thead><tbody><tr><td>Name</td><td>Type</td><td>Required</td><td>Remarks</td></tr><tr><td><code>account</code></td><td>string</td><td>Yes</td><td>Account name</td></tr><tr><td><code>proxyAdress</code></td><td>string</td><td>Yes</td><td>Proxy address</td></tr><tr><td><code>country</code></td><td>string</td><td>No</td><td>Country</td></tr><tr><td><code>state</code></td><td>string</td><td>No</td><td>State/Province</td></tr><tr><td><code>city</code></td><td>string</td><td>No</td><td>City</td></tr><tr><td><code>session</code></td><td>string</td><td>No</td><td>Session ID, supports up to 11 characters</td></tr><tr><td><code>sessTime</code></td><td>int64</td><td>No</td><td>Default 5 minutes, options 1-180 minutes</td></tr><tr><td><code>sessFallBack</code></td><td>int64</td><td>No</td><td>Whether to replenish nodes when offline</td></tr></tbody></table>

**Location Format**

<table data-header-hidden><thead><tr><th width="133"></th><th width="230.39990234375"></th><th width="129"></th><th></th></tr></thead><tbody><tr><td>Level</td><td>Format</td><td>Proxy Type Notation</td><td>Example</td></tr><tr><td>No location</td><td><code>any</code></td><td><code>res</code></td><td><code>account-res-any</code></td></tr><tr><td>Country</td><td><code>&#x3C;country></code></td><td><code>res</code></td><td><code>account-res-us</code></td></tr><tr><td>Country+State</td><td><code>&#x3C;country>_&#x3C;state></code></td><td><code>res_sc</code></td><td><code>account-res_sc-us_california</code></td></tr><tr><td>Country+State+City</td><td><code>&#x3C;country>_&#x3C;state>_&#x3C;city></code></td><td><code>res_sc</code></td><td><code>account-res_sc-us_california_losangeles</code></td></tr></tbody></table>

> **Notes:**
>
> * **When the location information includes a state or city, the proxy type must add the `sc` suffix (e.g., `res_sc`)**
> * **All region names must use lowercase letters and contain no spaces, for example: `us`, `california`, `losangeles`, `newsouthwales`**

**Request Examples**

In the following examples, please replace `account`, `password`, `[ip]`, and `[port]` with the actual proxy information you obtained.

**1. Random Node (No Location)**

```shell
# Non-sticky node (automatically changes IP on each request)
curl -x http://account-res-any:password@[ip]:[port] http://httpbin.org/ip

# Sticky node (maintains the same IP via sid)
curl -x http://account-res-any-sid-295592634:password@[ip]:[port] http://httpbin.org/ip
```

**2. Specify Country**

```shell
# Non-sticky node
curl -x http://account-res-us:password@[ip]:[port] http://httpbin.org/ip

# Sticky node
curl -x http://account-res-us-sid-295592634:password@[ip]:[port] http://httpbin.org/ip
```

**3. Specify Country-Region (requires socks5 protocol and res\_sc type)**

```shell
# Non-sticky node
curl -x socks5://account-res_sc-us_california:password@[ip]:[port] http://httpbin.org/ip

# Sticky node
curl -x socks5://account-res_sc-us_california-sid-295592634:password@[ip]:[port] http://httpbin.org/ip
```

**4. Specify Country-Region-City (requires res\_sc type)**

```shell
# Non-sticky node
curl -x http://account-res_sc-us_california_losangeles:password@[ip]:[port] http://httpbin.org/ip

# Sticky node
curl -x http://account-res_sc-us_california_losangeles-sid-295592634:password@[ip]:[port] http://httpbin.org/ip
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://jollyproxy.gitbook.io/docs/residential-proxy/parameter-description.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.