The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here.
The SDK also requires Node to be installed. If Node isn't already installed, please install it from here
NPM is installed by default when Node is installed
To check if node and npm have been successfully installed, write the following commands in command prompt:
node --version
npm -version
Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):
npm install
This will install all dependencies in the node_modules folder.
Once dependencies are resolved, you will need to move the folder MarvelComicsLib in to your node_modules folder.
How to Use
The following section explains how to use the library in a new project.
1. Open Project Folder
Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on File and select Open Folder.
Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.
2. Creating a Test File
Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:
var lib =require('lib');
Save changes.
3. Running The Test File
To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:
node index.js
How to Test
These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run.
Tests can be run in a number of ways:
Method 1 (Run all tests)
Navigate to the root directory of the SDK folder from command prompt.
Type mocha --recursive to run all the tests.
Method 2 (Run all tests)
Navigate to the ../test/Controllers/ directory from command prompt.
Type mocha * to run all the tests.
Method 3 (Run specific controller's tests)
Navigate to the ../test/Controllers/ directory from command prompt.
Type mocha MarvelComicsController to run all the tests in that controller file.
To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.
Initialization
Authentication
In order to setup authentication in the API client, you need the following information.
Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only characters which appear in the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only characters which have been modified since the specified date.
name
Optional
Return only characters matching the specified full character name (e.g. Spider-Man).
nameStartsWith
Optional
Return characters with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "modified", "-name", "-modified")
series
Optional
Return only characters which appear the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only characters which appear the specified stories (accepts a comma-separated list of ids).
Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only characters which have been modified since the specified date.
name
Optional
Return only characters matching the specified full character name (e.g. Spider-Man).
nameStartsWith
Optional
Return characters with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "modified", "-name", "-modified")
series
Optional
Return only characters which appear the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only characters which appear the specified stories (accepts a comma-separated list of ids).
Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only characters which have been modified since the specified date.
name
Optional
Return only characters matching the specified full character name (e.g. Spider-Man).
nameStartsWith
Optional
Return characters with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "modified", "-name", "-modified")
series
Optional
Return only characters which appear the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only characters which appear the specified stories (accepts a comma-separated list of ids).
Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only characters which have been modified since the specified date.
name
Optional
Return only characters matching the specified full character name (e.g. Spider-Man).
nameStartsWith
Optional
Return characters with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "modified", "-name", "-modified")
stories
Optional
Return only characters which appear the specified stories (accepts a comma-separated list of ids).
Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only characters which have been modified since the specified date.
name
Optional
Return only characters matching the specified full character name (e.g. Spider-Man).
nameStartsWith
Optional
Return characters with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "modified", "-name", "-modified")
series
Optional
Return only characters which appear the specified series (accepts a comma-separated list of ids).
Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work).
creators
Optional
Return only comics which feature work by the specified creators (accepts a comma-separated list of ids).
dateDescriptor
Optional
Return comics within a predefined date range.
dateRange
Optional
Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format.
diamondCode
Optional
Filter by diamond code.
digitalId
Optional
Filter by digital comic id.
ean
Optional
Filter by EAN.
events
Optional
Return only comics which take place in the specified events (accepts a comma-separated list of ids).
format
OptionalDefaultValue
Filter by the issue format (e.g. comic, digital comic, hardcover). (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
formatType
Optional
Filter by the issue format type (comic or collection).
hasDigitalIssue
OptionalDefaultValue
Include only results which are available digitally. (Acceptable values are: "true")
isbn
Optional
Filter by ISBN.
issn
Optional
Filter by ISSN.
issueNumber
Optional
Return only issues in series whose issue number matches the input.
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only comics which have been modified since the specified date.
noVariants
OptionalDefaultValue
Exclude variant comics from the result set. (Acceptable values are: "true")
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "focDate", "onsaleDate", "title", "issueNumber", "modified", "-focDate", "-onsaleDate", "-title", "-issueNumber", "-modified")
series
Optional
Return only comics which are part of the specified series (accepts a comma-separated list of ids).
sharedAppearances
Optional
Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear).
startYear
Optional
Return only issues in series whose start year matches the input.
stories
Optional
Return only comics which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Return only issues in series whose title matches the input.
titleStartsWith
Optional
Return only issues in series whose title starts with the input.
upc
Optional
Filter by UPC.
Example Usage
var characterId ='characterId';
var collaborators ='collaborators';
var creators ='creators';
var dateDescriptor =Object.keys(dateDescriptor)[0];
Return only comics which feature the specified characters (accepts a comma-separated list of ids).
collaborators
Optional
Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work). Accepts a comma-separated list of ids.
creators
Optional
Return only comics which feature work by the specified creators (accepts a comma-separated list of ids).
dateDescriptor
Optional
Return comics within a predefined date range.
dateRange
Optional
Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format.
diamondCode
Optional
Filter by diamond code.
digitalId
Optional
Filter by digital comic id.
ean
Optional
Filter by EAN.
events
Optional
Return only comics which take place in the specified events (accepts a comma-separated list of ids).
format
OptionalDefaultValue
Filter by the issue format (e.g. comic, digital comic, hardcover). (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
formatType
Optional
Filter by the issue format type (comic or collection).
hasDigitalIssue
OptionalDefaultValue
Include only results which are available digitally. (Acceptable values are: "true")
isbn
Optional
Filter by ISBN.
issn
Optional
Filter by ISSN.
issueNumber
Optional
Return only issues in series whose issue number matches the input.
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only comics which have been modified since the specified date.
noVariants
OptionalDefaultValue
Exclude variants (alternate covers, secondary printings, director's cuts, etc.) from the result set. (Acceptable values are: "true")
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "focDate", "onsaleDate", "title", "issueNumber", "modified", "-focDate", "-onsaleDate", "-title", "-issueNumber", "-modified")
series
Optional
Return only comics which are part of the specified series (accepts a comma-separated list of ids).
sharedAppearances
Optional
Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear). Accepts a comma-separated list of ids.
startYear
Optional
Return only issues in series whose start year matches the input.
stories
Optional
Return only comics which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Return only issues in series whose title matches the input.
titleStartsWith
Optional
Return only issues in series whose title starts with the input.
upc
Optional
Filter by UPC.
Example Usage
var characters ='characters';
var collaborators ='collaborators';
var creators ='creators';
var dateDescriptor =Object.keys(dateDescriptor)[0];
Return only comics which feature the specified characters (accepts a comma-separated list of ids).
collaborators
Optional
Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work).
dateDescriptor
Optional
Return comics within a predefined date range.
dateRange
Optional
Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format.
diamondCode
Optional
Filter by diamond code.
digitalId
Optional
Filter by digital comic id.
ean
Optional
Filter by EAN.
events
Optional
Return only comics which take place in the specified events (accepts a comma-separated list of ids).
format
OptionalDefaultValue
Filter by the issue format (e.g. comic, digital comic, hardcover). (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
formatType
Optional
Filter by the issue format type (comic or collection).
hasDigitalIssue
OptionalDefaultValue
Include only results which are available digitally. (Acceptable values are: "true")
isbn
Optional
Filter by ISBN.
issn
Optional
Filter by ISSN.
issueNumber
Optional
Return only issues in series whose issue number matches the input.
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only comics which have been modified since the specified date.
noVariants
OptionalDefaultValue
Exclude variant comics from the result set. (Acceptable values are: "true")
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "focDate", "onsaleDate", "title", "issueNumber", "modified", "-focDate", "-onsaleDate", "-title", "-issueNumber", "-modified")
series
Optional
Return only comics which are part of the specified series (accepts a comma-separated list of ids).
sharedAppearances
Optional
Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear).
startYear
Optional
Return only issues in series whose start year matches the input.
stories
Optional
Return only comics which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Return only issues in series whose title matches the input.
titleStartsWith
Optional
Return only issues in series whose title starts with the input.
upc
Optional
Filter by UPC.
Example Usage
var creatorId ='creatorId';
var characters ='characters';
var collaborators ='collaborators';
var dateDescriptor =Object.keys(dateDescriptor)[0];
Return only comics which feature the specified characters (accepts a comma-separated list of ids).
collaborators
Optional
Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work).
creators
Optional
Return only comics which feature work by the specified creators (accepts a comma-separated list of ids).
dateDescriptor
Optional
Return comics within a predefined date range.
dateRange
Optional
Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format.
diamondCode
Optional
Filter by diamond code.
digitalId
Optional
Filter by digital comic id.
ean
Optional
Filter by EAN.
events
Optional
Return only comics which take place in the specified events (accepts a comma-separated list of ids).
format
OptionalDefaultValue
Filter by the issue format (e.g. comic, digital comic, hardcover). (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
formatType
Optional
Filter by the issue format type (comic or collection).
hasDigitalIssue
OptionalDefaultValue
Include only results which are available digitally. (Acceptable values are: "true")
isbn
Optional
Filter by ISBN.
issn
Optional
Filter by ISSN.
issueNumber
Optional
Return only issues in series whose issue number matches the input.
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only comics which have been modified since the specified date.
noVariants
OptionalDefaultValue
Exclude variant comics from the result set. (Acceptable values are: "true")
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "focDate", "onsaleDate", "title", "issueNumber", "modified", "-focDate", "-onsaleDate", "-title", "-issueNumber", "-modified")
series
Optional
Return only comics which are part of the specified series (accepts a comma-separated list of ids).
sharedAppearances
Optional
Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear).
startYear
Optional
Return only issues in series whose start year matches the input.
stories
Optional
Return only comics which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Return only issues in series whose title matches the input.
titleStartsWith
Optional
Return only issues in series whose title starts with the input.
upc
Optional
Filter by UPC.
Example Usage
var eventId ='eventId';
var characters ='characters';
var collaborators ='collaborators';
var creators ='creators';
var dateDescriptor =Object.keys(dateDescriptor)[0];
Return only comics which feature the specified characters (accepts a comma-separated list of ids).
collaborators
Optional
Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work).
creators
Optional
Return only comics which feature work by the specified creators (accepts a comma-separated list of ids).
dateDescriptor
Optional
Return comics within a predefined date range.
dateRange
Optional
Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format.
diamondCode
Optional
Filter by diamond code.
digitalId
Optional
Filter by digital comic id.
ean
Optional
Filter by EAN.
events
Optional
Return only comics which take place in the specified events (accepts a comma-separated list of ids).
format
OptionalDefaultValue
Filter by the issue format (e.g. comic, digital comic, hardcover). (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
formatType
Optional
Filter by the issue format type (comic or collection).
hasDigitalIssue
OptionalDefaultValue
Include only results which are available digitally. (Acceptable values are: "true")
isbn
Optional
Filter by ISBN.
issn
Optional
Filter by ISSN.
issueNumber
Optional
Return only issues in series whose issue number matches the input.
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only comics which have been modified since the specified date.
noVariants
OptionalDefaultValue
Exclude variant comics from the result set. (Acceptable values are: "true")
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "focDate", "onsaleDate", "title", "issueNumber", "modified", "-focDate", "-onsaleDate", "-title", "-issueNumber", "-modified")
sharedAppearances
Optional
Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear).
startYear
Optional
Return only issues in series whose start year matches the input.
stories
Optional
Return only comics which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Return only issues in series whose title matches the input.
titleStartsWith
Optional
Return only issues in series whose title starts with the input.
upc
Optional
Filter by UPC.
Example Usage
var seriesId ='seriesId';
var characters ='characters';
var collaborators ='collaborators';
var creators ='creators';
var dateDescriptor =Object.keys(dateDescriptor)[0];
Return only comics which feature the specified characters (accepts a comma-separated list of ids).
collaborators
Optional
Return only comics in which the specified creators worked together (for example in which BOTH Stan Lee and Jack Kirby did work).
creators
Optional
Return only comics which feature work by the specified creators (accepts a comma-separated list of ids).
dateDescriptor
Optional
Return comics within a predefined date range.
dateRange
Optional
Return comics within a predefined date range. Dates must be specified as date1,date2 (e.g. 2013-01-01,2013-01-02). Dates are preferably formatted as YYYY-MM-DD but may be sent as any common date format.
diamondCode
Optional
Filter by diamond code.
digitalId
Optional
Filter by digital comic id.
ean
Optional
Filter by EAN.
events
Optional
Return only comics which take place in the specified events (accepts a comma-separated list of ids).
format
OptionalDefaultValue
Filter by the issue format (e.g. comic, digital comic, hardcover). (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
formatType
Optional
Filter by the issue format type (comic or collection).
hasDigitalIssue
OptionalDefaultValue
Include only results which are available digitally. (Acceptable values are: "true")
isbn
Optional
Filter by ISBN.
issn
Optional
Filter by ISSN.
issueNumber
Optional
Return only issues in series whose issue number matches the input.
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only comics which have been modified since the specified date.
noVariants
OptionalDefaultValue
Exclude variant comics from the result set. (Acceptable values are: "true")
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "focDate", "onsaleDate", "title", "issueNumber", "modified", "-focDate", "-onsaleDate", "-title", "-issueNumber", "-modified")
series
Optional
Return only comics which are part of the specified series (accepts a comma-separated list of ids).
sharedAppearances
Optional
Return only comics in which the specified characters appear together (for example in which BOTH Spider-Man and Wolverine appear).
startYear
Optional
Return only issues in series whose start year matches the input.
title
Optional
Return only issues in series whose title matches the input.
titleStartsWith
Optional
Return only issues in series whose title starts with the input.
upc
Optional
Filter by UPC.
Example Usage
var storyId ='storyId';
var characters ='characters';
var collaborators ='collaborators';
var creators ='creators';
var dateDescriptor =Object.keys(dateDescriptor)[0];
Return only events which take place in the specified comics (accepts a comma-separated list of ids).
creators
Optional
Return only events which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only events which have been modified since the specified date.
name
Optional
Filter the event list by name.
nameStartsWith
Optional
Return events with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "startDate", "modified", "-name", "-startDate", "-modified")
series
Optional
Return only events which are part of the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only events which contain the specified stories (accepts a comma-separated list of ids).
Return only events which feature the specified characters (accepts a comma-separated list of ids).
creators
Optional
Return only events which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only events which have been modified since the specified date.
name
Optional
Filter the event list by name.
nameStartsWith
Optional
Return events with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "startDate", "modified", "-name", "-startDate", "-modified")
series
Optional
Return only events which are part of the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only events which contain the specified stories (accepts a comma-separated list of ids).
Return only events which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only events which take place in the specified comics (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only events which have been modified since the specified date.
name
Optional
Filter the event list by name.
nameStartsWith
Optional
Return events with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "startDate", "modified", "-name", "-startDate", "-modified")
series
Optional
Return only events which are part of the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only events which contain the specified stories (accepts a comma-separated list of ids).
Return only events which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only events which take place in the specified comics (accepts a comma-separated list of ids).
creators
Optional
Return only events which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only events which have been modified since the specified date.
name
Optional
Return only events which match the specified name.
nameStartsWith
Optional
Return events with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "startDate", "modified", "-name", "-startDate", "-modified")
series
Optional
Return only events which are part of the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only events which take place in the specified stories (accepts a comma-separated list of ids).
Return only events which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only events which take place in the specified comics (accepts a comma-separated list of ids).
creators
Optional
Return only events which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only events which have been modified since the specified date.
name
Optional
Filter the event list by name.
nameStartsWith
Optional
Return events with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "startDate", "modified", "-name", "-startDate", "-modified")
stories
Optional
Return only events which contain the specified stories (accepts a comma-separated list of ids).
Return only events which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only events which take place in the specified comics (accepts a comma-separated list of ids).
creators
Optional
Return only events which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only events which have been modified since the specified date.
name
Optional
Filter the event list by name.
nameStartsWith
Optional
Return events with names that begin with the specified string (e.g. Sp).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "name", "startDate", "modified", "-name", "-startDate", "-modified")
series
Optional
Return only events which are part of the specified series (accepts a comma-separated list of ids).
Return only series which contain the specified comics (accepts a comma-separated list of ids).
contains
OptionalDefaultValue
Return only series containing one or more comics with the specified format. (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
creators
Optional
Return only series which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only series which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "title", "modified", "startYear", "-title", "-modified", "-startYear")
seriesType
OptionalDefaultValue
Filter the series by publication frequency type. (Acceptable values are: "collection", "one shot", "limited", "ongoing")
startYear
Optional
Return only series matching the specified start year.
stories
Optional
Return only series which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Filter by series title.
titleStartsWith
Optional
Return series with titles that begin with the specified string (e.g. Sp).
Return only series which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only series which contain the specified comics (accepts a comma-separated list of ids).
contains
OptionalDefaultValue
Return only series containing one or more comics with the specified format. (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
events
Optional
Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only series which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "title", "modified", "startYear", "-title", "-modified", "-startYear")
seriesType
OptionalDefaultValue
Filter the series by publication frequency type. (Acceptable values are: "collection", "one shot", "limited", "ongoing")
startYear
Optional
Return only series matching the specified start year.
stories
Optional
Return only series which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Filter by series title.
titleStartsWith
Optional
Return series with titles that begin with the specified string (e.g. Sp).
Return only series which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only series which contain the specified comics (accepts a comma-separated list of ids).
contains
OptionalDefaultValue
Return only series containing one or more comics with the specified format. (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
creators
Optional
Return only series which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only series which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "title", "modified", "startYear", "-title", "-modified", "-startYear")
seriesType
OptionalDefaultValue
Filter the series by publication frequency type. (Acceptable values are: "collection", "one shot", "limited", "ongoing")
startYear
Optional
Return only series matching the specified start year.
stories
Optional
Return only series which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Filter by series title.
titleStartsWith
Optional
Return series with titles that begin with the specified string (e.g. Sp).
Return only series which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only series which contain the specified comics (accepts a comma-separated list of ids).
contains
OptionalDefaultValue
Return only series containing one or more comics with the specified format. (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
creators
Optional
Return only series which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only series which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "title", "modified", "startYear", "-title", "-modified", "-startYear")
seriesType
OptionalDefaultValue
Filter the series by publication frequency type. (Acceptable values are: "collection", "one shot", "limited", "ongoing")
startYear
Optional
Return only series matching the specified start year.
stories
Optional
Return only series which contain the specified stories (accepts a comma-separated list of ids).
title
Optional
Return only series matching the specified title.
titleStartsWith
Optional
Return series with titles that begin with the specified string (e.g. Sp).
Return only series which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only series which contain the specified comics (accepts a comma-separated list of ids).
contains
OptionalDefaultValue
Return only series containing one or more comics with the specified format. (Acceptable values are: "comic", "magazine", "trade paperback", "hardcover", "digest", "graphic novel", "digital comic", "infinite comic")
creators
Optional
Return only series which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only series which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "title", "modified", "startYear", "-title", "-modified", "-startYear")
seriesType
OptionalDefaultValue
Filter the series by publication frequency type. (Acceptable values are: "collection", "one shot", "limited", "ongoing")
startYear
Optional
Return only series matching the specified start year.
title
Optional
Filter by series title.
titleStartsWith
Optional
Return series with titles that begin with the specified string (e.g. Sp).
Return only stories contained in the specified (accepts a comma-separated list of ids).
creators
Optional
Return only stories which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only stories which take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only stories which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "id", "modified", "-id", "-modified")
series
Optional
Return only stories contained the specified series (accepts a comma-separated list of ids).
Return only stories which feature the specified characters (accepts a comma-separated list of ids).
creators
Optional
Return only stories which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only stories which take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only stories which have been modified since the specified date.
offset
Optional
Skip the specified number of resources.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "id", "modified", "-id", "-modified")
series
Optional
Return only stories contained the specified series (accepts a comma-separated list of ids).
Return only stories which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only stories contained in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only stories which take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only stories which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "id", "modified", "-id", "-modified")
series
Optional
Return only stories contained the specified series (accepts a comma-separated list of ids).
Return only stories which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only stories contained in the specified (accepts a comma-separated list of ids).
creators
Optional
Return only stories which feature work by the specified creators (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only stories which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "id", "modified", "-id", "-modified")
series
Optional
Return only stories contained the specified series (accepts a comma-separated list of ids).
Return only stories which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only stories contained in the specified (accepts a comma-separated list of ids).
creators
Optional
Return only stories which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only stories which take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only stories which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "id", "modified", "-id", "-modified")
Return only stories which feature the specified characters (accepts a comma-separated list of ids).
comics
Optional
Return only stories contained in the specified (accepts a comma-separated list of ids).
creators
Optional
Return only stories which feature work by the specified creators (accepts a comma-separated list of ids).
events
Optional
Return only stories which take place during the specified events (accepts a comma-separated list of ids).
limit
Optional
Limit the result set to the specified number of resources.
modifiedSince
Optional
Return only stories which have been modified since the specified date.
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "id", "modified", "-id", "-modified")
series
Optional
Return only stories contained the specified series (accepts a comma-separated list of ids).
Return only creators who worked on in the specified comics (accepts a comma-separated list of ids).
firstName
Optional
Filter by creator first name (e.g. brian).
firstNameStartsWith
Optional
Filter by creator first names that match critera (e.g. B, St L).
lastName
Optional
Filter by creator last name (e.g. Bendis).
lastNameStartsWith
Optional
Filter by creator last names that match critera (e.g. Ben).
limit
Optional
Limit the result set to the specified number of resources.
middleName
Optional
Filter by creator middle name (e.g. Michael).
middleNameStartsWith
Optional
Filter by creator middle names that match critera (e.g. Mi).
modifiedSince
Optional
Return only creators which have been modified since the specified date.
nameStartsWith
Optional
Filter by creator names that match critera (e.g. B, St L).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "lastName", "firstName", "middleName", "suffix", "modified", "-lastName", "-firstName", "-middleName", "-suffix", "-modified")
series
Optional
Return only creators who worked on the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only creators who worked on the specified stories (accepts a comma-separated list of ids).
Return only creators who worked on in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids).
firstName
Optional
Filter by creator first name (e.g. Brian).
firstNameStartsWith
Optional
Filter by creator first names that match critera (e.g. B, St L).
lastName
Optional
Filter by creator last name (e.g. Bendis).
lastNameStartsWith
Optional
Filter by creator last names that match critera (e.g. Ben).
limit
Optional
Limit the result set to the specified number of resources.
middleName
Optional
Filter by creator middle name (e.g. Michael).
middleNameStartsWith
Optional
Filter by creator middle names that match critera (e.g. Mi).
modifiedSince
Optional
Return only creators which have been modified since the specified date.
nameStartsWith
Optional
Filter by creator names that match critera (e.g. B, St L).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "lastName", "firstName", "middleName", "suffix", "modified", "-lastName", "-firstName", "-middleName", "-suffix", "-modified")
series
Optional
Return only creators who worked on the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only creators who worked on the specified stories (accepts a comma-separated list of ids).
Return only creators who worked on in the specified comics (accepts a comma-separated list of ids).
firstName
Optional
Filter by creator first name (e.g. brian).
firstNameStartsWith
Optional
Filter by creator first names that match critera (e.g. B, St L).
lastName
Optional
Filter by creator last name (e.g. Bendis).
lastNameStartsWith
Optional
Filter by creator last names that match critera (e.g. Ben).
limit
Optional
Limit the result set to the specified number of resources.
middleName
Optional
Filter by creator middle name (e.g. Michael).
middleNameStartsWith
Optional
Filter by creator middle names that match critera (e.g. Mi).
modifiedSince
Optional
Return only creators which have been modified since the specified date.
nameStartsWith
Optional
Filter by creator names that match critera (e.g. B, St L).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "lastName", "firstName", "middleName", "suffix", "modified", "-lastName", "-firstName", "-middleName", "-suffix", "-modified")
series
Optional
Return only creators who worked on the specified series (accepts a comma-separated list of ids).
stories
Optional
Return only creators who worked on the specified stories (accepts a comma-separated list of ids).
Return only creators who worked on in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids).
firstName
Optional
Filter by creator first name (e.g. brian).
firstNameStartsWith
Optional
Filter by creator first names that match critera (e.g. B, St L).
lastName
Optional
Filter by creator last name (e.g. Bendis).
lastNameStartsWith
Optional
Filter by creator last names that match critera (e.g. Ben).
limit
Optional
Limit the result set to the specified number of resources.
middleName
Optional
Filter by creator middle name (e.g. Michael).
middleNameStartsWith
Optional
Filter by creator middle names that match critera (e.g. Mi).
modifiedSince
Optional
Return only creators which have been modified since the specified date.
nameStartsWith
Optional
Filter by creator names that match critera (e.g. B, St L).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "lastName", "firstName", "middleName", "suffix", "modified", "-lastName", "-firstName", "-middleName", "-suffix", "-modified")
stories
Optional
Return only creators who worked on the specified stories (accepts a comma-separated list of ids).
Return only creators who worked on in the specified comics (accepts a comma-separated list of ids).
events
Optional
Return only creators who worked on comics that took place in the specified events (accepts a comma-separated list of ids).
firstName
Optional
Filter by creator first name (e.g. brian).
firstNameStartsWith
Optional
Filter by creator first names that match critera (e.g. B, St L).
lastName
Optional
Filter by creator last name (e.g. Bendis).
lastNameStartsWith
Optional
Filter by creator last names that match critera (e.g. Ben).
limit
Optional
Limit the result set to the specified number of resources.
middleName
Optional
Filter by creator middle name (e.g. Michael).
middleNameStartsWith
Optional
Filter by creator middle names that match critera (e.g. Mi).
modifiedSince
Optional
Return only creators which have been modified since the specified date.
nameStartsWith
Optional
Filter by creator names that match critera (e.g. B, St L).
offset
Optional
Skip the specified number of resources in the result set.
orderBy
OptionalDefaultValue
Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed. (Acceptable values are: "lastName", "firstName", "middleName", "suffix", "modified", "-lastName", "-firstName", "-middleName", "-suffix", "-modified")
series
Optional
Return only creators who worked on the specified series (accepts a comma-separated list of ids).