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

# Introduction

helodata is a proxy platform built for engineers. We run the IP infrastructure, the rotation logic, and the geo-targeting — you make HTTP requests.

## What's in this documentation

* [**Products**](/products/overview.md) — per-SKU reference for residential, mobile, and ISP proxies
* [**Integrations**](/integrations/integrations.md) — drop-in guides for Selenium, Puppeteer, Scrapy, antidetect browsers, n8n, LangChain, and more
* [**API reference**](/api-reference/api-reference.md) — REST endpoints to manage orders, sub-users, traffic, and reports
* [**Troubleshooting**](/troubleshooting/troubleshooting.md) — error codes and recovery playbooks

## Conventions

Code samples use these placeholders. Replace them with values from your dashboard.

| Placeholder        | Meaning                                                                                                                                                           |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `USERNAME`         | Your sub-user name (e.g. `s1a2b3c4d5e`). The full proxy username is built by wrapping it in the [helodata username grammar](/getting-started/username-format.md). |
| `PASSWORD`         | The sub-user password                                                                                                                                             |
| `gate.helodata.io` | The proxy gateway host                                                                                                                                            |
| `7777`             | The default HTTP/SOCKS5 port                                                                                                                                      |
| `API_KEY`          | A REST API token issued from **Dashboard → API**                                                                                                                  |

Every proxy username follows one shape:

```
helo_{username}-type-{type}-region-{region}[-state-{state}][-city-{city}][-asn-{asn}][-session-{session_id}-sesstime-{ttl}]
```

If a code sample shows `helo_s1a2b3c4d5e-type-res-region-us`, the `s1a2b3c4d5e` part is what you replace.

All examples assume a Unix-like shell. Windows users should adapt quoting accordingly.

## Versioning

The REST API is versioned in the URL (`/v1/...`). Breaking changes ship as a new major version with a 6-month deprecation window. See the [Changelog](/resources/changelog.md) for what shipped when.


---

# 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.helodata.com/getting-started/introduction.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.