Skip to main content

Python client for the Pkmn Prices API

Project description

pkmnprices

Python client for the Pkmn Prices API. Pokemon TCG card pricing from TCGPlayer, Cardmarket, and eBay.

Sync and async clients, both built on httpx. Typed responses, typed errors, and iterators that page through results for you. Python 3.10+.

Install

pip install pkmnprices

Usage

from pkmnprices import PkmnPrices

client = PkmnPrices("pk_your_key_here")

page = client.cards.list(name="charizard", per_page=10)

card = client.cards.get(page.data[0].id)
for price in card.prices:
    symbol = "€" if price.currency == "EUR" else "$"
    print(f"{price.source}: {symbol}{price.market_price}")

client.close()

The client is also a context manager:

with PkmnPrices("pk_...") as client:
    health = client.health()

Async

import asyncio
from pkmnprices import AsyncPkmnPrices

async def main():
    async with AsyncPkmnPrices("pk_...") as client:
        page = await client.cards.list(name="charizard")
        async for card in client.cards.iterate(name="charizard"):
            print(card.name)

asyncio.run(main())

Get an API key from https://pkmnprices.com/dashboard.

Options

PkmnPrices(
    "pk_...",         # API key, sent as the x-api-key header
    max_retries=2,    # retries on 429 rate limits and 5xx/network errors
    timeout=30.0,     # per-request timeout in seconds
)

Rate-limit 429s are retried with backoff. Credit-limit 429s (credit_limit_exceeded) are not, since they don't reset until the next day.

Pagination

List endpoints return a Page (.data, .pagination). Listing endpoints (eBay/Cardmarket) return a CursorPage. Both resources expose iterators so you don't track pages or cursors:

for card in client.cards.iterate(name="charizard"):
    print(card.name)

all_sets = client.sets.list_all(language="english")

for sale in client.cards.listings.iterate_ebay(789, grader="PSA", grade="10"):
    print(sale.title, sale.price)

Currency

Every price has a currency field. Pass currency="usd" or currency="eur" to filter, or leave it off to get everything your plan allows. EUR (Cardmarket) prices need a Pro plan; a free key asking for eur raises ForbiddenError.

card = client.cards.get(789, currency="usd")

Errors

Everything raised subclasses PkmnPricesError, which carries status, code, rate_limit, and retry_after.

from pkmnprices import ForbiddenError, NotFoundError, RateLimitError

try:
    client.cards.get(789, currency="eur")
except ForbiddenError:
    ...  # needs a higher plan
except NotFoundError:
    ...  # no such card
except RateLimitError:
    ...  # ran out of retries

Subclasses: BadRequestError (400), UnauthorizedError (401), ForbiddenError (403), NotFoundError (404), ConflictError (409), CreditLimitError and RateLimitError (429), InternalServerError (5xx), APIConnectionError (network/timeout).

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pkmnprices-1.0.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pkmnprices-1.0.1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file pkmnprices-1.0.1.tar.gz.

File metadata

  • Download URL: pkmnprices-1.0.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pkmnprices-1.0.1.tar.gz
Algorithm Hash digest
SHA256 7426fe9d3df0934034b56746e1bc4667f4f430d7495181422cf22577856ef66d
MD5 469e1b03c95c30c7a668d8eaa992ccf2
BLAKE2b-256 da89b53bef722060d852c8d35054a4fff1b0de83509f5a2657326d78a5eeb9e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pkmnprices-1.0.1.tar.gz:

Publisher: publish.yml on preaverage/pkmnprices-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pkmnprices-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pkmnprices-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pkmnprices-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee661bf97b4b350c4d27946564fb1169fb07303e6584023dffaeb617bb455fcb
MD5 37ec2d6edf4377971bd3e621298c70c6
BLAKE2b-256 1de1de6c1583cfaec0f5c189f9d12463d8d4a2beedcf822753f3927e392b0ff5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pkmnprices-1.0.1-py3-none-any.whl:

Publisher: publish.yml on preaverage/pkmnprices-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page