Method root

blockfrost/api/__init__.py:22–37

Root endpoint has no other function than to point end users to documentation. https://docs.blockfrost.io/#tag/health/GET/ :param return_type: Optional. "object", "json" or "pandas". Default: "object". :type return_type: str :returns RootResponse object.

(self, **kwargs)

    @request_wrapper
    def root(self, **kwargs):
        """
        Root endpoint has no other function than to point end users to documentation.

        https://docs.blockfrost.io/#tag/health/GET/
        :param return_type: Optional. "object", "json" or "pandas". Default: "object".
        :type return_type: str
        :returns RootResponse object.
        :rtype RootResponse
        :raises ApiError: If API fails
        :raises Exception: If the API response is somehow malformed.
        """
        return requests.get(
            url=f"{self.url}/",
            headers=self.authentication_header
        )

    from .health import \
        health, \