Docs
Agents and SDKs

SDKs and OpenAPI

Install the official Berrycrawl SDK in TypeScript, Python, Go, Ruby, PHP, Java, .NET, Swift, or Rust.

Berrycrawl publishes official SDKs for nine languages. Every SDK uses the same bc_ API key and defaults to https://api.berrycrawl.com/api/v1.

LanguageInstallSource
TypeScriptnpm install berrycrawlberrycrawl-typescript
Pythonpip install berrycrawlberrycrawl-python
Gogo get github.com/strawberry-labs/berrycrawl-goberrycrawl-go
Rubygem install berrycrawlberrycrawl-ruby
PHPcomposer require strawberry-labs/berrycrawlberrycrawl-php
Javacom.berrycrawl:berrycrawlberrycrawl-java
.NETdotnet add package Berrycrawlberrycrawl-dotnet
SwiftAdd https://github.com/strawberry-labs/berrycrawl-swift in SwiftPMberrycrawl-swift
Rustcargo add berrycrawlberrycrawl-rust

Quickstart

import { Berrycrawl } from "berrycrawl";

const berrycrawl = new Berrycrawl({
  apiKey: process.env.BERRYCRAWL_API_KEY,
});

const page = await berrycrawl.scrape({ url: "https://example.com" });
import os
from berrycrawl import Berrycrawl

berrycrawl = Berrycrawl(api_key=os.environ["BERRYCRAWL_API_KEY"])
page = berrycrawl.scrape(url="https://example.com")

Each SDK repository contains installation instructions, synchronous and asynchronous examples where supported, error handling, retries, custom environments, and examples for every Berrycrawl endpoint.

Contract and generation

The canonical SDK contract is backend/openapi.sdk.json in the main repository. The downloadable openapi.agent.json exposes the same public endpoints for agents and direct HTTP clients. Dashboard, admin, billing, internal authentication, and operational routes are excluded.

Berrycrawl generates SDK source locally with Fern's open-source generators:

pnpm openapi:export
pnpm sdk:check
pnpm sdk:generate

The main repository does not use Fern Cloud, a Fern token, or Fern-hosted publishing. Generated source is pushed to the nine public SDK repositories and published by Strawberry Labs-owned GitHub Actions workflows.

Direct HTTP clients

You do not need an SDK to call Berrycrawl. Any HTTP client that supports bearer authentication and JSON works.

The API Reference is generated from the same public document, so reference pages and generated clients describe one contract.