-
Notifications
You must be signed in to change notification settings - Fork 6
Documentation
Important: This is a work in progress. There's only two endpoints to connect to. I am working into incorporating all of Marvel Comics API endpoints.
| Method | Description |
|---|---|
| #characters | Fetches a list of comic characters. |
| #character | Fetches a single character resource. |
| #character_comics | Fetches a list of comics containing a specific character. |
| #character_events | Fetches a list of events in which a specific character appears. |
| #character_series | Fetches a list of comic series in which a specific character appears. |
| #character_stories | Fetches a list of comic stories featuring a specific character. |
| #comics | Fetches a list of comics. |
| #comic | Fetches a single comic resource. |
| #comic_characters | Fetches a list of characters which appear in a specific comic. |
| #comic_creators | Fetches a list of comic creators whose work appears in a specific comic. |
| #comic_events | Fetches a list of events in which a comic appears. |
| #comic_stories | Fetches a list of comic stories in a specific comic issue. |
| #events | Fetches a list of events. |
| #event | Fetches a single event resource. |
| #event_characters | Fetches a list of characters which appear in a specific event. |
| #event_comics | Fetches a list of comics which take place during a specific event. |
| #event_creators | Fetches a list of event creators whose work appears in a specific event. |
| #event_series | Fetches a list of comic series in which a specific event takes place. |
| #event_stories | Fetches a list of comic stories from a specific event. |
| #series | Fetches a list of series. |
| #serie | Fetches a single series resource. |
| #serie_characters | Fetches a list of characters which appear in a specific series. |
| #serie_comics | Fetches a list of comics which are published as part of a specific series. |
| #serie_creators | Fetches a list of event creators whose work appears in a specific series. |
| #serie_events | Fetches a list of comic events which occur in a specific series. |
| #serie_stories | Fetches a list of comic stories from a specific series. |
| #stories | Fetches a list of stories. |
| #story | Fetches a single story resource. |
| #story_characters | Fetches a list of characters which appear in a specific stories. |
| #story_comics | Fetches a list of comics in which a specific story appears. |
| #story_creators | Fetches a list of comic creators whose work appears in a specific story. |
| #story_events | Fetches a list of comic events in which a specific story appears. |
| #story_series | Fetches lists of comic series in which the specified story takes place. |
Fetches a list of comic characters. Can receive optional params.
client.characters
client.characters(:name => 'Spider-Man')
client.characters(:limit => 10, :offset => 400, :orderBy => 'name')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #characters method.
Fetches a single character resource. Accepts an integer or string value as character id.
client.character(1009610)
client.character('Spider-Man')Fetches a list of comics containing a specific character. Requires a character id value (integer or string). Accepts optional params.
client.character_comics(1009610)
client.character_comics('Spider-Man')
client.character_comics(
1009610,
{ :format => 'graphic novel', :limit => 10, :orderBy => 'title' }
)
client.character_comics(
'Spider-Man',
{ :format => 'graphic novel', :limit => 10, :orderBy => 'title' }
)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #character_comics method.
Fetches a list of events in which a specific character appears. Requires a character id value (integer or string). Accepts optional params.
client.character_events(1009610)
client.character_events('Spider-Man')
client.character_events(
1009610,
{ :limit => 10, :orderBy => 'name' }
)
client.character_events(
'Spider-Man',
{ :limit => 10, :orderBy => 'name' }
)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #character_events method.
Fetches a list of comic series in which a specific character appears. Requires a character id value (integer or string). Accepts optional params.
client.character_series(1009610)
client.character_series('Spider-Man')
client.character_series(
1009610,
{ :seriesType => 'ongoing', :limit => 10, :orderBy => 'title' }
)
client.character_series(
'Spider-Man',
{ :seriesType => 'ongoing', :limit => 10, :orderBy => 'title' }
)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #character_series method.
Fetches a list of comic stories featuring a specific character. Requires a character id value (integer or string). Accepts optional params.
client.character_stories(1009610)
client.character_stories('Spider-Man')
client.character_stories(1009610, { :limit => 10, :offset => 20 })
client.character_stories('Spider-Man', { :limit => 10, :offset => 20 })See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #character_stories method.
Fetches a list of comics. Accepts optional params.
client.comics
client.comics(:format => 'graphic novel', :limit => 10, :offset => 20 })See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #comics method.
Fetches a single comic resource. Requires a comic id value (integer).
client.comic(40128)Fetches a list of characters which appear in a specific comic. Requires a comic id value (integer). Accepts optional params.
client.comic_characters(40128)
client.comic_characters(40128, :orderBy => 'name', :limit => 30, :offset => 20)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #comic_characters method.
Fetches a list of comic creators whose work appears in a specific comic. Requires a comic id value (integer). Accepts optional params.
client.comic_creators(40128)
client.comic_creators(40128, :lastName => 'Romita')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #comic_creators method.
Fetches a list of events in which a comic appears. Requires a comic id value (integer). Accepts optional params.
client.comic_events(40128)
client.comic_events(40128, :orderBy => 'name', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #comic_events method.
Fetches a list of comic stories in a specific comic issue. Requires a comic id value (integer). Accepts optional params.
client.comic_stories(40128)
client.comic_stories(40128, :orderBy => 'name', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #comic_stories method.
Fetches a list of events. Accepts optional params.
client.events
client.events(:name => 'Acts of Vengeance')
client.events(:orderBy => 'name')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #events method.
Fetches a single comic resource. Requires an event id value (integer or string).
client.event(116)
client.event('Acts of Vengeance!')Fetches a list of characters which appear in a specific event. Requires an event id value (integer or string). Accepts optional params.
client.event_characters(116)
client.event_characters('Acts of Vengeance!')
client.event_characters(116, :orderBy => 'name', :limit => 30, :offset => 20)
client.event_characters('Acts of Vengeance!', :orderBy => 'name', :limit => 30, :offset => 20)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #event_characters method.
Fetches a list of comic creators whose work appears in a specific event. Requires an event id value (integer or string). Accepts optional params.
client.event_creators(116)
client.event_creators('Acts of Vengeance!')
client.event_creators(116, :lastName => 'Albrecht')
client.event_creators('Acts of Vengeance!', :lastName => 'Albrecht')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #event_creators method.
Fetches a list of comics which take place during a specific event. Requires an event id value (integer or string). Accepts optional params.
client.event_comics(116)
client.event_comics('Acts of Vengeance!')
client.event_comics(116, :format => 'graphic novel', :orderBy => 'title', :limit => 10)
client.event_comics('Acts of Vengeance!', :format => 'graphic novel', :orderBy => 'title', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #event_comics method.
Fetches a list of comic series in which a specific event takes place. Requires an event id value (integer or string). Accepts optional params.
client.event_series(116)
client.event_series('Acts of Vengeance!')
client.event_series(116, :orderBy => 'title', :limit => 10)
client.event_series('Acts of Vengeance!', :orderBy => 'title', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #event_series method.
Fetches a list of comic stories from a specific event. Requires an event id value (integer or string). Accepts optional params.
client.event_stories(116)
client.event_stories(116, :limit => 10)
client.event_stories('Acts of Vengeance!')
client.event_stories('Acts of Vengeance!', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #event_stories method.
Fetches a list of series. Accepts optional params.
client.series
client.series(:name => 'Spider-Man')
client.series(:orderBy => 'title')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #series method.
Fetches a single series resource. Requires an serie id value (integer).
client.serie(2069)Fetches a list of characters which appear in a specific series. Requires an serie id value (integer). Accepts optional params.
client.series_characters(2069)
client.series_characters(2069, :orderBy => 'name', :limit => 30, :offset => 20)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #serie_characters method.
Fetches a list of comic creators whose work appears in a specific series. Requires an serie id value (integer). Accepts optional params.
client.series_creators(2069)
client.series_creators(2069, :lastName => 'Albrecht')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #serie_creators method.
Fetches a list of comics which are published as part of a specific series.. Requires an serie id value (integer). Accepts optional params.
client.series_comics(2069)
client.series_comics(2069, :format => 'graphic novel', :orderBy => 'title', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #serie_comics method.
Fetches a list of comic events which occur in a specific series. Requires an serie id value (integer). Accepts optional params.
client.series_events(2069)
client.series_events(2069, :orderBy => 'name', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #serie_series method.
Fetches a list of comic stories from a specific series. Requires an serie id value (integer). Accepts optional params.
client.series_stories(2069)
client.series_stories(2069, :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #serie_stories method.
Fetches a list of stories. Accepts optional params.
client.stories
client.stories(:limit => 50, :offset => 100)
client.stories(:orderBy => 'id')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #stories method.
Fetches a single story resource. Requires an story id value (integer).
client.story(2210)Fetches a list of characters which appear in a specific story. Requires a story id value (integer). Accepts optional params.
client.story_characters(2210)
client.story_characters(2210, :orderBy => 'name', :limit => 30, :offset => 20)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #story_characters method.
Fetches a list of comic creators whose work appears in a specific story. Requires an story id value (integer). Accepts optional params.
client.story_creators(2210)
client.story_creators(2210, :lastName => 'Albrecht')See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #story_creators method.
Fetches a list of comics in which a specific story appears. Requires an story id value (integer). Accepts optional params.
client.story_comics(2210)
client.story_comics(2210, :format => 'graphic novel', :orderBy => 'title', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #story_comics method.
Fetches a list of comic events in which a specific story appears. Requires an story id value (integer). Accepts optional params.
client.story_events(2210)
client.story_events(2210, :orderBy => 'name', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #story_events method.
Fetches lists of comic series in which the specified story takes place. Requires a story id value (integer). Accepts optional params.
client.story_series(2210)
client.story_series(2210, :orderBy => 'title', :limit => 10)See the Marvel Comics Interactive API Tester for a complete list of params that you can pass to the #story_events method.