PyPriceCharting API Client

PriceCharting API Client written in Python

Setup

Project supports local development and VSCode Dev container development

Local Development Installation

Note: Project uses uv and just to manage project configuration and commands

• Install just - brew install just
• Set up project - just setup
  • Installs Homebrew dependencies (gitleaks, just, uv, zizmor)
  • Installs prek git hooks
  • Syncs project dependencies

VS Code Dev Container

• Install Docker
• Install VSCode
• Open project folder in VS Code
• Reopen in container using Remote Development Container menu

Project Commands

• just setup - install tools and git hooks, then sync dependencies
• just sync - sync project dependencies
• just build - build the sdist and wheel into dist/
• just lint - type check (ty), lint and format (ruff), and spellcheck (codespell). Fixes files in place
• just ci-lint - same checks as just lint, without modifying files
• just test - run unit tests
• just prek - run all pre-commit hooks
• just git-leaks - scan staged changes for secrets
• just zizmor - audit GitHub Actions workflows for security issues
• just docs - serve the docs site locally with live reload
• just docs-build - build the docs site into site/ in strict mode
• uv add {package} - install a dependency

Pre-commit Hooks

prek runs these hooks on commit (configured in prek.toml):

• Built-in checks: trailing whitespace, end of file, large files, YAML, and JSON
• just ci-lint
• just test
• gitleaks secret scan of staged changes

CI

See CI.md for the GitHub Actions workflows and Dependabot setup.

Documentation

The docs site is built with Zensical from mkdocs.yml and the pages in docs/. API reference pages are generated from docstrings with mkdocstrings. The docs.yml workflow deploys the site to GitHub Pages on every push to main.

Releases

Releases are published to GitHub Releases and to PyPI by the Release workflow. See RELEASE.md for how releases and release labels work.

Usage

Both clients have a method for every Prices API and Marketplace API operation.

from pypricecharting import AsyncPriceCharting, PriceCharting

with PriceCharting("<40-character API token>") as client:
    game = client.product(id="6910")
    print(game.product_name, game.cib_price)  # prices are in pennies

async with AsyncPriceCharting("<40-character API token>") as client:
    game = await client.product(q="earthbound")
    results = await client.products("chrono trigger")  # up to 20 matches

Without a token argument, the token is read from PRICECHARTING_TOKEN. See the docs site for errors and client options.

Supporting Files

Project contains an OpenAPI spec and a Bruno project for easy testing and mocking

• ./bruno - Bruno project
• ./open_api - OpenAPI spec

TODO / Investigate

• Offer details price limits - OfferDetailsResponse reads price-max and price-min, the names in the documentation's key table. If the API sends max-price and min-price instead, price_max and price_min come back as None with no error. Validate /api/offer-details
• Extra Marketplace keys - pending-reason, seller-id, image-url, best-competing-price, is-best-priced-offer and value are only on OfferDetailsResponse. The documentation doesn't say which endpoint returns each one. If /api/offers returns any of them, add them to Offer