> For the complete documentation index, see [llms.txt](https://docs.hypersolutions.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hypersolutions.co/start-here/quickstart.md).

# Quickstart

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](/start-here/overview.md) first (2 minutes).

### 1. Get your API key

Create an account and grab a key from your dashboard: [hypersolutions.co/keys](https://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

{% tabs %}
{% tab title="Go" %}

```bash
go get github.com/Hyper-Solutions/hyper-sdk-go/v2
```

{% endtab %}

{% tab title="Python" %}

```bash
pip install hyper-sdk
```

{% endtab %}

{% tab title="JS/TS" %}

```bash
npm install hyper-sdk-js
```

{% endtab %}
{% endtabs %}

### 3. Construct a session

{% tabs %}
{% tab title="Go" %}

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

session := hyper.NewSession("your-api-key")
```

{% endtab %}

{% tab title="Python" %}

```python
from hyper_sdk import Session

session = Session("your-api-key")
```

{% endtab %}

{% tab title="JS/TS" %}

```typescript
import { Session } from "hyper-sdk-js";

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

{% endtab %}
{% endtabs %}

### 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](/start-here/core-requirements.md)).

{% code overflow="wrap" %}

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

{% endcode %}

A successful response returns your IP as JSON:

```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](/request-based-basics/ip.md) for why this matters.

### 5. Bypass your first site

You're set up. Now:

1. Read the [Core Requirements](/start-here/core-requirements.md), 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](https://github.com/Hyper-Solutions/hypersolutions-examples).

{% hint style="info" %}
Prefer to build with an AI agent? The [Claude Code plugin](/ai-plugins/claude-code-plugin.md) knows the whole API and can scaffold an integration for you from a single prompt.
{% endhint %}
