animedex.api.ghibli

animedex api ghibli raw passthrough.

The live Studio Ghibli API is a free, anonymous JSON API covering films, people, locations, species, and vehicles from Studio Ghibli productions. The high-level animedex.backends.ghibli module reads a bundled snapshot instead; this raw passthrough exists for callers who explicitly want the current live upstream.

Backend: Studio Ghibli API (ghibliapi.vercel.app).

Rate limit: not formally published; the transport applies a conservative 1 req/sec sustained ceiling with a 5-token burst budget.

— LLM Agent Guidance — Common read paths: /films, /people, /locations, /species, and /vehicles; append /<id> for single-record reads. The raw method argument is forwarded verbatim. Prefer the high-level animedex ghibli commands when the bundled snapshot is sufficient: those commands are offline, deterministic, and do not consume upstream capacity. Use this raw passthrough when the user explicitly asks for live data. — End —

call

animedex.api.ghibli.call(path: str, *, method: str = 'GET', headers: Dict[str, str] | None = None, params: dict | None = None, no_cache: bool = False, cache_ttl: int | None = None, rate: str = 'normal', follow_redirects: bool = True, user_agent: str | None = None, timeout_seconds: float | None = None, cache=None, session=None, rate_limit_registry=None, config=None) RawResponse[source]

Issue a live Studio Ghibli API request and return its envelope.

Parameters:
  • path (str) – URL path under ghibliapi.vercel.app. Examples: /films, /people, /locations, /species, /vehicles.

  • headers (dict or None) – Extra request headers.

  • params (dict or None) – Query-string parameters, when the upstream accepts them.

Returns:

Wire envelope including body, status, headers, redirect chain, request snapshot, timing breakdown, and cache provenance.

Return type:

animedex.api._envelope.RawResponse

selftest

animedex.api.ghibli.selftest() bool[source]

Smoke-test the Studio Ghibli API passthrough.

Exercises the shared shim checks: the public call signature retains the cross-cutting transport kwargs.

Returns:

True on success; raises on contract drift.

Return type:

bool