API Documentation - longbox - A place for your comics

The API is currently in development and is subject to change.

API Documentation

# Comic API

Access comic book information with lots of available parameters for filtering and a few "quick endpoints" to fetch common sets of data.


/api/v1/releases

Fetch releases for the current release week
Parameter Type Description Default
date string Date of releases week. NOTE: Release weeks are Wednesday to Tuesday. now
format integer Format ID that you want to filter to See formats for format IDs N/A
variants string You can decide if you want to include variants in the results or optionally only show variants. Options: include, exclude, or only exclude
publisher integer ID of a publisher. Providing a publisher will filter the results to those belonging to a specific publisher. N/A
series integer Providing a series will filter the results to those belonging to a specific series. N/A
orderBy string Determine how to sort the results Options: alphabetical or popularity popularity
page integer Since the results are paginated, passing a page number will set the current page in the results. 1
count integer Since the results are paginated, passing a count will set the number of results for each page of results
Sample Response
// TODO

/api/v1/issues

Fetch issues
Parameter Type Description Default
format integer Format ID that you want to filter to See formats for format IDs 1 (comics)
publisher integer ID of a publisher. Providing a publisher will filter the results to those belonging to a specific publisher. N/A
series integer Providing a series will filter the results to those belonging to a specific series. N/A
issueNo integer Only return issues with the passed issueNo N/A
variants string You can decide if you want to include variants in the results or optionally only show variants. Options: include, exclude, or only exclude
orderBy string How to order the results Accepts: publishDate or issueNo publishDate
page integer Since the results are paginated, passing a page number will set the current page in the results. 1
count integer Since the results are paginated, passing a count will set the number of results for each page of results 54
Sample Response
// TODO

/api/v1/issue/{stockNo}

Fetch issues
Parameter Type Description Default
This method takes no parameters
Sample Response
// TODO

/api/v1/issue/{stockNo}/rate

Rate an issue
Parameter Type Description Default
rating integer A rating, between 1 and 5 N/A
Sample Response
// TODO

/api/v1/series

Fetch series
Parameter Type Description Default
publisher integer ID of a publisher. Providing a publisher will filter the results to those belonging to a specific publisher. N/A
format integer Format ID that you want to filter to See formats for format IDs N/A
active string Filter by the series' "active" state Accepts: active, upcoming, or all active
title string Do a simple search for a title N/A
startsAfter date/string Filter to series that start after a given date N/A
startsBefore date/string Filter to series that start before a given date N/A
orderBy string How you want the results sorted Options: popularity or alphabetical popularity
page integer Since the results are paginated, passing a page number will set the current page in the results. 1
count integer Since the results are paginated, passing a count will set the number of results for each page of results 42
Sample Response
// TODO

/api/v1/series/{seriesCode}

Fetch a single series
Parameter Type Description Default
nextIssue boolean Whether or not to include the next issue false
includeIssues boolean Whether or not to include issues with the result true
Sample Response
// TODO

/api/v1/publishers

Fetch publishers
Parameter Type Description Default
name string Will perform a very simple search. N/A
orderBy string How you want the results sorted Options: popularity or alphabetical popularity
page integer Since the results are paginated, passing a page number will set the current page in the results. 1
count integer Since the results are paginated, passing a count will set the number of results for each page of results 42
Sample Response
// TODO

/api/v1/publisher/{publisherID}

Fetch series
Parameter Type Description Default
This method takes no parameters
Sample Response
// TODO

# User API

Fetch information about the authenticated user


/api/v1/user

Get basic details of the authenticated user
Parameter Type Description Default
This method takes no parameters
Sample Response
// TODO

# Subscriptions API

Retreive and manage the subscriptions for an authenticated user


/api/v1/user/subscriptions

Retreive a list of the authenticated user's subscriptions.
Parameter Type Description Default
type string Whether or not to include inactive subscriptions Accepts: active, ended, dropped, or all active
Sample Response
// TODO

/api/v1/user/subscription

Retrieve the authenticated user's current subscripton for a series.
Parameter Type Description Default
series integer Providing a series will filter the results to those belonging to a specific series. N/A
Sample Response
// TODO

/api/v1/user/subscription/toggle

Toggle a subscription for a series for an authenticated user
Parameter Type Description Default
seriesCode integer
Required
The Diamond code for the series you want to check.
N/A
Sample Response
// TODO

/api/v1/user/subscription/add

Add subscriptions by series code
Parameter Type Description Default
series integer Providing a series will filter the results to those belonging to a specific series. N/A
Sample Response
// TODO

/api/v1/user/subscription/status

Get a subscription status for multiple series
Parameter Type Description Default
series integer Providing a series will filter the results to those belonging to a specific series. N/A
Sample Response
// TODO

/api/v1/user/subscription/drop

Drop subscriptions by series code
Parameter Type Description Default
series integer Providing a series will filter the results to those belonging to a specific series. N/A
Sample Response
// TODO

# Collection API

Manage and retrieve informtion for a user's collection


/api/v1/collection/status/list

Get a list of all available collection item status types
Parameter Type Description Default
This method takes no parameters
Sample Response
// TODO

/api/v1/collection/add

Add issues to a user's collection
Parameter Type Description Default
issue string
Required
Comma-delimited list of issues (using stock numbers) to add or update in a collection
N/A
status string Status of the issues being added Options: backlog, reading, read backlog
Sample Response
// TODO

/api/v1/collection/remove

Remove issues from a user's collection
Parameter Type Description Default
issue string
Required
Comma-delimited list of issues (using stock numbers) to add or update in a collection
N/A
Sample Response
// TODO

/api/v1/collection/years

Get the list of years from a user's collection
Parameter Type Description Default
This method takes no parameters
Sample Response
// TODO

/api/v1/collection/publishers

Get list of publishers from a user's collection
Parameter Type Description Default
This method takes no parameters
Sample Response
// TODO

/api/v1/collection/series

Get a list of series in a user's collection
Parameter Type Description Default
publisher integer ID of a publisher. Providing a publisher will filter the results to those belonging to a specific publisher. N/A
Sample Response
// TODO

/api/v1/collection/issues

Get a list of issues in a user's collection
Parameter Type Description Default
status string Comma-delimited list of statuses to filter by Options: backlog, in_progress, read N/A
year string Comma-delimited list of years to filter by N/A
format integer Format ID that you want to filter to See formats for format IDs N/A
publisher integer ID of a publisher. Providing a publisher will filter the results to those belonging to a specific publisher. N/A
series integer Providing a series will filter the results to those belonging to a specific series. N/A
page integer Since the results are paginated, passing a page number will set the current page in the results. 1
count integer Since the results are paginated, passing a count will set the number of results for each page of results 100
Sample Response
// TODO