Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
182 lines (127 loc) · 4.24 KB

GETTING_STARTED.md

File metadata and controls

182 lines (127 loc) · 4.24 KB
Raw

Getting Started

This guide walks you through installing CapSkip, installing the Python SDK, and running your first captcha solve.

Prerequisites

Requirement Details
CapSkip app Windows desktop app from capskip.com
Python 3.10 or newer
Network SDK talks to CapSkip on localhost — no internet required for the API itself

Step 1 — Install and configure CapSkip

  1. Download CapSkip from capskip.com.
  2. Install and launch the application.
  3. Open Settings and confirm:
    • Port — default is 8080 (remember this value)
    • API key validation — if enabled, copy your API key; if disabled, any string (e.g. capskip) is accepted

CapSkip exposes a standard captcha-solver API:

POST http://127.0.0.1:<port>/in.php   → submit captcha, returns OK|<id>
GET  http://127.0.0.1:<port>/res.php  → poll result, returns OK|<answer>

Verify CapSkip is running

Windows (PowerShell):

Invoke-WebRequest "http://127.0.0.1:8080/res.php?key=capskip&action=get&id=0" -UseBasicParsing

You should get a response (even an error like ERROR_WRONG_CAPTCHA_ID confirms the server is up).

Linux / macOS:

curl "http://127.0.0.1:8080/res.php?key=capskip&action=get&id=0"

Step 2 — Install the Python SDK

From PyPI (recommended)

pip install capskip

From source (development)

git clone https://github.com/capskip/capskip-python.git
cd capskip-python
pip install -e .

Verify installation

python -c "import capskip; print(capskip.__version__)"

Expected output: 1.0.2 (or your installed version).

Verify CapSkip connectivity

python examples/verify_connection.py

If CapSkip is running, you should see Status: OK — CapSkip is reachable.

Step 3 — Create a virtual environment (recommended)

python -m venv .venv

Windows:

.venv\Scripts\activate
pip install capskip

Linux / macOS:

source .venv/bin/activate
pip install capskip

Step 4 — Your first script

Create solve_recaptcha.py:

import os
from capskip import CapSkip, NetworkException, TimeoutException

solver = CapSkip(
    apiKey=os.getenv("CAPSKIP_API_KEY", "capskip"),
    host=os.getenv("CAPSKIP_HOST", "127.0.0.1"),
    port=int(os.getenv("CAPSKIP_PORT", "8080")),
)

SITEKEY = "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"  # replace with your target page sitekey
PAGE_URL = "https://example.com/login"                 # replace with your target page URL

try:
    result = solver.recaptcha(sitekey=SITEKEY, url=PAGE_URL)
    print("Captcha ID:", result["captchaId"])
    print("Token:     ", result["code"][:80], "...")
except NetworkException as e:
    print("Cannot reach CapSkip — is the app running?", e)
except TimeoutException as e:
    print("Timed out:", e)

Run it:

python solve_recaptcha.py

Step 5 — Run the bundled examples

Clone the repository (if you haven't already) and run an example:

cd capskip-python
python examples/recaptcha.py
Example What it demonstrates
image_captcha.py Image captcha from file, URL, or base64
recaptcha.py reCAPTCHA v2, v3, invisible, enterprise, proxy
turnstile.py Cloudflare Turnstile widget and challenge page
geetest.py GeeTest v3 slider, including fetching a fresh gt/challenge pair
async_example.py Parallel async solving
verify_connection.py Check CapSkip is running

Environment variables

Variable Default Description
CAPSKIP_API_KEY capskip API key sent with every request
CAPSKIP_HOST 127.0.0.1 CapSkip host
CAPSKIP_PORT 8080 CapSkip port

Example .env file (load with python-dotenv if you use it):

CAPSKIP_API_KEY=capskip
CAPSKIP_HOST=127.0.0.1
CAPSKIP_PORT=8080

Next steps