Shared HTTPx client session

If you already use HTTPx and utilised a shared client session, you may pass this to the Openverse client constructors.

from openverse_api_client import OpenverseClient
import httpx

httpx_client = httpx.Client()

openverse = OpenverseClient(
    httpx_client=httpx_client,
)

The same API applies for the asynchronous Openverse client, but requires httpx.AsyncClient instead.

When using a shared HTTPx client session do not call close on the Openverse client as this will close the shared HTTPx instance. Likewise, do not use the Openverse client context manager if passing in a shared client, the context manager will close your shared HTTPx client on context exit.

Authentication

By default, the clients will make unauthenticated requests. Pass client_id and client_secret to the client constructor to authenticate requests. The client automatically handles requesting tokens and token expiration.

from openverse_api_client import OpenverseClient

# The same API applies to the async client
authenticated_openverse = OpenverseClient(
    client_id="...",
    client_secret="...",
)

Alternative Openverse API instances

The clients reference the official production Openverse API instance by default, https://api.openverse.engineering. If you would like to send requests to a different API instance, pass base_url to the constructor:

from openverse_api_client import OpenverseClient

# The same API applies to the async client
localhost_openverse = OpenverseClient(
    base_url="localhost:50280",
)