Skip to main content

Whop Python Library

fern shield pypi

The Whop SDK gives you typed access to the Whop API. Pass your API key to the client explicitly — the SDK reads no environment variables, so a client built without a key sends unauthenticated requests and the API answers 401.

Table of Contents

Documentation

API reference documentation is available here.

Installation

pip install whop_sdk

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from whop_sdk import Whop

client = Whop(
    token="<token>",
)

client.access_tokens.create()

Migrating from 0.0.41 and earlier

Releases up to and including 0.0.41 were generated by Stainless. 1.0.0 onwards is generated by Fern, and the constructor is not source-compatible with what came before — which is why the line left 0.0.x.

Was Now
Whop(api_key=...) Whop(token=...) — accepts a str or a Callable[[], str]
Whop(version=...) Whop(api_version_date=...), default "2026-08-21"
Whop(default_headers={...}) Whop(headers={...})
Whop(http_client=...) Whop(httpx_client=...)
Whop(webhook_key=...), Whop(app_id=...) removed — no constructor equivalent
WHOP_API_KEY and friends in the environment removed — see below
client.with_options(max_retries=5).x.y() client.x.y(..., request_options={"max_retries": 5})
whop_sdk.APIStatusError, RateLimitError, ... whop_sdk.core.api_error.ApiError and the typed subclasses at the package root
model.to_json() / model.to_dict() Pydantic's model.model_dump_json() / model.model_dump()
client.webhooks.unwrap(...) removed
api.md reference.md

There is no environment-variable fallback

The client reads no environment variables. Setting WHOP_API_KEY has no effect, and Whop() with no token builds successfully and then sends unauthenticated requests, so the first sign of the mistake is a 401 from the API rather than an error at construction time.

from whop_sdk import Whop

client = Whop(
    token="<token>",
    # Optional; both have working defaults.
    base_url="https://api.whop.com/api/v1",
    api_version_date="2026-08-21",
)

Every parameter is keyword-only.

A first request

products.list is paginated and requires the account to list products for.

from whop_sdk import Whop

client = Whop(token="<token>")

for product in client.products.list(account_id="biz_xxxxxxxxxxxxxx"):
    print(product.id, product.title)

Environments

This SDK allows you to configure different environments for API requests.

from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    environment=WhopEnvironment.DEFAULT,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from whop_sdk import AsyncWhop

client = AsyncWhop(
    token="<token>",
)


async def main() -> None:
    await client.access_tokens.create()


asyncio.run(main())

Using aiohttp

AsyncWhop uses httpx by default. To run it on aiohttp instead, install the aiohttp extra and pass DefaultAioHttpClient as the httpx_client:

pip install 'whop-sdk[aiohttp]'
import asyncio

from whop_sdk import AsyncWhop, DefaultAioHttpClient


async def main() -> None:
    client = AsyncWhop(
        token="<token>",
        httpx_client=DefaultAioHttpClient(),
    )
    pager = await client.products.list(account_id="biz_xxxxxxxxxxxxxx")
    async for product in pager:
        print(product.id, product.title)


asyncio.run(main())

DefaultAioHttpClient is importable without the extra, but raises RuntimeError when constructed.

Neither Whop nor AsyncWhop is a context manager and neither exposes a close(), so there is no with / async with form. To shut the transport down cleanly — otherwise aiohttp warns about an unclosed session at exit — keep a reference to the client you passed in and close that:

http_client = DefaultAioHttpClient()
client = AsyncWhop(token="<token>", httpx_client=http_client)
...
await http_client.aclose()

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from whop_sdk.core.api_error import ApiError

try:
    client.access_tokens.create(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Pagination

Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.

from whop_sdk import Whop

client = Whop(
    token="<token>",
)

client.accounts.list()
# You can also iterate through pages and access the typed response per page
pager = client.accounts.list(...)
for page in pager.iter_pages():
    print(page.response)  # access the typed response for each page
    for item in page:
        print(item)

What a pager exposes

The pager is not the response body. It carries items (this page only), has_next, next_page(), and iter_pages(), and iterating the pager itself walks every page. The decoded response — data and page_info — is on pager.response:

from whop_sdk import Whop

client = Whop(token="<token>")
pager = client.products.list(account_id="biz_xxxxxxxxxxxxxx")

print(pager.response.page_info.has_next_page)
print(pager.response.data)  # this page's items, as returned by the API
print(pager.items)          # the same items, off the pager

SyncPager and AsyncPager live in whop_sdk.core.pagination; they are not exported from the package root.

Verifying user tokens

verify_user_token checks the x-whop-user-token JWT that Whop sends to an embedded app. It is hand-written rather than generated, and it is the only part of this package that needs a dependency the package does not declare — install pyjwt yourself:

pip install pyjwt
from whop_sdk.lib.verify_user_token import verify_user_token

payload = verify_user_token(request.headers, app_id="app_xxxxxxxxxxxxxx")
print(payload.user_id)

It accepts either the raw token or a headers mapping, and takes optional public_key, jwks_url, and header_name overrides. By default it fetches Whop's public signing keys from https://api.whop.com/.well-known/jwks.json and caches them in-process.

The module docstring suggests pip install 'whop-sdk[user-tokens]'. That extra does not exist on the published distribution; aiohttp is the only one.

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from whop_sdk import Whop

client = Whop(...)
response = client.access_tokens.with_raw_response.create(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.access_tokens.create(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from whop_sdk import Whop

client = Whop(..., timeout=20.0)

# Override timeout for a specific method
client.access_tokens.create(..., request_options={
    "timeout": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from whop_sdk import Whop

client = Whop(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Requirements

Python 3.10 or higher.

Determining the installed version

import whop_sdk

print(whop_sdk.__version__)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Download files

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

Source Distribution

whop_sdk-1.0.12.tar.gz (971.1 kB view details)

Uploaded Source

Built Distribution

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

whop_sdk-1.0.12-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file whop_sdk-1.0.12.tar.gz.

File metadata

  • Download URL: whop_sdk-1.0.12.tar.gz
  • Upload date:
  • Size: 971.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for whop_sdk-1.0.12.tar.gz
Algorithm Hash digest
SHA256 105a86b05fc0a71c7b3332e664ad02b79f4ad02079406a1cf838e389f833ddf3
MD5 bd1abc7a4258f57ad20810d8a77a53c0
BLAKE2b-256 99b41c8792c685a68a194d1726e11708bf6e99a38953a7f8218947562d44276b

See more details on using hashes here.

File details

Details for the file whop_sdk-1.0.12-py3-none-any.whl.

File metadata

  • Download URL: whop_sdk-1.0.12-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for whop_sdk-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 66b0fc9eba53b605244a9fca30c6fe29df6dedd9af5869383806d9deaea81ef1
MD5 af8116a28e67e3e50601c5c3c218d17c
BLAKE2b-256 9fa77816fbebb94d70b1ac14095d6b61d63230f98b0067a9d3231c434a0be899

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.13

2 files

This release

1.0.12 This release

2 files

1.0.11

2 files

0.0.41

2 files

0.0.40

2 files

0.0.39

2 files

0.0.38

2 files

0.0.37

2 files

0.0.36

2 files

0.0.35

2 files

0.0.34

2 files

0.0.33

2 files

0.0.32

2 files

0.0.30

2 files

0.0.29

2 files

0.0.28

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

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