Skip to content

Maps

genjishimada_sdk.maps

ArchivalStatusPatchRequest

Bases: Struct

Bulk update for map archival status.

Attributes:

Name Type Description
codes list[OverwatchCode]

Workshop codes to update.
status Literal['Archive', 'Unarchived']

Desired archival status.

codes: list[OverwatchCode] instance-attribute

status: Literal['Archive', 'Unarchived'] instance-attribute

GuideFullResponse

Bases: GuideResponse

Guide response including author usernames.

usernames: list[str] = [] class-attribute instance-attribute

GuideResponse

Bases: Struct

Represents a guide entry for a map.

Attributes:

Name Type Description
url GuideURL

URL of the guide content.
user_id int

Identifier of the guide author.

url: GuideURL instance-attribute

user_id: int instance-attribute

GuideURL = Annotated[str, Meta(pattern=URL_PATTERN, description='Must be a valid URL starting with http:// or https://.')] module-attribute

LinkMapsCreateRequest

Bases: Struct

Request payload for linking an unofficial map to an official one.

Attributes:

Name Type Description
official_code OverwatchCode

Workshop code of the official map.
unofficial_code OverwatchCode

Workshop code of the unofficial map.

official_code: OverwatchCode instance-attribute

unofficial_code: OverwatchCode instance-attribute

MAX_CREATORS = 3 module-attribute

MapCategory = Literal['Classic', 'Increasing Difficulty', 'Other'] module-attribute

MapCompletionStatisticsResponse

Bases: Struct

Aggregate statistics for map completion times.

Attributes:

Name Type Description
min float | None

Minimum completion time.
max float | None

Maximum completion time.
avg float | None

Average completion time.

avg: float | None = None class-attribute instance-attribute

max: float | None = None class-attribute instance-attribute

min: float | None = None class-attribute instance-attribute

MapCountsResponse

Bases: Struct

Count of maps grouped by map name.

Attributes:

Name Type Description
map_name OverwatchMap

Overwatch map name.
amount int

Number of maps recorded.

amount: int instance-attribute

map_name: OverwatchMap instance-attribute

MapCreateRequest

Bases: Struct

Payload for creating a new map entry.

Attributes:

Name Type Description
code OverwatchCode

Workshop code for the map.
map_name OverwatchMap

Overwatch map name.
category MapCategory

Category describing the map type.
creators Annotated[list[Creator], Meta(max_length=3)]

List of map creators.
checkpoints Annotated[int, Meta(gt=0)]

Number of checkpoints in the map.
difficulty DifficultyAll

Difficulty rating for the map.
official bool

Whether the map is official.
hidden bool

Whether the map should be hidden from listings.
playtesting PlaytestStatus

Current playtest status.
archived bool

Whether the map is archived.
mechanics list[Mechanics]

Mechanics required for the map.
restrictions list[Restrictions]

Restrictions applied to the map.
tags list[Tags]

Tags applied to the map.
description str | None

Optional map description.
medals MedalsResponse | None

Medal thresholds for the map.
guide_url GuideURL | None

URL to a primary guide.
title str | None

Optional display title for the map.
custom_banner str | None

Custom banner asset name.

archived: bool = False class-attribute instance-attribute

category: MapCategory instance-attribute

checkpoints: Annotated[int, Meta(gt=0)] instance-attribute

code: OverwatchCode instance-attribute

creators: Annotated[list[Creator], Meta(max_length=3)] instance-attribute

custom_banner: str | None = None class-attribute instance-attribute

description: str | None = None class-attribute instance-attribute

difficulty: DifficultyAll instance-attribute

guide_url: GuideURL | None = None class-attribute instance-attribute

hidden: bool = True class-attribute instance-attribute

map_name: OverwatchMap instance-attribute

mechanics: list[Mechanics] = [] class-attribute instance-attribute

medals: MedalsResponse | None = None class-attribute instance-attribute

official: bool = True class-attribute instance-attribute

playtesting: PlaytestStatus = 'In Progress' class-attribute instance-attribute

primary_creator_id: int property

Get the primary creator.

restrictions: list[Restrictions] = [] class-attribute instance-attribute

tags: list[Tags] = [] class-attribute instance-attribute

title: str | None = None class-attribute instance-attribute

MapCreationJobResponse

Bases: Struct

Job response for map creation requests.

Attributes:

Name Type Description
job_status JobStatusResponse | None

Status of the asynchronous map creation job.
data MapResponse

Map details produced by the creation process.

data: MapResponse instance-attribute

job_status: JobStatusResponse | None instance-attribute

MapEditCreateRequest

Bases: Struct

Request payload for creating a map edit request.

archived: bool | UnsetType = UNSET class-attribute instance-attribute

category: MapCategory | UnsetType = UNSET class-attribute instance-attribute

checkpoints: Annotated[int, Meta(gt=0)] | UnsetType = UNSET class-attribute instance-attribute

code: OverwatchCode instance-attribute

created_by: int instance-attribute

creators: list[Creator] | UnsetType = UNSET class-attribute instance-attribute

custom_banner: str | UnsetType | None = UNSET class-attribute instance-attribute

description: str | UnsetType | None = UNSET class-attribute instance-attribute

difficulty: DifficultyAll | UnsetType = UNSET class-attribute instance-attribute

hidden: bool | UnsetType = UNSET class-attribute instance-attribute

map_name: OverwatchMap | UnsetType = UNSET class-attribute instance-attribute

mechanics: list[Mechanics] | UnsetType | None = UNSET class-attribute instance-attribute

medals: MedalsResponse | UnsetType | None = UNSET class-attribute instance-attribute

new_code: OverwatchCode | UnsetType = UNSET class-attribute instance-attribute

official: bool | UnsetType = UNSET class-attribute instance-attribute

reason: str instance-attribute

restrictions: list[Restrictions] | UnsetType | None = UNSET class-attribute instance-attribute

tags: list[Tags] | UnsetType | None = UNSET class-attribute instance-attribute

title: str | UnsetType | None = UNSET class-attribute instance-attribute

to_changes_dict() -> dict[str, Any]

Convert to a dict of only the changed fields.

MapEditCreatedEvent

Bases: Struct

Event emitted when a map edit request is created.

edit_request_id: int instance-attribute

MapEditFieldChange

Bases: Struct

Represents a single field change for display.

field: str instance-attribute

new_value: str instance-attribute

old_value: str instance-attribute

MapEditResolveRequest

Bases: Struct

Request to resolve (accept/reject) an edit request.

accepted: bool instance-attribute

rejection_reason: str | None = None class-attribute instance-attribute

resolved_by: int instance-attribute

send_to_playtest: bool = False class-attribute instance-attribute

MapEditResolvedEvent

Bases: Struct

Event emitted when a map edit request is resolved.

accepted: bool instance-attribute

edit_request_id: int instance-attribute

rejection_reason: str | None instance-attribute

resolved_by: int instance-attribute

MapEditResponse

Bases: Struct

Full map edit request response.

accepted: bool | None instance-attribute

code: OverwatchCode instance-attribute

created_at: dt.datetime instance-attribute

created_by: int instance-attribute

id: int instance-attribute

map_id: int instance-attribute

message_id: int | None instance-attribute

proposed_changes: dict[str, Any] instance-attribute

reason: str instance-attribute

rejection_reason: str | None instance-attribute

resolved_at: dt.datetime | None instance-attribute

resolved_by: int | None instance-attribute

MapEditSetMessageIdRequest

Bases: Struct

Request to set the verification queue message ID.

message_id: int instance-attribute

MapEditSubmissionResponse

Bases: Struct

Response when viewing an edit request for the queue.

changes: list[MapEditFieldChange] instance-attribute

code: OverwatchCode instance-attribute

created_at: dt.datetime instance-attribute

difficulty: DifficultyAll instance-attribute

id: int instance-attribute

map_name: OverwatchMap instance-attribute

message_id: int | None instance-attribute

reason: str instance-attribute

submitter_id: int instance-attribute

submitter_name: str instance-attribute

MapMasteryCreateRequest

Bases: Struct

Request payload for recording map mastery progress.

Attributes:

Name Type Description
user_id int

Identifier of the user earning mastery.
map_name OverwatchMap

Name of the Overwatch map.
level str

Mastery level achieved.

level: str instance-attribute

map_name: OverwatchMap instance-attribute

user_id: int instance-attribute

MapMasteryCreateResponse

Bases: Struct

Response returned after creating or updating mastery progress.

Attributes:

Name Type Description
map_name OverwatchMap

Name of the Overwatch map.
medal str

Medal earned for the mastery level.
operation_status Literal['inserted', 'updated']

Whether the record was inserted or updated.

map_name: OverwatchMap instance-attribute

medal: str instance-attribute

operation_status: Literal['inserted', 'updated'] instance-attribute

MapMasteryResponse

Bases: Struct

Aggregated mastery progress for a map.

Attributes:

Name Type Description
map_name OverwatchMap

Name of the Overwatch map.
amount int

Number of mastery completions.
level str | None

Computed mastery level name.
icon_url str | None

Asset URL for the mastery icon.

__post_init__() -> None

Post init.

amount: int instance-attribute

icon_url: str | None = None class-attribute instance-attribute

level: str | None = None class-attribute instance-attribute

map_name: OverwatchMap instance-attribute

MapPartialResponse

Bases: Struct

Lightweight map response used for playtest listings.

Attributes:

Name Type Description
map_id int

Identifier of the map.
code OverwatchCode

Workshop code for the map.
difficulty DifficultyAll

Difficulty rating for the map.
creator_name str

Primary creator name.
map_name OverwatchMap

Overwatch map name.
checkpoints int

Number of checkpoints in the map.

checkpoints: int instance-attribute

code: OverwatchCode instance-attribute

creator_name: str instance-attribute

difficulty: DifficultyAll instance-attribute

map_id: int instance-attribute

map_name: OverwatchMap instance-attribute

thread_name: str property

Return the thread name.

MapPatchRequest

Bases: Struct

Partial update payload for map entries.

Attributes mirror :class:MapCreateRequest but are optional for patching.

archived: bool | UnsetType = UNSET class-attribute instance-attribute

category: MapCategory | UnsetType = UNSET class-attribute instance-attribute

checkpoints: Annotated[int, Meta(gt=0)] | UnsetType = UNSET class-attribute instance-attribute

code: OverwatchCode | UnsetType = UNSET class-attribute instance-attribute

creators: list[Creator] | UnsetType = UNSET class-attribute instance-attribute

custom_banner: str | UnsetType | None = UNSET class-attribute instance-attribute

description: str | UnsetType | None = UNSET class-attribute instance-attribute

difficulty: DifficultyAll | UnsetType = UNSET class-attribute instance-attribute

hidden: bool | UnsetType = UNSET class-attribute instance-attribute

map_name: OverwatchMap | UnsetType = UNSET class-attribute instance-attribute

mechanics: list[Mechanics] | UnsetType | None = UNSET class-attribute instance-attribute

medals: MedalsResponse | UnsetType | None = UNSET class-attribute instance-attribute

official: bool | UnsetType = UNSET class-attribute instance-attribute

playtesting: PlaytestStatus | UnsetType = UNSET class-attribute instance-attribute

restrictions: list[Restrictions] | UnsetType | None = UNSET class-attribute instance-attribute

tags: list[Tags] | UnsetType | None = UNSET class-attribute instance-attribute

title: str | UnsetType | None = UNSET class-attribute instance-attribute

MapPerDifficultyStatisticsResponse

Bases: Struct

Statistics grouped by difficulty level.

Attributes:

Name Type Description
difficulty DifficultyTop

Difficulty tier represented.
amount int

Number of maps in the tier.

amount: int instance-attribute

difficulty: DifficultyTop instance-attribute

MapPlaytestResponse

Bases: Struct

Playtest metadata associated with a map.

Attributes:

Name Type Description
thread_id int

Discord thread for the playtest discussion.
vote_average float | None

Average difficulty vote.
vote_count int | None

Number of votes cast.
voters list[int] | None

Identifiers of voters.
verification_id int | None

Verification entry for the playtest.
initial_difficulty float

Initial difficulty estimate.
completed bool

Whether the playtest is complete.

completed: bool instance-attribute

initial_difficulty: float instance-attribute

thread_id: int instance-attribute

verification_id: int | None instance-attribute

vote_average: float | None instance-attribute

vote_count: int | None instance-attribute

voters: list[int] | None instance-attribute

MapResponse

Bases: Struct

Full map representation returned by API endpoints.

Attributes:

Name Type Description
id int

Database identifier for the map.
code OverwatchCode

Workshop code for the map.
map_name OverwatchMap

Overwatch map name.
category MapCategory

Category describing the map type.
creators list[CreatorFull]

Full creator details.
checkpoints Annotated[int, Meta(gt=0)]

Number of checkpoints in the map.
difficulty DifficultyAll

Difficulty rating for the map.
official bool

Whether the map is official.
playtesting PlaytestStatus

Current playtest status.
archived bool

Whether the map is archived.
hidden bool

Whether the map is hidden from listings.
created_at datetime

Timestamp when the map was created.
updated_at datetime

Timestamp when the map was last updated.
ratings float | None

Average community rating.
playtest MapPlaytestResponse | None

Playtest metadata for the map.
guides list[GuideURL] | None

List of guide URLs.
raw_difficulty Annotated[float, Meta(ge=0, le=10)] | None

Raw numerical difficulty score.
mechanics list[Mechanics]

Mechanics required for the map.
restrictions list[Restrictions]

Restrictions applied to the map.
tags list[Tags]

Tags applied to the map.
description str | None

Optional map description.
medals MedalsResponse | None

Medal thresholds for the map.
title str | None

Optional display title for the map.
map_banner str | None

Banner asset URL.
time float | None

Best recorded time for the map.
total_results int | None

Total results when returned in paginated queries.
linked_code OverwatchCode | None

Workshop code linked to this map.

__post_init__() -> None

Post init.

archived: bool instance-attribute

category: MapCategory instance-attribute

checkpoints: Annotated[int, Meta(gt=0)] instance-attribute

code: OverwatchCode instance-attribute

created_at: dt.datetime instance-attribute

creators: list[CreatorFull] instance-attribute

description: str | None = None class-attribute instance-attribute

difficulty: DifficultyAll instance-attribute

guides: list[GuideURL] | None = None class-attribute instance-attribute

hidden: bool instance-attribute

id: int instance-attribute

linked_code: OverwatchCode | None = None class-attribute instance-attribute

map_banner: str | None = '' class-attribute instance-attribute

map_name: OverwatchMap instance-attribute

mechanics: list[Mechanics] = [] class-attribute instance-attribute

medals: MedalsResponse | None = None class-attribute instance-attribute

official: bool instance-attribute

playtest: MapPlaytestResponse | None instance-attribute

playtesting: PlaytestStatus instance-attribute

primary_creator_id: int property

Get the primary creator.

primary_creator_name: str property

Get the primary creator.

ratings: float | None instance-attribute

raw_difficulty: Annotated[float, Meta(ge=0, le=10)] | None = None class-attribute instance-attribute

restrictions: list[Restrictions] = [] class-attribute instance-attribute

tags: list[Tags] = [] class-attribute instance-attribute

time: float | None = None class-attribute instance-attribute

title: str | None = None class-attribute instance-attribute

total_results: int | None = None class-attribute instance-attribute

updated_at: dt.datetime instance-attribute

Mechanics = Literal['Edge Climb', 'Bhop', 'Save Climb', 'High Edge', 'Distance Edge', 'Quick Climb', 'Slide', 'Stall', 'Dash', 'Ultimate', 'Emote Save Bhop', 'Death Bhop', 'Triple Jump', 'Multi Climb', 'Vertical Multi Climb', 'Standing Create Bhop', 'Crouch Edge', 'Bhop First', 'Create Bhop', 'Save Double'] module-attribute

MedalType = Literal['Gold', 'Silver', 'Bronze'] module-attribute

MedalsResponse

Bases: Struct

__post_init__() -> None

Validate medals.

All medals must be present and be in order.

bronze: float instance-attribute

gold: float instance-attribute

silver: float instance-attribute

OverwatchCode = Annotated[str, Meta(min_length=4, max_length=6, pattern='^[A-Z0-9]*$')] module-attribute

OverwatchMap = Literal['Circuit Royal', 'Runasapi', 'Practice Range', 'Route 66', 'Midtown', 'Junkertown', 'Colosseo', 'Lijiang Tower (Lunar New Year)', 'Dorado', 'Throne of Anubis', 'Castillo', 'Blizzard World (Winter)', 'Hollywood (Halloween)', "King's Row", 'Black Forest (Winter)', 'Petra', 'Framework', 'Eichenwalde', 'Workshop Island', 'Chateau Guillard (Halloween)', 'New Junk City', 'Necropolis', 'Kanezaka', 'Havana', 'Oasis', 'Ayutthaya', 'Volskaya Industries', 'Hanamura', 'Workshop Expanse', 'Hanaoka', 'Lijiang Tower', 'Busan (Lunar New Year)', 'Suravasa', "King's Row (Winter)", 'Ecopoint: Antarctica', 'Hanamura (Winter)', 'Blizzard World', 'Chateau Guillard', 'Paraiso', 'Workshop Green Screen', 'Watchpoint: Gibraltar', 'Shambali', 'Eichenwalde (Halloween)', 'Tools', 'Nepal', 'Samoa', 'Horizon Lunar Colony', 'Paris', 'Esperanca', 'Black Forest', 'Antarctic Peninsula', 'Workshop Chamber', 'Hollywood', 'New Queen Street', 'Rialto', 'Busan', 'Malevento', 'Temple of Anubis', 'Ilios', 'Ecopoint: Antarctica (Winter)', 'Numbani', 'Adlersbrunn', 'Aatlis', 'Arena Victoriae', 'Redwood Dam', 'Thames District', 'Gogadoro', 'Powder Keg Mine', 'Place Lacroix'] module-attribute

PLAYTEST_VOTE_THRESHOLD: dict[DifficultyTop, int] = {'Easy': 5, 'Medium': 5, 'Hard': 5, 'Very Hard': 3, 'Extreme': 2, 'Hell': 1} module-attribute

PendingMapEditResponse

Bases: Struct

Lightweight response for pending edits list.

code: OverwatchCode instance-attribute

id: int instance-attribute

message_id: int | None instance-attribute

PlaytestApproveRequest

Bases: Struct

Request payload for approving a playtest.

Attributes:

Name Type Description
verifier_id int

Identifier of the verifier approving the playtest.

verifier_id: int instance-attribute

PlaytestApprovedEvent

Bases: Struct

Event emitted when a playtest is approved.

Attributes:

Name Type Description
verifier_id int

Identifier of the verifier approving the playtest.
difficulty DifficultyAll

Final difficulty rating.
thread_id int

Discord thread identifier for the playtest.
primary_creator_id int

Identifier of the primary creator for the map.
code OverwatchCode

Workshop code for the map.

code: OverwatchCode instance-attribute

difficulty: DifficultyAll instance-attribute

primary_creator_id: int instance-attribute

thread_id: int instance-attribute

verifier_id: int instance-attribute

PlaytestCreatePartialRequest

Bases: Struct

Partial playtest creation payload when creating alongside a map.

Attributes:

Name Type Description
code OverwatchCode

Workshop code for the map.
initial_difficulty DifficultyAll

Initial difficulty estimate.

code: OverwatchCode instance-attribute

initial_difficulty: DifficultyAll instance-attribute

PlaytestCreateRequest

Bases: Struct

Request payload for creating a playtest entry.

Attributes:

Name Type Description
code OverwatchCode

Workshop code for the map.
thread_id int

Discord thread identifier.
initial_difficulty DifficultyAll

Initial difficulty estimate.

code: OverwatchCode instance-attribute

initial_difficulty: DifficultyAll instance-attribute

thread_id: int instance-attribute

PlaytestCreatedEvent

Bases: Struct

Event emitted when a playtest is created.

Attributes:

Name Type Description
code OverwatchCode

Workshop code for the map.
playtest_id int

Identifier of the playtest.

code: OverwatchCode instance-attribute

playtest_id: int instance-attribute

PlaytestForceAcceptRequest

Bases: Struct

Request to force-accept a playtest with a given difficulty.

Attributes:

Name Type Description
difficulty DifficultyAll

Difficulty rating to assign.

difficulty: DifficultyAll instance-attribute

verifier_id: int instance-attribute

PlaytestForceAcceptedEvent

Bases: Struct

difficulty: DifficultyAll instance-attribute

thread_id: int instance-attribute

verifier_id: int instance-attribute

PlaytestForceDeniedEvent

Bases: Struct

Event emitted when a playtest is force-denied.

Attributes:

Name Type Description
verifier_id int

Identifier of the verifier denying the playtest.
reason str

Explanation for the denial.
thread_id int

Discord thread identifier for the playtest.

reason: str instance-attribute

thread_id: int instance-attribute

verifier_id: int instance-attribute

PlaytestForceDenyRequest

Bases: Struct

Request to force-deny a playtest.

Attributes:

Name Type Description
verifier_id int

Identifier of the verifier denying the playtest.
reason str

Explanation for the denial.

reason: str instance-attribute

verifier_id: int instance-attribute

PlaytestPatchRequest

Bases: Struct

Partial update payload for playtests.

completed: bool | UnsetType = UNSET class-attribute instance-attribute

thread_creation_failure_reason: str | None | UnsetType = UNSET class-attribute instance-attribute

thread_creation_last_attempt_at: dt.datetime | UnsetType = UNSET class-attribute instance-attribute

thread_creation_status: Literal['pending', 'processing', 'success', 'failed'] | UnsetType = UNSET class-attribute instance-attribute

thread_id: int | UnsetType = UNSET class-attribute instance-attribute

verification_id: int | UnsetType = UNSET class-attribute instance-attribute

PlaytestResetEvent

Bases: Struct

Event emitted when a playtest is reset.

Attributes:

Name Type Description
verifier_id int

Identifier of the verifier performing the reset.
reason str

Explanation for the reset.
remove_votes bool

Whether votes were removed.
remove_completions bool

Whether completions were removed.
thread_id int

Discord thread identifier for the playtest.

reason: str instance-attribute

remove_completions: bool instance-attribute

remove_votes: bool instance-attribute

thread_id: int instance-attribute

verifier_id: int instance-attribute

PlaytestResetRequest

Bases: Struct

Request payload for resetting a playtest.

Attributes:

Name Type Description
verifier_id int

Identifier of the verifier performing the reset.
reason str

Explanation for the reset.
remove_votes bool

Whether to delete existing votes.
remove_completions bool

Whether to delete associated completions.

reason: str instance-attribute

remove_completions: bool instance-attribute

remove_votes: bool instance-attribute

verifier_id: int instance-attribute

PlaytestResponse

Bases: Struct

Playtest entry with status metadata.

Attributes:

Name Type Description
id int

Identifier of the playtest.
thread_id int | None

Discord thread identifier for discussion.
code OverwatchCode

Workshop code for the map.
verification_id int | None

Verification entry related to the playtest.
initial_difficulty float

Initial difficulty estimate.
created_at datetime

When the playtest was created.
updated_at datetime

When the playtest was last updated.
completed bool

Whether the playtest is complete.
thread_creation_status Literal['pending', 'processing', 'success', 'failed'] | None

Status of thread creation automation.
thread_creation_failure_reason str | None

Reason thread creation failed, if any.
thread_creation_last_attempt_at datetime | None

Timestamp of the last thread creation attempt.

code: OverwatchCode instance-attribute

completed: bool instance-attribute

created_at: dt.datetime instance-attribute

id: int instance-attribute

initial_difficulty: float instance-attribute

thread_creation_failure_reason: str | None = None class-attribute instance-attribute

thread_creation_last_attempt_at: dt.datetime | None = None class-attribute instance-attribute

thread_creation_status: Literal['pending', 'processing', 'success', 'failed'] | None = None class-attribute instance-attribute

thread_id: int | None instance-attribute

updated_at: dt.datetime instance-attribute

verification_id: int | None instance-attribute

PlaytestStatus = Literal['Approved', 'In Progress', 'Rejected'] module-attribute

PlaytestThreadAssociateRequest

Bases: Struct

Associates an existing playtest with a Discord thread.

Attributes:

Name Type Description
playtest_id int

Identifier of the playtest.
thread_id int

Discord thread identifier.

playtest_id: int instance-attribute

thread_id: int instance-attribute

PlaytestVote

Bases: Struct

Difficulty vote value for a playtest.

difficulty: float instance-attribute

PlaytestVoteCastEvent

Bases: Struct

Event emitted when a playtest vote is cast.

Attributes:

Name Type Description
voter_id int

Identifier of the voter.
difficulty_value float

Difficulty vote value.
thread_id int

Discord thread identifier for the playtest.

difficulty_value: float instance-attribute

thread_id: int instance-attribute

voter_id: int instance-attribute

PlaytestVoteCastRequest

Bases: Struct

Payload for casting a playtest difficulty vote.

Attributes:

Name Type Description
voter_id int

Identifier of the voter.
difficulty_value float

Difficulty vote value.

difficulty_value: float instance-attribute

voter_id: int instance-attribute

PlaytestVoteRemovedEvent

Bases: Struct

Event emitted when a playtest vote is removed.

Attributes:

Name Type Description
voter_id int

Identifier of the voter whose vote is removed.
thread_id int

Discord thread identifier for the playtest.

thread_id: int instance-attribute

voter_id: int instance-attribute

PlaytestVoteRemovedRequest

Bases: Struct

Request payload for removing a playtest vote.

Attributes:

Name Type Description
voter_id int

Identifier of the voter whose vote is removed.

voter_id: int instance-attribute

PlaytestVoteWithUser

Bases: Struct

Difficulty vote paired with user information.

Attributes:

Name Type Description
user_id int

Identifier of the voter.
name str

Display name of the voter.
difficulty float

Difficulty value submitted.

difficulty: float instance-attribute

name: str instance-attribute

user_id: int instance-attribute

PlaytestVotesResponse

Bases: Struct

Collection of playtest votes with aggregates.

Attributes:

Name Type Description
votes list[PlaytestVoteWithUser]

Individual votes with user context.
average float | None

Average difficulty vote.

average: float | None instance-attribute

votes: list[PlaytestVoteWithUser] instance-attribute

PopularMapsStatisticsResponse

Bases: Struct

Metrics summarizing popular maps.

Attributes:

Name Type Description
code OverwatchCode

Workshop code for the map.
completions int

Number of completions recorded.
quality float

Average quality score.
difficulty DifficultyTop

Difficulty rating for the map.
ranking int

Popularity ranking position.

code: OverwatchCode instance-attribute

completions: int instance-attribute

difficulty: DifficultyTop instance-attribute

quality: float instance-attribute

ranking: int instance-attribute

QualityValueRequest

Bases: Struct

Request payload for submitting a quality value.

Attributes:

Name Type Description
value Annotated[int, Meta(ge=1, le=6)]

Quality score between 1 and 6.

value: Annotated[int, Meta(ge=1, le=6)] instance-attribute

Restrictions = Literal['Wall Climb', 'Create Bhop', 'Dash Start', 'Death Bhop', 'Triple Jump', 'Multi Climb', 'Standing Create Bhop', 'Emote Save Bhop', 'Double Jump', 'Bhop'] module-attribute

SendToPlaytestRequest

Bases: Struct

Request payload for initiating a playtest.

Attributes:

Name Type Description
initial_difficulty DifficultyAll

Initial difficulty estimate for the playtest.

initial_difficulty: DifficultyAll instance-attribute

SortKey = Literal['difficulty:asc', 'difficulty:desc', 'checkpoints:asc', 'checkpoints:desc', 'ratings:asc', 'ratings:desc', 'map_name:asc', 'map_name:desc', 'title:asc', 'title:desc', 'code:asc', 'code:desc'] module-attribute

Tags = Literal['Other Heroes', 'XP Based', 'Custom Grav/Speed', 'Aim Parkour'] module-attribute

TopCreatorsResponse

Bases: Struct

Summary of top-performing creators.

Attributes:

Name Type Description
map_count int

Number of maps created.
name str

Creator name.
average_quality float

Average quality score across maps.

average_quality: float instance-attribute

map_count: int instance-attribute

name: str instance-attribute

TrendingMapResponse

Bases: Struct

Trending map metrics used for surfacing content.

Attributes:

Name Type Description
code OverwatchCode

Workshop code for the map.
map_name OverwatchMap

Overwatch map name.
clicks int

Number of clicks on the map.
completions int

Number of completions recorded.
upvotes int

Number of upvotes received.
momentum float

Momentum score for the map.
trend_score float

Aggregate trend score.

clicks: int instance-attribute

code: OverwatchCode instance-attribute

completions: int instance-attribute

map_name: OverwatchMap instance-attribute

momentum: float instance-attribute

trend_score: float instance-attribute

upvotes: int instance-attribute

URL_PATTERN = '(https?:\\/\\/)([\\w\\-])+\\.{1}([a-zA-Z]{2,63})([\\/\\w-]*)*\\/?\\??([^#\\n\\r]*)?#?([^\\n\\r]*)' module-attribute

URL_REGEX = re.compile(URL_PATTERN) module-attribute

UnlinkMapsCreateRequest

Bases: Struct

Request payload for unlinking a map pair.

Attributes:

Name Type Description
official_code OverwatchCode

Workshop code of the official map.
unofficial_code OverwatchCode

Workshop code of the unofficial map.
reason str

Explanation for unlinking the maps.

official_code: OverwatchCode instance-attribute

reason: str instance-attribute

unofficial_code: OverwatchCode instance-attribute

XPMultiplierRequest

Bases: Struct

Request payload for setting an XP multiplier.

Attributes:

Name Type Description
value Annotated[float, Meta(ge=1, le=10)]

Multiplier value between 1 and 10.

value: Annotated[float, Meta(ge=1, le=10)] instance-attribute

__all__ = ('MAX_CREATORS', 'PLAYTEST_VOTE_THRESHOLD', 'URL_PATTERN', 'URL_REGEX', 'ArchivalStatusPatchRequest', 'GuideFullResponse', 'GuideResponse', 'GuideURL', 'LinkMapsCreateRequest', 'MapCategory', 'MapCompletionStatisticsResponse', 'MapCountsResponse', 'MapCreateRequest', 'MapCreationJobResponse', 'MapEditCreateRequest', 'MapEditCreatedEvent', 'MapEditFieldChange', 'MapEditResolveRequest', 'MapEditResolvedEvent', 'MapEditResponse', 'MapEditSetMessageIdRequest', 'MapEditSubmissionResponse', 'MapMasteryCreateRequest', 'MapMasteryCreateResponse', 'MapMasteryResponse', 'MapPartialResponse', 'MapPatchRequest', 'MapPerDifficultyStatisticsResponse', 'MapPlaytestResponse', 'MapResponse', 'Mechanics', 'MedalType', 'MedalsResponse', 'OverwatchCode', 'OverwatchMap', 'PendingMapEditResponse', 'PlaytestApproveRequest', 'PlaytestApprovedEvent', 'PlaytestCreatePartialRequest', 'PlaytestCreateRequest', 'PlaytestCreatedEvent', 'PlaytestForceAcceptRequest', 'PlaytestForceAcceptedEvent', 'PlaytestForceDeniedEvent', 'PlaytestForceDenyRequest', 'PlaytestPatchRequest', 'PlaytestResetEvent', 'PlaytestResetRequest', 'PlaytestResponse', 'PlaytestStatus', 'PlaytestThreadAssociateRequest', 'PlaytestVote', 'PlaytestVoteCastEvent', 'PlaytestVoteCastRequest', 'PlaytestVoteRemovedEvent', 'PlaytestVoteRemovedRequest', 'PlaytestVoteWithUser', 'PlaytestVotesResponse', 'PopularMapsStatisticsResponse', 'QualityValueRequest', 'Restrictions', 'SendToPlaytestRequest', 'SortKey', 'Tags', 'TopCreatorsResponse', 'TrendingMapResponse', 'UnlinkMapsCreateRequest', 'XPMultiplierRequest', 'get_map_banner') module-attribute

get_map_banner(map_name: str) -> str

Get the applicable map banner.