For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quickstart

Get an API key, install an SDK, and make your first authenticated call to Hyper Solutions in a few minutes.

This gets you from zero to a working SDK and a verified API key. It does not bypass a site yet, for that, finish here and then follow the guide for your target's anti-bot system.

New to how the API fits together? Read the Overview first (2 minutes).

1. Get your API key

Create an account and grab a key from your dashboard: hypersolutions.co/keys. Every request authenticates with this key via the x-api-key header, the SDKs handle that header for you.

2. Install an SDK

go get github.com/Hyper-Solutions/hyper-sdk-go/v2
pip install hyper-sdk
npm install hyper-sdk-js

3. Construct a session

import hyper "github.com/Hyper-Solutions/hyper-sdk-go/v2"

session := hyper.NewSession("your-api-key")
from hyper_sdk import Session

session = Session("your-api-key")
import { Session } from "hyper-sdk-js";

const session = new Session("your-api-key");

4. Confirm your key works

Constructing the session above does no network I/O, so make one quick call to confirm your key works. The simplest is the /ip endpoint, which you'll use in real integrations too: it returns the outbound IP of your proxy, which you pass as an input to every sensor call (see Core Requirements).

curl https://ip.hypersolutions.co/ip -H "x-api-key: your-api-key"

A successful response returns your IP as JSON:

{ "ip": "1.2.3.4" }

If you get a 401, your key is wrong or missing. Route this request through the same sticky proxy you'll use for scraping so the IP matches, see IP for why this matters.

5. Bypass your first site

You're set up. Now:

  1. Read the Core Requirements, the TLS client, header order, and proxy rules every integration needs.

  2. Identify your target's anti-bot system and open its guide: Akamai, Incapsula, DataDome, or Kasada.

  3. Follow that guide's Getting Started, then grab full working code from the examples repository.

Prefer to build with an AI agent? The Claude Code plugin knows the whole API and can scaffold an integration for you from a single prompt.

Last updated