API

We have an initial version of an API on the site. While the API endpoints URLs are stable, the provided fields and data format should not be considered stable as this point.

Currently the API is accessible for anonymous users with some limits on the number of accesses per hour and as a logged in hours with some larger limits. This will likely change, e.g., the anonymous access will likely bye turned off at some point.

The access points are via /api/ https://www.comics.org/api/

Series

A list of all series can be accessed via https://www.comics.org/api/series/

Searches for series names can be done via https://www.comics.org/api/series/name/<name>/ which searches for series containing <name>
e.g. https://www.comics.org/api/series/name/Batman/ and further filter using the series beginning year https://www.comics.org/api/series/name/Batman/year/2000/

A series can be accessed using its <id> https://www.comics.org/api/series/<id> e.g. https://www.comics.org/api/series/7096/

The data contains the main data of a series, including list of issue IDs and of issue descriptors.

Issues

Issues can be accessed via its series or searched using <name> and <number> via https://www.comics.org/api/series/name/<name>/issue/<number/ e.g. https://www.comics.org/api/series/name/Batman/issue/12/ and also using the issue year via its key_date-field, if existing, https://www.comics.org/api/series/name/Batman/issue/12/year/2000/

An issue is accessed using its <id> https://www.comics.org/api/issue/<id> e.g. https://www.comics.org/api/issue/256114/

The issue data contains main data of a series, including the stories with credits and the cover URL. The credits and characters are given as text in case of linked data.

Future Work

We might want additional data or access points / searches.

The code is at https://github.com/GrandComicsDatabase/gcd-django/tree/beta/apps/api

It should be straightforward for you to extend the code with further searches and data.