Skip to content

Comic

Character

Bases: BaseModel

The Character object contains information for a character.

ATTRIBUTE DESCRIPTION
avatar_comic_id

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

avatar_id

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

banner

TYPE: int

character_type

TYPE: Annotated[CharacterType, Field(alias=type_id)]

continuity_id

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

current_persona

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

date_added

Date and time when the Character was added.

TYPE: datetime

date_modified

Date and time when the Character was last updated.

TYPE: datetime

full_name

Full name of Character.

TYPE: str

has_avatar

Character has an avatar image.

TYPE: Annotated[bool, Field(alias=avatar), BeforeValidator(validate_bool)]

id

Identifier used by League of Comic Geeks.

TYPE: int

individual_id

TYPE: int

is_enabled

TYPE: Annotated[bool, Field(alias=enabled), BeforeValidator(validate_bool)]

map_to_id

TYPE: int

name

Name/Alias of Character.

TYPE: str

parent_id

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

parent_name

The actual name/identity of the character.

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

publisher_name

The publisher name of Character.

TYPE: str

role_name

TYPE: str

role_note

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

slug

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

story_id

TYPE: int

tier_id

TYPE: int

universe_id

Universe id this Character is from.

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

universe_name

Universe name this Character is from.

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

CharacterType

Bases: Enum

Comic(**data: Any)

Bases: BaseModel

The Issue object contains information for an Issue.

ATTRIBUTE DESCRIPTION
banner

TYPE: HttpUrl

characters

List of Characters in the Issue.

TYPE: list[Character]

collected_in

List of Issues this has been collected in.

TYPE: list[GenericComic]

collected_issues

List of Issues this has collected.

TYPE: list[GenericComic]

consensus_users

TYPE: Decimal

count_collected

TYPE: int

count_pulls

TYPE: int

count_read

TYPE: int

count_votes

TYPE: int

cover

TYPE: int

covers

List of Covers associated with the Issue.

TYPE: list[GenericCover]

creators

List of Creators associated with the Issue

TYPE: list[Creator]

date_added

Date and time when the Issue was added.

TYPE: datetime

date_cover

TYPE: Annotated[date | None, BeforeValidator(validate_date)]

date_foc

TYPE: Annotated[date | None, BeforeValidator(validate_date)]

date_modified

Date and time when the Issue was last updated.

TYPE: datetime

date_release

The date the Issue was released.

TYPE: date

description

Description of the Issue.

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

format

Type of Issue.

TYPE: ComicFormat

id

Identifier used by League of Comic Geeks.

TYPE: int

is_enabled

TYPE: Annotated[bool, Field(alias=enabled), BeforeValidator(validate_bool)]

is_nsfw

Issue has been marked as NSFW.

TYPE: Annotated[bool, Field(alias=nsfw), BeforeValidator(validate_bool)]

is_variant

Issue has been marked as Variant.

TYPE: Annotated[bool, Field(alias=variant), BeforeValidator(validate_bool)]

isbn

ISBN identifier

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

keys

List of Key Events taken place in the Issue.

TYPE: list[KeyEvent]

pages

Count of pages in the Issue.

TYPE: int

parent_id

If it is a variant Issue, id of the original Issue.

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

parent_title

If it is a variant Issue, title of the original Issue.

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

price

Price of the Issue.

TYPE: Annotated[Decimal | None, BeforeValidator(validate_decimal)]

publisher_id

The publisher id of the Issue.

TYPE: int

publisher_name

The publisher name of the Issue.

TYPE: str

publisher_slug

The publisher name slugged to be usable in a url.

TYPE: str

series

The series this Issue comes from.

TYPE: Series

series_id

The series id of the Issue.

TYPE: int

sku

SKU identifier.

TYPE: str

sku_diamond

TYPE: str

sku_lunar

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

title

Name/Title of the Issue.

TYPE: str

upc

UPC identifier.

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

variants

List of variants this Issue has.

TYPE: list[Variant]

Creator

Bases: BaseModel

The Creator object contains information for a creator.

ATTRIBUTE DESCRIPTION
assoc_id

TYPE: int

has_avatar

Creator has an avatar image.

TYPE: Annotated[bool, Field(alias=avatar), BeforeValidator(validate_bool)]

id

Identifier used by League of Comic Geeks.

TYPE: int

name

Name/Title of the Creator.

TYPE: str

role

List of roles the Creator has in the Issue. Separated by ,.

TYPE: str

role_id

List of role ids the Creator has in the Issue. Separated by ,.

TYPE: str

slug

The creator name slugged to be usable in a url.

TYPE: str

story_id

TYPE: Annotated[int | None, BeforeValidator(validate_int)]

Attributes

roles: dict[int, str] property

Return a dict of role id and role name the Creator is attached to.

KeyEvent

Bases: BaseModel

The KeyEvent object contains information for a key events such as Key Appearances.

ATTRIBUTE DESCRIPTION
character_id

Identifier used by League of Comic Geeks.

TYPE: int

comic_id

Issue id this event is attached to.

TYPE: int

id

Identifier used by League of Comic Geeks.

TYPE: int

key_event_type

TYPE: Annotated[KeyEventType, Field(alias=type)]

name

Superhero name/alias.

TYPE: str

note

Duplicate of 'string_secondary'.

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

parent_name

The actual name/identity of the character.

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

string_description

Full name of Character.

TYPE: str

string_primary

Text version of the type of event.

TYPE: str

string_secondary

TYPE: Annotated[str | None, BeforeValidator(validate_str)]

type_id

Identifier used by League of Comic Geeks.

TYPE: int

universe_id

TYPE: int

universe_name

Universe this Event took place in.

TYPE: str

KeyEventType

Bases: IntEnum

Variant

Bases: BaseModel

The Variant object contains information for a variant Issue.

ATTRIBUTE DESCRIPTION
cover

TYPE: int

cover_type

TYPE: CoverType

date_foc

TYPE: Annotated[date | None, BeforeValidator(validate_date)]

date_modified

Date and time when the Variant was last updated.

TYPE: datetime

date_release

The date the Variant was released.

TYPE: date

id

Identifier used by League of Comic Geeks.

TYPE: int

price

Price of the Variant.

TYPE: Annotated[Decimal | None, BeforeValidator(validate_decimal)]

sku

SKU identifier.

TYPE: str

title

Name/Title of the Variant.

TYPE: str