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.
- Documentation
- Installation
- Reference
- Usage
- Migrating From 0 0 41 and Earlier
- A First Request
- Environments
- Async Client
- Using Aiohttp
- Exception Handling
- Pagination
- Verifying User Tokens
- Advanced
- Requirements
- Determining The Installed Version
- Contributing
API reference documentation is available here.
pip install whop_sdkA full reference for this library is available here.
Instantiate and use the client with the following:
fromwhop_sdkimportWhopclient=Whop(
token="<token>",
)
client.access_tokens.create()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 |
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.
fromwhop_sdkimportWhopclient=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.
products.list is paginated and requires the account to list products for.
fromwhop_sdkimportWhopclient=Whop(token="<token>")
forproductinclient.products.list(account_id="biz_xxxxxxxxxxxxxx"):
print(product.id, product.title)This SDK allows you to configure different environments for API requests.
fromwhop_sdkimportWhopfromwhop_sdk.environmentimportWhopEnvironmentclient=Whop(
environment=WhopEnvironment.DEFAULT,
)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).
importasynciofromwhop_sdkimportAsyncWhopclient=AsyncWhop(
token="<token>",
)
asyncdefmain() ->None:
awaitclient.access_tokens.create()
asyncio.run(main())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]'importasynciofromwhop_sdkimportAsyncWhop, DefaultAioHttpClientasyncdefmain() ->None:
client=AsyncWhop(
token="<token>",
httpx_client=DefaultAioHttpClient(),
)
pager=awaitclient.products.list(account_id="biz_xxxxxxxxxxxxxx")
asyncforproductinpager:
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)
...
awaithttp_client.aclose()When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
fromwhop_sdk.core.api_errorimportApiErrortry:
client.access_tokens.create(...)
exceptApiErrorase:
print(e.status_code)
print(e.body)Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.
fromwhop_sdkimportWhopclient=Whop(
token="<token>",
)
client.accounts.list()# You can also iterate through pages and access the typed response per pagepager=client.accounts.list(...)
forpageinpager.iter_pages():
print(page.response) # access the typed response for each pageforiteminpage:
print(item)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 pyjwtfromwhop_sdk.lib.verify_user_tokenimportverify_user_tokenpayload=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;aiohttpis the only one.
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.
fromwhop_sdkimportWhopclient=Whop(...)
response=client.access_tokens.with_raw_response.create(...)
print(response.headers) # access the response headersprint(response.status_code) # access the response status codeprint(response.data) # access the underlying objectThe 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
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
})The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
fromwhop_sdkimportWhopclient=Whop(..., timeout=20.0)
# Override timeout for a specific methodclient.access_tokens.create(..., request_options={
"timeout": 1
})You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
importhttpxfromwhop_sdkimportWhopclient=Whop(
...,
httpx_client=httpx.Client(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)Python 3.10 or higher.
importwhop_sdkprint(whop_sdk.__version__)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!