PHPackages                             webpipe/webpipe-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. webpipe/webpipe-sdk

ActiveLibrary

webpipe/webpipe-sdk
===================

Official WebPipe.ai SDK for PHP

0.1.0(yesterday)02↑2900%MITJavaPHP &gt;=8.1

Since Jul 30Pushed yesterdayCompare

[ Source](https://github.com/ydyyes123/webpipe_sdk)[ Packagist](https://packagist.org/packages/webpipe/webpipe-sdk)[ RSS](/packages/webpipe-webpipe-sdk/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (1)Versions (2)Used By (0)

webpipe-sdk
===========

[](#webpipe-sdk)

English | [简体中文](./README.zh-CN.md)

Official SDKs for [WebPipe.ai](https://webpipe.ai/) — turn any webpage into clean, structured data with one API call.

Scrape, Map, Crawl, and persistent Browser Sessions. Designed for AI apps and data pipelines.

Packages
--------

[](#packages)

LanguagePackageStatusPython[`webpipe-sdk`](./packages/python) (`pip install webpipe-sdk`)✅TypeScript / JavaScript[`webpipe-sdk`](./packages/js) (`npm install webpipe-sdk`)✅Go[`webpipe-sdk`](./packages/go) (`go get github.com/webpipe-ai/webpipe-sdk/packages/go`)✅PHP[`webpipe/webpipe-sdk`](./packages/php) (`composer require webpipe/webpipe-sdk`)✅Ruby[`webpipe-sdk`](./packages/ruby) (`gem install webpipe-sdk`)✅Java[`ai.webpipe:webpipe-sdk`](./packages/java) (Maven Central)✅Rust[`webpipe-sdk`](./packages/rust) (`cargo add webpipe-sdk`)✅C# / .NET[`Webpipe.Sdk`](./packages/dotnet) (`dotnet add package Webpipe.Sdk`)✅Quick Start
-----------

[](#quick-start)

**Python**

```
from webpipe import WebpipeClient

client = WebpipeClient(api_key="wc-...")  # or set WEBPIPE_API_KEY

doc = client.scrape("https://example.com", formats=["markdown", "links"])
print(doc.markdown)

job = client.crawl("https://example.com", limit=20)  # polls until done
for page in job.data:
    print(page.metadata.source_url)
```

**TypeScript**

```
import { Webpipe } from "webpipe-sdk";

const client = new Webpipe({ apiKey: "wc-..." }); // or set WEBPIPE_API_KEY

const doc = await client.scrape("https://example.com", { formats: ["markdown"] });
console.log(doc.markdown);

const session = await client.browser.create({ url: "https://example.com" });
await session.waitUntilRunning();
const page = await session.scrape({ formats: ["markdown"] });
await session.close();
```

**Go**

```
import webpipe "github.com/webpipe-ai/webpipe-sdk/packages/go"

client, _ := webpipe.NewClient() // reads WEBPIPE_API_KEY

doc, _ := client.Scrape(ctx, "https://example.com", &webpipe.ScrapeOptions{
    Formats: []string{"markdown"},
})
fmt.Println(doc.Markdown)

job, _ := client.Crawl(ctx, "https://example.com",
    &webpipe.CrawlOptions{Limit: 20}, nil) // polls until done
fmt.Println(len(job.Data), "pages")
```

**PHP**

```
use Webpipe\WebpipeClient;

$client = new WebpipeClient(); // reads WEBPIPE_API_KEY

$doc = $client->scrape('https://example.com', formats: ['markdown']);
echo $doc->markdown;

$session = $client->browser->create(url: 'https://example.com');
$session->waitUntilRunning();
$page = $session->scrape(formats: ['markdown']);
$session->close();
```

**Ruby**

```
require "webpipe"

client = Webpipe::Client.new # reads WEBPIPE_API_KEY

doc = client.scrape("https://example.com", formats: ["markdown"])
puts doc.markdown

job = client.crawl("https://example.com", limit: 20) do |status|
  puts "progress: #{status.completed}/#{status.total}" # yields after each poll
end
```

**Java**

```
import ai.webpipe.sdk.WebpipeClient;
import ai.webpipe.sdk.options.ScrapeOptions;

var client = WebpipeClient.create(); // reads WEBPIPE_API_KEY

var doc = client.scrape("https://example.com",
        new ScrapeOptions().formats(List.of("markdown")));
System.out.println(doc.markdown());

// Every method also has a non-blocking *Async variant:
var future = client.crawlAsync("https://example.com",
        new CrawlOptions().limit(20), 2, 600); // CompletableFuture
```

**Rust**

```
use webpipe_sdk::{Client, ScrapeOptions};

let client = Client::from_env()?; // reads WEBPIPE_API_KEY

let doc = client
    .scrape("https://example.com", Some(&ScrapeOptions {
        formats: Some(vec!["markdown".into()]),
        ..Default::default()
    }))
    .await?;
println!("{:?}", doc.markdown);
```

**C# / .NET**

```
using Webpipe.Sdk;
using Webpipe.Sdk.Options;

var client = new WebpipeClient(); // reads WEBPIPE_API_KEY

var doc = await client.ScrapeAsync("https://example.com",
    new ScrapeOptions { Formats = ["markdown"] });
Console.WriteLine(doc.Markdown);

var session = await client.Browser.CreateAsync(
    new CreateSessionOptions { Url = "https://example.com" });
await session.WaitUntilRunningAsync();
var page = await session.ScrapeAsync(new NavigateOptions { Formats = ["markdown"] });
await session.CloseAsync();
```

Features
--------

[](#features)

- **Scrape** — any URL → Markdown / cleaned HTML / links / metadata / structured JSON (with JSON Schema + `x-source` field mapping)
- **Map** — discover every URL on a site (robots.txt → sitemap → in-page links)
- **Crawl** — recursive whole-site crawling as an async job; SDK polls for you
- **Browser Session** — persistent headless Chromium: navigate, click, fill forms, screenshots, cookie injection, saved login states
- Typed everywhere, automatic retries with backoff, precise error classes

Examples
--------

[](#examples)

Runnable quickstart demos (mini CLIs with built-in demo URLs, including a full browser login flow) live in [`examples/`](./examples):

```
export WEBPIPE_API_KEY=wc-...
python examples/python/demo.py browser   # or: node demo.mjs / go run . / php demo.php
                                         # ruby demo.rb / mvn exec:java / cargo run --example demo / dotnet run
```

Documentation
-------------

[](#documentation)

- API docs:
- Repository guide for contributors &amp; agents: [AGENTS.md](./AGENTS.md)

License
-------

[](#license)

MIT

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance100

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity32

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b6d9ef95f8ad7c216518a5c224a86b8afaa26ddc3461a7d0c64794423e7ce846?d=identicon)[yangchunhua](/maintainers/yangchunhua)

---

Top Contributors

[![yangchunhua](https://avatars.githubusercontent.com/u/1808554?v=4)](https://github.com/yangchunhua "yangchunhua (4 commits)")

### Embed Badge

![Health badge](/badges/webpipe-webpipe-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/webpipe-webpipe-sdk/health.svg)](https://phpackages.com/packages/webpipe-webpipe-sdk)
```

###  Alternatives

[aws/aws-sdk-php

AWS SDK for PHP - Use Amazon Web Services in your PHP project

6.2k543.5M2.7k](/packages/aws-aws-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k48](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.3M48](/packages/tencentcloud-tencentcloud-sdk-php)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

293.1k](/packages/eslazarev-wildberries-sdk)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k17](/packages/tempest-framework)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
