# Hyper Solutions API Documentation

## API Docs

- [Getting started](https://docs.hypersolutions.co/readme.md): Hyper Solutions generates sensor data for bypassing Akamai Bot Manager, Incapsula, DataDome, and Kasada.
- [Overview](https://docs.hypersolutions.co/start-here/overview.md): What Hyper Solutions does, how the API fits into your scraper, and the mental model that makes everything else in these docs make sense.
- [Quickstart](https://docs.hypersolutions.co/start-here/quickstart.md): Get an API key, install an SDK, and make your first authenticated call to Hyper Solutions in a few minutes.
- [Core Requirements](https://docs.hypersolutions.co/start-here/core-requirements.md): The non-negotiable requirements that apply to every Hyper Solutions integration, regardless of which anti-bot system you're bypassing.
- [SDKs & Examples](https://docs.hypersolutions.co/start-here/readme-1.md): We have SDKs for the following languages: Golang, Python, NodeJS/TS.
- [TLS Fingerprinting](https://docs.hypersolutions.co/request-based-basics/tls-fingerprinting.md): This page explains everything you need to know about TLS when making requests based modules.
- [Header Order](https://docs.hypersolutions.co/request-based-basics/header-order.md): This page explains everything you need to know about headers and header order when making requests based modules.
- [Proxies & IP](https://docs.hypersolutions.co/request-based-basics/ip.md): Most Hyper Solutions APIs take your proxy's outbound IP as an input. This page explains why, and why you must use sticky (not rotating) proxies.
- [Installing Charles WebProxy](https://docs.hypersolutions.co/request-based-basics/installing-charles-webproxy.md): How to install Charles WebProxy, trust its root certificate and enable SSL proxying so you can inspect the HTTPS traffic your scraper sends.
- [Installing powhttp](https://docs.hypersolutions.co/request-based-basics/installing-powhttp.md): How to install powhttp and route your scraper through it to capture real wire traffic, including true header order and TLS fingerprint, when debugging blocks.
- [Recording HAR files](https://docs.hypersolutions.co/request-based-basics/recording-har-files-for-harvey.md): This page explains how to record HAR files from your code for debugging and support. We explain how to do this with the recommended tools: Charles Webproxy and powhttp.
- [Akamai Bot Manager: Getting Started](https://docs.hypersolutions.co/akamai-web/getting-started.md): This page explains the flow of generating sensor data and obtaining valid cookies for websites protected by Akamai Bot Manager.
- [SBSD Introduction](https://docs.hypersolutions.co/akamai-web/sbsd-introduction.md): SBSD (State Based Scraping Detection) is Akamai's passive sensor check. This page covers identifying basic SBSD and posting sensors to keep access valid.
- [SBSD Challenge Flow](https://docs.hypersolutions.co/akamai-web/sbsd-challenge-flow.md): Websites using Akamai's active SBSD mode serve a challenge that must be solved before content is released. This page walks through that challenge flow.
- [Handling 429 Status Codes with SBSD Challenges](https://docs.hypersolutions.co/akamai-web/handling-429-status-codes-with-sbsd-challenges.md): A 429 Too Many Requests from an SBSD protected API is a challenge, not a rate limit. This page shows how to extract the challenge token and post a fresh SBSD payload.
- [Handling 428 Status Code (SEC-CPT)](https://docs.hypersolutions.co/akamai-web/handling-428-status-code-sec-cpt.md): Akamai returns 428 Precondition Required when a SEC-CPT challenge is active. This page covers the crypto, behavioral and adaptive providers and how to solve each one.
- [Incapsula & Imperva: Getting Started](https://docs.hypersolutions.co/incapsula/getting-started.md): Incapsula (now Imperva) guards enterprise sites with the reese84 sensor and the \_\_\_utmvc cookie. This page explains how the pieces fit together.
- [Reese84](https://docs.hypersolutions.co/incapsula/reese84.md): Reese84 is Imperva / Incapsula's core bot check: a hidden JavaScript sensor that expects a signed payload before it issues a valid reese84 token.
- [Reese84 Dynamic](https://docs.hypersolutions.co/incapsula/reese84-dynamic.md): Reese84 Dynamic is used by sites that show a "Pardon Our Interruption" challenge page. Clients must solve the challenge and submit a valid payload to access the protected content.
- [Incapsula Captcha Block](https://docs.hypersolutions.co/incapsula/incapsula-captcha-block.md): Walkthrough of the Incapsula captcha block flow: detecting the challenge page, extracting the \_Incapsula\_Resource URL and submitting the token to regain access.
- [UTMVC](https://docs.hypersolutions.co/incapsula/utmvc.md): UTMVC is an Incapsula / Imperva protection that runs a script and sets a \_\_\_utmvc cookie (three underscores) before granting access to the site.
- [DataDome: Getting Started](https://docs.hypersolutions.co/datadome/getting-started.md): DataDome serves two challenge types, interstitial and slider. This page helps you identify which one you're facing and points you to the right guide.
- [DataDome Tags](https://docs.hypersolutions.co/datadome/tags.md): DataDome tags are extra telemetry posted to /js that raise a session's trust score and reduce blocks. This page shows how to generate tags payloads with our SDKs.
- [DataDome Slider Captcha](https://docs.hypersolutions.co/datadome/slider-captcha.md): This page explains the flow of solving the slider challenge of DataDome.
- [DataDome Interstitial](https://docs.hypersolutions.co/datadome/interstitial.md): This page explains the flow of solving the interstitial challenge of DataDome.
- [Kasada: Getting Started](https://docs.hypersolutions.co/k4sada/getting-started.md): This page covers the different Kasada implementation flows you may encounter.
- [Flow 1: Initial Block Page](https://docs.hypersolutions.co/k4sada/flow-1-initial-block-page.md): This flow applies to websites like Hyatt.com where Kasada blocks you immediately when you first access the site with a 429 status code.
- [Flow 2: Fingerprint Endpoint](https://docs.hypersolutions.co/k4sada/flow-2-fingerprint-endpoint.md): This is the standard Kasada implementation where the browser makes a background request to the /fp (fingerprint) endpoint. This flow applies to most Kasada-protected websites.
- [Vercel BotID](https://docs.hypersolutions.co/k4sada/vercel-botid.md): This flow applies when a site is protected by Kasada through Vercel BotID.  You can identify this by the presence of the \`x-is-human\` header on requests  to protected endpoints.
- [Supported User Agents](https://docs.hypersolutions.co/k4sada/supported-user-agents.md): This page documents all user agent configurations supported by the Hyper Solutions Kasada API.
- [Authentication](https://docs.hypersolutions.co/api-reference/authentication.md): Authentication can be done in two ways.
- [Akamai API Reference](https://docs.hypersolutions.co/api-reference/akamai.md): API reference for the Hyper Solutions Akamai API: generate sensor data, SBSD payloads and SEC-CPT challenge responses for sites behind Akamai Bot Manager.
- [Incapsula API Reference](https://docs.hypersolutions.co/api-reference/incapsula.md): API reference for the Hyper Solutions Incapsula API: generate reese84 sensor payloads and utmvc cookies for sites behind Imperva / Incapsula.
- [DataDome API Reference](https://docs.hypersolutions.co/api-reference/datadome.md): This page shows the API Reference for our DataDome API.
- [Kasada API Reference](https://docs.hypersolutions.co/api-reference/kasada.md): API reference for the Hyper Solutions Kasada API: generate x-kpsdk-ct challenge tokens, x-kpsdk-cd challenge data and Vercel BotID x-is-human headers.
- [Usage & Status Codes](https://docs.hypersolutions.co/api-reference/usage-statistics.md): Check your remaining quota with the Usage API, and understand the HTTP status codes the Hyper Solutions API returns.
- [Compression](https://docs.hypersolutions.co/api-reference/compression.md): Our API supports multiple compression algorithms to improve performance and reduce bandwidth usage.
- [User Agents](https://docs.hypersolutions.co/api-reference/user-agents.md): This page explains the supported user agent configurations and how to maintain them for optimal performance across all Hyper Solutions APIs.
- [Claude Code plugin](https://docs.hypersolutions.co/ai-plugins/claude-code-plugin.md): The official Hyper Solutions plugin for Claude Code: integrate the Akamai, Incapsula, DataDome, and Kasada APIs and debug blocked requests with live traffic capture or HAR analysis.
- [Codex plugin](https://docs.hypersolutions.co/ai-plugins/codex-plugin.md): The official Hyper Solutions plugin for OpenAI Codex: integrate the Akamai, Incapsula, DataDome, and Kasada APIs and debug blocked requests with live traffic capture or HAR analysis.
