Getting Started with the VerseDB API

What it is

The VerseDB API allows developers and users to access comic-related data and interact with features like Collections, Wishlists, Pull Lists, and more — all through a modern RESTful interface.

You can use it to build personal tools, integrations, analytics dashboards, mobile apps, or automate your own data management.

Where to find full API documentation

The full interactive API docs are here:
👉 https://versedb.com/api/docs

This includes all current endpoints, HTTP methods, request payloads, response examples, and authentication details.

Who can use the API

Anyone with a VerseDB account can generate an API token and start using the API.

There are two user tiers:

• Free Users: Access most endpoints, with rate limits appropriate for personal use
• PRO Users: Higher rate limits, priority access, and advanced endpoints

Note: API access requires a verified email address and an active account in good standing.

What's available via the API

Comic Content (Read-only for all users)

• Publishers - Browse publishers and their series
• Titles - Access title records across all volumes
• Series - Get series/volume details with issue lists
• Issues - Full issue metadata including release dates, creators, prices
• Characters - Character profiles, appearances, and relationships
• Creators - Creator biographies, credits, and work history
• Story Arcs - Crossover events and reading orders
• Public profiles - View other users' public collections and lists

User Features (Authenticated - requires API token)

• Collections - View, add, edit, and remove issues from your collection
• Wishlists - Manage your wishlist with full CRUD operations
• Pull List - Track upcoming releases you want to purchase
• Read Status - Mark issues as read, track reading progress
• Title Follows - Follow/unfollow series for notifications
• Reviews - Read reviews (write access coming soon)
• User Profile - Access your own profile data and stats

Advanced Features (PRO users)

• Bulk operations - Add/update multiple items at once
• Advanced search - Complex filtering and queries
• Export data - Download your collection/wishlist as CSV/JSON
• Webhook notifications - Get alerts for new releases (coming soon)

Not available via API (Web UI only)

• User registration/signup - Must use web interface
• Password management - Security handled through web UI
• Submitting reviews - Currently web-only to prevent spam
• Content edit submissions - Database contributions require web UI
• Reporting content - Moderation features web-only
• Admin/moderation features - Staff access only

API Technology

• Protocol: RESTful HTTP/HTTPS
• Authentication: Bearer token (JWT)
• Data format: JSON for all requests and responses
• Versioning: API version in URL path (e.g., /api/v1/...)
• Pagination: Cursor-based for large result sets
• Error handling: Standard HTTP status codes with detailed error messages

Getting Started Steps

1. Log in to VerseDB at versedb.com
2. Navigate to Settings → API section
3. Generate an API token with appropriate permissions
4. Copy your token securely (won't be shown again)
5. Read the docs at versedb.com/api/docs
6. Make your first request using your token for authentication

Quick Notes

• The API uses numeric IDs for all resource endpoints
• Authentication required for personal data access (via Bearer token in header)
• Rate limits apply depending on your account type — see "Understanding API Rate Limits" for details
• All timestamps use ISO 8601 format (e.g., 2025-04-12T01:56:26Z)
• HTTPS only - HTTP requests will be redirected
• API tokens can be revoked and regenerated anytime from settings

Common Use Cases

• Personal dashboard - Build a custom comic tracking dashboard
• Mobile app - Create iOS/Android apps for your collection
• Discord bot - Share pull list updates with friends
• Reading tracker - Integrate with Goodreads-style reading apps
• Collection manager - Desktop app for managing your comics
• Price tracking - Monitor value of issues in your collection
• Statistics - Generate analytics on your reading habits

Security Best Practices

• Never share your API token publicly
• Store tokens securely (use environment variables)
• Regenerate tokens if compromised
• Use minimal permissions needed for your use case
• Implement rate limiting in your client code

🛠 Ready to get started? Visit the full documentation at versedb.com/api/docs and start building!

📚 Next steps: Learn about authentication in the next article: "Authentication & API Tokens"