Skip to content

Resources

The SDK exposes an object for each Comic Vine resource. Each object provides a retrieve() method for fetching a single item and a list() method for fetching paginated results. See the official Comic Vine API documentation for full endpoint details.

Character

Comic book characters (heroes, villains, etc.)

View reference

Origin

Character origin types (Human, Alien, Robot, etc.)

View reference

The following shared types are referenced across multiple resource response interfaces. They represent recurring structures in the Comic Vine API.

A minimal reference to another API resource.

interface ApiResource {
apiDetailUrl: string;
id: number;
name: string | null;
}

Extends ApiResource with a link to the Comic Vine website.

interface SiteResource extends ApiResource {
siteDetailUrl: string;
}

An issue reference that includes the issue number.

interface IssueApiResource extends ApiResource {
issueNumber: string;
}

An issue reference with both site URL and issue number.

interface IssueSiteResource extends SiteResource {
issueNumber: string;
}

A site resource with a count property (used in volume/series credits).

interface SiteResourceWithCount extends SiteResource {
count: string;
}

An episode reference that includes the episode number.

interface EpisodeApiResource extends ApiResource {
episodeNumber: string;
}

An episode reference with both site URL and episode number.

interface EpisodeSiteResource extends SiteResource {
episodeNumber: string;
}

A person credit reference that includes their role.

interface PersonCreditSiteResource extends SiteResource {
role: string;
}

Represents a death date with timezone information.

interface Death {
date: string;
timezoneType: number;
timezone: string;
}

An additional image associated with a resource.

interface AssociatedImage {
caption: null;
id: number;
imageTags: string;
originalUrl: string;
}

The standard image object returned for most resources, containing URLs at various sizes.

interface Image {
iconUrl: string;
mediumUrl: string;
screenUrl: string;
screenLargeUrl: string;
smallUrl: string;
superUrl: string;
thumbUrl: string;
tinyUrl: string;
originalUrl: string;
imageTags: string;
}