Metadata-Version: 2.4
Name: crawlora-ebay
Version: 0.1.1
Summary: Crawlora eBay API client with 10 endpoints for listing search, item details, seller profiles, feedback and shops, and eBay Live streams
Author: Crawlora
License-Expression: MIT
Project-URL: Homepage, https://crawlora.net/?utm_source=pypi&utm_medium=referral&utm_campaign=platform-clients&utm_content=ebay-python-homepage
Project-URL: Documentation, https://crawlora.net/docs?utm_source=pypi&utm_medium=referral&utm_campaign=platform-clients&utm_content=ebay-python-api-docs
Project-URL: Repository, https://github.com/Crawlora-org/crawlora-ebay
Keywords: crawlora,api-client,sdk,web-scraping,scraping-api,ebay,ebay-api,ebay-scraper,ebay-data,ebay-listing-search,ebay-item-details,ebay-seller-profiles,ebay-feedback-shops,ebay-live-streams
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions>=4.7; python_version < "3.11"
Provides-Extra: async
Requires-Dist: httpx>=0.27; extra == "async"
Provides-Extra: test
Requires-Dist: mypy>=1.11; extra == "test"
Requires-Dist: pytest>=8; extra == "test"
Dynamic: license-file

# crawlora-ebay — eBay API client for Python

Python client for Crawlora's hosted eBay API. It exposes 10 API endpoints covering listing search, item details, seller profiles, feedback and shops, and eBay Live streams. Requests go to [Crawlora](https://crawlora.net/?utm_source=pypi&utm_medium=referral&utm_campaign=platform-clients&utm_content=ebay-python-homepage); the package does not run a browser or scrape
eBay 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
eBay or its owners.

## Install

```sh
python -m pip install crawlora-ebay
```

## Get an API key

Create an account at [crawlora.net](https://crawlora.net/signup?utm_source=pypi&utm_medium=referral&utm_campaign=platform-clients&utm_content=ebay-python-signup), then open the [Crawlora console](https://crawlora.net/app?utm_source=pypi&utm_medium=referral&utm_campaign=platform-clients&utm_content=ebay-python-console) for API-key setup. Set your key in the shell before running the client:

```sh
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.

```python
import os

from crawlora_ebay import EbayClient

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

with EbayClient(api_key=api_key) as client:
    result_1 = client.seller(seller='musicmagpie')
    print(result_1)
    result_2 = client.search(option={'keyword': 'vintage camera'})
    print(result_2)
```

The package also exports `Client` as an alias for `EbayClient`. Operation
methods are available directly in snake_case and through the `ebay`
group. The async package client is `AsyncEbayClient`; see the [online
endpoint and parameter reference](https://github.com/Crawlora-org/crawlora-ebay/blob/main/docs/usage.md) and [runnable example](https://github.com/Crawlora-org/crawlora-ebay/blob/main/examples/python.py).

### Async usage

The package also exports `AsyncClient` for asynchronous requests:

```python
import asyncio
import os

from crawlora_ebay 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.seller(seller='musicmagpie')
        print(result_1)

asyncio.run(main())
```

See the [runnable example](https://github.com/Crawlora-org/crawlora-ebay/blob/main/examples/python.py) for a complete usage example.

## Supported eBay API endpoints

This package exposes every route below through direct snake_case methods and the `ebay` group. See the [endpoint and parameter reference](https://github.com/Crawlora-org/crawlora-ebay/blob/main/docs/usage.md) for complete input details.

| Method | Endpoint | API operation | Description |
| --- | --- | --- | --- |
| `GET` | `/ebay/item/{item_id}` | `ebay-item` | Get eBay item details |
| `GET` | `/ebay/live/streams` | `ebay-live-streams` | List eBay Live streams |
| `GET` | `/ebay/live/streams/batch` | `ebay-live-streams-batch` | Get multiple eBay Live streams |
| `GET` | `/ebay/live/streams/{id}` | `ebay-live-stream` | Get an eBay Live stream |
| `GET` | `/ebay/live/streams/{id}/items` | `ebay-live-stream-items` | List an eBay Live stream's featured items |
| `POST` | `/ebay/search` | `ebay-search` | Search eBay listings |
| `GET` | `/ebay/seller/{seller}` | `ebay-seller` | Get eBay seller profile |
| `GET` | `/ebay/seller/{seller}/about` | `ebay-seller-about` | Get eBay seller about details |
| `GET` | `/ebay/seller/{seller}/feedback` | `ebay-seller-feedback` | Get eBay seller feedback |
| `GET` | `/ebay/seller/{seller}/shop` | `ebay-seller-shop` | Get eBay seller shop listings |

## 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.
