Installation

Install the listingsAPI Python SDK with pip, set up a virtual environment, and verify your setup.

Requirements

  • Python 3.9 or later
  • pip 21+

Install

bash
pip install listingsapi

The package is published as listingsapi on PyPI. Its only runtime dependency is requests, which pip pulls in automatically; no extra install step is needed.

bash
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install listingsapi

Pin the version

bash
pip install "listingsapi==0.5.0"

Or add it to your requirements.txt:

bash
listingsapi==0.5.0

Or pyproject.toml:

bash
dependencies = [
"listingsapi>=0.5,<1.0",
]

Verify

Python
import listingsapi
print(listingsapi.__version__)

You should see 0.5.0 (or the version you installed).

Next steps