Postman collection

We publish a maintained Postman collection covering every endpoint in this API reference, plus sample proxy requests for the three live products.

Import

From URL

In Postman: Import → Link, paste:

https://api.helodata.com/v1/postman/collection.json

The collection updates on every API release. Re-import to refresh.

From file

Download once, then drag-drop into Postman:

curl -H "Authorization: Bearer API_KEY" \
     https://api.helodata.com/v1/postman/collection.json \
     -o helodata.postman_collection.json

The collection is also shipped with this docs repository at assets/helodata.postman_collection.json along with a starter environment assets/helodata-prod.postman_environment.json — import both for an out-of-box setup.

What's included

helodata/
├── 0 — Welcome
├── 1 — Auth check (GET /users/me)
├── 2 — Sub-users
│   ├── List
│   ├── Create
│   ├── Get
│   ├── Update
│   ├── Rotate password
│   └── Delete
├── 3 — Orders
│   ├── Create residential
│   ├── Create mobile
│   └── Create ISP batch
├── 4 — ISP batches
│   ├── List
│   ├── Download IPs (plain / csv / json)
│   ├── Replace IP
│   ├── Refresh batch
│   └── Renew
├── 5 — Subscriptions
├── 6 — Traffic & reports
├── 7 — Whitelists
├── 8 — Sessions
└── 9 — Proxy gateway samples
    ├── Residential — basic
    ├── Residential — city + session
    ├── Mobile — ASN-pinned
    └── ISP — single IP

Environment

The collection ships with two environments to import:

• helodata-prod — production endpoints
• helodata-test — sandbox (coming soon)

Variables you fill in:

Variable	Value
api_key	Your API token
subuser_name	e.g. s1a2b3c4d5e
subuser_pass	Sub-user password
isp_ip	One IP from your ISP batch (for proxy samples)

Run via Newman (CI)

newman run helodata.postman_collection.json \
       --environment helodata-prod.postman_environment.json \
       --env-var "api_key=$HELODATA_API_KEY" \
       --folder "1 — Auth check"

Useful for smoke-testing your account from CI after credential rotation.

OpenAPI

If your tools prefer OpenAPI, the same surface is available at:

https://api.helodata.com/v1/openapi.json

Compatible with Swagger UI, Redoc, Stoplight, and most code generators.

Versioning

Both collection.json and openapi.json follow the same /v1 versioning as the API itself. We publish a new spec major version when breaking changes ship; older versions remain importable at /v0/..., /v1/..., etc.