opensea-api-client

This package was created using the Python OpenAPI for accessing the OpenSea API. This package is not affiliated with OpenSea.

Things to know:

1. Every path/method combo becomes a Python module with four functions:

   1. sync: Blocking request that returns parsed data (if successful) or None.
   2. sync_detailed: Blocking request that always returns a Response, optionally with parsed set if the request was successful.
   3. asyncio: Like sync but async instead of blocking.
   4. asyncio_detailed: Like sync_detailed but async instead of blocking.

2. All path/query params, and bodies become are method arguments.

Usage

First, create a client:

from opensea_api_client import Client

client = Client(base_url="https://api.opensea.io")

If the endpoints you're going to access require authentication, use AuthenticatedClient instead:

from opensea_api_client import AuthenticatedClient

client = AuthenticatedClient(
    base_url="https://api.opensea.io",
    token="SuperSecretToken"
)

A token can be created by applying for developer access (see OpenSea Developer Docs for more information).

Now call your endpoint and use your models:

from opensea_api_client.models import ListCollectionsResponse
from opensea_api_client.api.nft_endpoints import list_collections
from opensea_api_client.types import Response

with client as client:
    my_data: ListCollectionsResponse = list_collections.sync(client=client)
    # or if you need more info (e.g., status_code)
    response: Response[ListCollectionsResponse] = list_collections.sync_detailed(client=client)

Or do the same thing with an async version:

from opensea_api_client.models import ListCollectionsResponse
from opensea_api_client.api.nft_endpoints import list_collections
from opensea_api_client.types import Response

async with client as client:
    my_data: ListCollectionsResponse = await get_my_data_model.asyncio(client=client)
    response: Response[ListCollectionsResponse] = await get_my_data_model.asyncio_detailed(client=client)

By default, when you call an HTTPS API, it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes, you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

client = AuthenticatedClient(
    base_url="https://api.opensea.io",
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

You can also disable certificate validation altogether, but beware that this is a security risk.

client = AuthenticatedClient(
    base_url="https://api.opensea.io", 
    token="SuperSecretToken", 
    verify_ssl=False,
)

Advanced customizations

There are more settings on the generated Client class, which let you control more runtime behavior; check out the docstring on that class for more info. You can also customize the underlying httpx.Client or httpx.AsyncClient (depending on your use case):

from opensea_api_client import Client

def log_request(request):
    print(f"Request event hook: {request.method} {request.url} - Waiting for response")

def log_response(response):
    request = response.request
    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")

client = Client(
    base_url="https://api.opensea.io",
    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
)

# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()

You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):

import httpx
from opensea_api_client import Client

client = Client(base_url="https://api.opensea.io")
# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
client.set_httpx_client(httpx.Client(base_url="https://api.opensea.io", proxies="http://localhost:8030"))