Schema Models

All msgspec.structs used in the program.

class schema.Base

Bases: Struct

The base struct for all structs to inherit from.

The base struct for all structs to inherit from. Not actually used programmatically. Only exists for typing purposes.

class schema.ResponseBase

Bases: Base

The base struct for all Response structs to inherit from.

The base struct for all Response structs to inherit from. Not actually used programmatically. Only exists for typing purposes.

class schema.UserShort

Bases: Base

Shortened model of a user excluding irrelevant information.

id: str

Warframe Market user-id.

ingame_name: str

In-game name of user.

reputation: int

Reputation score

platform: str

Gaming platform used by the user

crossplay: bool

Indicates if the user has crossplay trade enabled

class schema.Order

Bases: Base

An order on Warframe Market.

id: str

Unique id of order.

order_type: str

Specifies whether the order is a ‘buy’ or ‘sell’.

platinum: int

Total platinum currency involved in the order.

quantity: int

Number of items included in the order.

created_at: str

Creation time of the order.

updated_at: str

Last modification time of the order.

item_id: str | None

Unique identifier of the item.

per_trade: int | None

Quantity per transaction.

rank: int | None

Rank or level of the item in the order.

charges: int | None

Number of charges left (requiem mods).

subtype: str | None

Subtype or category of the item.

amber_stars: int | None

Amber stars in a sculpture order.

cyan_stars: int | None

Cyan stars in a sculpture order.

class schema.OrderWithUser

Bases: Base

An order on Warframe Market with user info.

id: str

Unique id of the order.

order_type: str

Specifies whether the order is a ‘buy’ or ‘sell’.

platinum: int

Total platinum currency involved in the order.

quantity: int

Number of items included in the order.

created_at: str

Creation time of the order.

updated_at: str

Last modification time of the order.

item_id: str

Unique identifier of the item.

user: UserShort

User who created the order, with basic profile info.

per_trade: int | None

Quantity per transaction.

rank: int | None

Rank or level of the item in the order.

charges: int | None

Number of charges left (requiem mods).

subtype: str | None

Subtype or category of the item.

amber_stars: int | None

Amber stars in a sculpture order.

cyan_stars: int | None

Cyan stars in a sculpture order.

class schema.OrderResponse

Bases: ResponseBase

Response received from making the HTTP request to the API.

api_version: str

Version of the API.

data: list[OrderWithUser]

List of orders associated with the item request.

error: str | None

Error message.

class schema.Item

Bases: Base

Full item model containing information about the item.

id: str

Unique identifier of the item.

slug: str

URL-friendly name of the item.

tags: list[str]

Info tags associated with the item.

set_root: bool | None

Indicates if the item is the set root.

set_parts: list[str] | None

Parts associated with the item set.

quantity_in_set: int | None

Number of items in the set.

rarity: str | None

Rarity of the item if a mod or arcane.

max_rank: int | None

Maximum rank the item can achieve.

max_charges: int | None

Maximum charges of the item, used for requiem mods.

bulk_tradable: bool | None

Indicates if the item is bulk-tradable.

subtypes: list[str] | None

Subtype or category of the item.

max_amber_stars: int | None

Number of amber stars associated with the item.

max_cyan_stars: int | None

Number of cyan stars associated with the item.

base_endo: int | None

Base endo value of the item.

endo_multiplier: float | None

Multiplier for the endo value.

ducats: int | None

Ducats value of the item.

req_mastery_rank: int | None

Mastery rank needed to trade the particular item.

class schema.ItemResponse

Bases: ResponseBase

Response received from making the HTTP request to the API.

api_version: str

Version of the API.

data: Item

Item information associated with the request.

error: str | None

Error message.