This is the source for the docs at nikaproxy.com/docs — mirrored here in Markdown for direct GitHub reading, deep-linking, and community PRs.
- Quick start — sign up, grab credentials, fire your first request (5 min)
- Authentication — API keys, proxy passwords, where they live
- Residential, TLS Pro, TLS Ultra — the three product tiers and when to use which
- Proxy URL format — the username syntax (
-country,-session,-profile,-coord,-uav,-osv,-noae) - Sticky sessions — how to pin requests to the same exit IP, lifetime values, expected churn
- REST scrape API — endpoint reference, request schema, response envelope, code examples
- Error codes — HTTP status mapping + how to fix each
- Pricing & bandwidth — what counts as billable, plan tiers, balance behaviour
- TLS certificate setup — only required for TLS Pro / Ultra modes
The website at nikaproxy.com/docs is canonical — it has live integration examples, the dashboard's actual UI, and the up-to-the-minute API surface. This GitHub mirror is updated periodically. If they disagree on a detail, trust the website.
Docs PRs welcome. Please don't post API keys, real customer emails, sample destination URLs that include private data, or anything else that would be problematic in a public issue.
- Discord: discord.gg/xeeDxZMRh — community + dev questions, fastest reply
- Telegram: @Nikaproxy_support — 1-on-1 support
- Live docs: nikaproxy.com/docs
- Examples: github.com/Nika-Proxy/nikaproxy-examples