Skip to main content

aioghost

Async Python client for the Ghost Admin API.

Installation

pip install aioghost

Quick Start

import asyncio
from aioghost import GhostAdminAPI

async def main():
    async with GhostAdminAPI(
        api_url="https://your-site.ghost.io",
        admin_api_key="your-admin-api-key"
    ) as api:
        # Get site info
        site = await api.get_site()
        print(f"Site: {site['title']}")

        # Get member counts
        members = await api.get_members_count()
        print(f"Total members: {members['total']}")
        print(f"Paid members: {members['paid']}")

        # Get MRR
        mrr = await api.get_mrr()
        print(f"MRR: ${mrr.get('usd', 0) / 100:.2f}")

asyncio.run(main())

Features

  • Fully async — Built on aiohttp for non-blocking I/O
  • Type hints — Full type annotations for IDE support
  • Context manager — Automatic session cleanup with async with
  • Parallel requests — Uses asyncio.gather() for efficient batching
  • Proper exceptions — Typed exceptions for different error cases

API Coverage

Endpoint Method
Site info get_site()
Posts count get_posts_count()
Latest post get_latest_post()
Members count get_members_count()
MRR get_mrr()
Newsletters get_newsletters()
Latest email get_latest_email()
Comments count get_comments_count()
Tiers get_tiers()
ActivityPub stats get_activitypub_stats()
Webhooks create_webhook(), delete_webhook()
Validate credentials validate_credentials()

Getting Your Admin API Key

  1. Log in to your Ghost Admin panel
  2. Go to Settings → Integrations
  3. Click Add custom integration
  4. Copy the Admin API Key (format: id:secret)

Exceptions

from aioghost import (
    GhostError,           # Base exception
    GhostAuthError,       # Invalid API key
    GhostConnectionError, # Network error
    GhostNotFoundError,   # 404 response
    GhostValidationError, # Invalid request
)

Passing Your Own Session

If you want to reuse an existing aiohttp.ClientSession:

import aiohttp
from aioghost import GhostAdminAPI

async def main():
    async with aiohttp.ClientSession() as session:
        api = GhostAdminAPI(
            api_url="https://your-site.ghost.io",
            admin_api_key="your-key",
            session=session,
        )
        site = await api.get_site()
        # Session is NOT closed when api goes out of scope

 

Copyright & license

Copyright (c) 2013-2026 Ghost Foundation - Released under the MIT license. Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our trademark policy for info on acceptable usage.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aioghost-0.4.22.tar.gz (95.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aioghost-0.4.22-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file aioghost-0.4.22.tar.gz.

File metadata

  • Download URL: aioghost-0.4.22.tar.gz
  • Upload date:
  • Size: 95.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aioghost-0.4.22.tar.gz
Algorithm Hash digest
SHA256 d65645f09686b9a6f0702bac6407e339ddc3c6352aef41f8a760f7e8801b03f1
MD5 e41db99878d4d183d61290bb140941d3
BLAKE2b-256 666f1cfc9189b00bbb0926770823f4687360f9b73bcac5739487d40ac0eff6c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for aioghost-0.4.22.tar.gz:

Publisher: publish.yml on TryGhost/aioghost

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aioghost-0.4.22-py3-none-any.whl.

File metadata

  • Download URL: aioghost-0.4.22-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aioghost-0.4.22-py3-none-any.whl
Algorithm Hash digest
SHA256 6a8cc1d8dba9aab2244272032ce0bdf2b79b0c04f99f8cb178f83ce93749acb4
MD5 7f82d93cffe95981fb9b6f89a011eb40
BLAKE2b-256 5381e1a953a2d7d4bc328528ed170d69ef1500d24547c9b8a19a8b92e0108858

See more details on using hashes here.

Provenance

The following attestation bundles were made for aioghost-0.4.22-py3-none-any.whl:

Publisher: publish.yml on TryGhost/aioghost

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.4.24

2 files

0.4.23

2 files

This release

0.4.22 This release

2 files

0.4.21

2 files

0.4.20

2 files

0.4.19

2 files

0.4.18

2 files

0.4.17

2 files

0.4.16

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page