crawlora-brave — Brave Search API client for Python

Python client for Crawlora's hosted Brave Search API. It exposes 5 API endpoints covering web, news, image, and video search plus query suggestions. Requests go to Crawlora; the package does not run a browser or scrape Brave Search locally. A Crawlora account and CRAWLORA_API_KEY are required, and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by Brave Search or its owners.

Install

python -m pip install crawlora-brave

Get an API key

Create an account at crawlora.net, then open the Crawlora console for API-key setup. Set your key in the shell before running the client:

export CRAWLORA_API_KEY="your-crawlora-api-key"

Use

Save this example as example.py, then run python example.py after installing the package and setting your API key.

import os

from crawlora_brave import BraveClient

api_key = os.environ.get("CRAWLORA_API_KEY")
if not api_key:
    raise RuntimeError("Set CRAWLORA_API_KEY before running this example.")

with BraveClient(api_key=api_key) as client:
    result_1 = client.search(q='open source web crawler')
    print(result_1)
    result_2 = client.suggest(q='open source')
    print(result_2)

The package also exports Client as an alias for BraveClient. Operation methods are available directly in snake_case and through the brave group. The async package client is AsyncBraveClient; see the online endpoint and parameter reference and runnable example.

Async usage

The package also exports AsyncClient for asynchronous requests:

import asyncio
import os

from crawlora_brave import AsyncClient

async def main():
    api_key = os.environ.get("CRAWLORA_API_KEY")
    if not api_key:
        raise RuntimeError("Set CRAWLORA_API_KEY before running this example.")
    async with AsyncClient(api_key=api_key) as client:
        result_1 = await client.search(q='open source web crawler')
        print(result_1)

asyncio.run(main())

See the runnable example for a complete usage example.

Supported Brave Search API endpoints

This package exposes every route below through direct snake_case methods and the brave group. See the endpoint and parameter reference for complete input details.

Configuration

Pass your key through api_key or read CRAWLORA_API_KEY from the environment. Keep credentials out of source control and logs. Requests go to Crawlora's hosted API.