Getting Started with the VerseDB API

The VerseDB API lets developers access comic data and interact with features like Collections, User Lists, Pull Lists, and more through a RESTful interface.

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

Full API Documentation

The full interactive API docs are at: 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.

Tier Read Requests Write Requests
Free 300/hour 150/hour
PRO 1000/hour 500/hour
Note
API access requires a verified email address and an active account in good standing.

What's Available

Core Resources (Free Tier)

All list and detail endpoints for:

  • Publishers - Browse publishers and their series
  • Titles - Access title records across all volumes
  • Series - Get series/volume details
  • Issues - Full issue metadata including release dates, creators, prices
  • Characters - Character profiles and information
  • Creators - Creator biographies and work history
  • Story Arcs - Crossover events and reading orders
  • Teams - Team information and members
  • Comic Shops - Shop locations and details
  • User Lists - Browse and view public lists

Discovery Endpoints (Free Tier)

  • FOC Issues - Issues with Final Order Cutoff coming up
  • Upcoming Firsts - Upcoming first appearances

Relationship Data (PRO Only)

Warning
These endpoints return HTTP 402 for non-PRO users.
  • Issue Variants, Series to Issues, Series to Creators/Characters
  • Issues to Creators/Characters, Story Arc relationships
  • Team relationships

Market Data (PRO Only)

  • Listings, Price Snapshots, Estimated Values

User Features (Authenticated)

Requires specific token scopes:

  • Collections - View, add, edit, remove issues (scope: lists:collection)
  • User Lists - Manage wishlists and custom lists (scope: lists:user_lists)
  • Pull List - Track series (scope: lists:pulllist)
  • Read Status - Track reading progress (scope: lists:read)
  • Following - Follow/unfollow titles, characters (scope: lists:follow)
  • User Profile - Access your own data (scope: read:self)

API Technology

  • Protocol: RESTful HTTP/HTTPS
  • Authentication: Bearer token (Sanctum)
  • Data format: JSON
  • Base URL: https://versedb.com/api
  • Pagination: Page-based with page and limit parameters (max 50 per page)
Note
All API endpoints require authentication. There is no anonymous public access.

Getting Started

  1. Log in to VerseDB
  2. Navigate to Settings > API Tokens
  3. Generate an API token with the scopes you need
  4. Copy your token securely (it won't be shown again)
  5. Read the docs at versedb.com/api/docs
  6. Make your first request with your token in the Authorization header

Token Scopes

Scope Permission
read:public Public content (default)
read:self Your own profile
lists:follow Follow titles/characters
lists:pulllist Pull list management
lists:collection Collection management
lists:read Read status tracking
lists:user_lists User lists and wishlist

Common Use Cases

  • Personal dashboard for comic tracking
  • Mobile apps for your collection
  • Discord bots for pull list updates
  • Reading tracker integrations
  • Collection statistics and analytics

Security Best Practices

Tip
- Never share your API token publicly - Store tokens in environment variables - Regenerate tokens if compromised - Use minimal scopes needed for your use case