Models#

Models for asyncpixel data objects.

pydantic model asyncpixel.models.Auction[source]#

Main auction object.

Parameters:
  • page (int) – Page of auction data.

  • total_pages (int) – Total pages of auctions.

  • total_auctions (int) – Total number of auctions.

  • last_updated (datetime.datetime) – Time last updated.

  • auctions (List[AuctionItem]) – List of auctions.

Show JSON schema
{
   "title": "Auction",
   "description": "Main auction object.\n\n    Args:\n        page (int): Page of auction data.\n        total_pages (int): Total pages of auctions.\n        total_auctions (int): Total number of auctions.\n        last_updated (datetime.datetime): Time last updated.\n        auctions (List[AuctionItem]): List of auctions.\n    ",
   "type": "object",
   "properties": {
      "page": {
         "title": "Page",
         "type": "integer"
      },
      "totalPages": {
         "title": "Totalpages",
         "type": "integer"
      },
      "totalAuctions": {
         "title": "Totalauctions",
         "type": "integer"
      },
      "lastUpdated": {
         "format": "date-time",
         "title": "Lastupdated",
         "type": "string"
      },
      "auctions": {
         "items": {
            "$ref": "#/$defs/AuctionItem"
         },
         "title": "Auctions",
         "type": "array"
      }
   },
   "$defs": {
      "AuctionItem": {
         "description": "Auction model.\n\n    Args:\n        uuid (UUID4): Id of auction.\n        auctioneer (UUID4): Id of seller.\n        profile_id (UUID4): Profile_id of seller.\n        coop (str): Amount bidded.\n        start (datetime.datetime): Start time of auction.\n        end (datetime.datetime): End time of auction.\n        item_name (str): Name of auction item.\n        item_lore (str): Lore of item.\n        extra (str): extra.\n        category (str): Item category\n        tier (str): Tier of item.\n        starting_bid (int): Starting Auction bid.\n        item_bytes (str): Bytes of item.\n        claimed (bool): Whether the auction has been won.\n        claimed_bidders (Optional[List[UUID4]]): Amount bidded.\n        highest_bid_amount (int): Highest amount bidded.\n        bids (List[Bids]): List of bids on auction.\n        id (str): Id of auction.\n        bin (bool): Whether the auction is BIN (Buy instantly)\n\n    ",
         "properties": {
            "uuid": {
               "format": "uuid4",
               "title": "Uuid",
               "type": "string"
            },
            "auctioneer": {
               "format": "uuid4",
               "title": "Auctioneer",
               "type": "string"
            },
            "profile_id": {
               "format": "uuid4",
               "title": "Profile Id",
               "type": "string"
            },
            "coop": {
               "items": {
                  "format": "uuid4",
                  "type": "string"
               },
               "title": "Coop",
               "type": "array"
            },
            "start": {
               "format": "date-time",
               "title": "Start",
               "type": "string"
            },
            "end": {
               "format": "date-time",
               "title": "End",
               "type": "string"
            },
            "item_name": {
               "title": "Item Name",
               "type": "string"
            },
            "item_lore": {
               "title": "Item Lore",
               "type": "string"
            },
            "extra": {
               "title": "Extra",
               "type": "string"
            },
            "category": {
               "title": "Category",
               "type": "string"
            },
            "tier": {
               "title": "Tier",
               "type": "string"
            },
            "starting_bid": {
               "title": "Starting Bid",
               "type": "integer"
            },
            "item_bytes": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "additionalProperties": {
                        "anyOf": [
                           {
                              "type": "integer"
                           },
                           {
                              "type": "string"
                           }
                        ]
                     },
                     "type": "object"
                  }
               ],
               "title": "Item Bytes"
            },
            "claimed": {
               "title": "Claimed",
               "type": "boolean"
            },
            "claimed_bidders": {
               "anyOf": [
                  {
                     "items": {
                        "format": "uuid4",
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Claimed Bidders"
            },
            "highest_bid_amount": {
               "title": "Highest Bid Amount",
               "type": "integer"
            },
            "bids": {
               "items": {
                  "$ref": "#/$defs/Bids"
               },
               "title": "Bids",
               "type": "array"
            },
            "_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": " Id"
            },
            "bin": {
               "default": false,
               "title": "Bin",
               "type": "boolean"
            }
         },
         "required": [
            "uuid",
            "auctioneer",
            "profile_id",
            "coop",
            "start",
            "end",
            "item_name",
            "item_lore",
            "extra",
            "category",
            "tier",
            "starting_bid",
            "item_bytes",
            "claimed",
            "highest_bid_amount",
            "bids"
         ],
         "title": "AuctionItem",
         "type": "object"
      },
      "Bids": {
         "description": "Bid models.\n\n    Args:\n        auction_id (UUID4): Id of auction.\n        bidder (UUID4): Id of bidder.\n        profile_id (UUID4): Profile_id of seller.\n        amount (str): Amount bidded.\n        timestamp (datetime.datetime): Timestamp of bid placed.\n    ",
         "properties": {
            "auction_id": {
               "format": "uuid4",
               "title": "Auction Id",
               "type": "string"
            },
            "bidder": {
               "format": "uuid4",
               "title": "Bidder",
               "type": "string"
            },
            "profile_id": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Profile Id"
            },
            "amount": {
               "title": "Amount",
               "type": "integer"
            },
            "timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            }
         },
         "required": [
            "auction_id",
            "bidder",
            "amount",
            "timestamp"
         ],
         "title": "Bids",
         "type": "object"
      }
   },
   "required": [
      "page",
      "totalPages",
      "totalAuctions",
      "lastUpdated",
      "auctions"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • auctions (List[asyncpixel.models.auctions.AuctionItem])

  • last_updated (datetime.datetime)

  • page (int)

  • total_auctions (int)

  • total_pages (int)

field auctions: List[AuctionItem] [Required]#
field last_updated: datetime [Required] (alias 'lastUpdated')#
field page: int [Required]#
field total_auctions: int [Required] (alias 'totalAuctions')#
field total_pages: int [Required] (alias 'totalPages')#
pydantic model asyncpixel.models.AuctionEnded[source]#

Main auction ended object.

Parameters:

Show JSON schema
{
   "title": "AuctionEnded",
   "description": "Main auction ended object.\n\n    Args:\n        last_updated (datetime.datetime): Time last updated.\n        auctions (List[AuctionItem]): List of auctions.\n    ",
   "type": "object",
   "properties": {
      "lastUpdated": {
         "format": "date-time",
         "title": "Lastupdated",
         "type": "string"
      },
      "auctions": {
         "items": {
            "$ref": "#/$defs/AuctionEndedItem"
         },
         "title": "Auctions",
         "type": "array"
      }
   },
   "$defs": {
      "AuctionEndedItem": {
         "description": "Ended auction model.\n\n    Args:\n        auction_id (UUID4): Id of auction.\n        seller (UUID4): Id of seller.\n        seller_profile (UUID4): Profile_id of seller.\n        buyer (str): Id of buyer.\n        timestamp (datetime.datetime): Time when the auction was bought.\n        bin (bool): Whether the auction is BIN (Buy It Now).\n        item_bytes (Union[str, Dict[str, Union[int, str]]]): NBT-encoded item data.\n        price (int): Final sell price of the auction.\n    ",
         "properties": {
            "auction_id": {
               "format": "uuid4",
               "title": "Auction Id",
               "type": "string"
            },
            "seller": {
               "format": "uuid4",
               "title": "Seller",
               "type": "string"
            },
            "seller_profile": {
               "format": "uuid4",
               "title": "Seller Profile",
               "type": "string"
            },
            "buyer": {
               "format": "uuid4",
               "title": "Buyer",
               "type": "string"
            },
            "timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            },
            "bin": {
               "default": false,
               "title": "Bin",
               "type": "boolean"
            },
            "item_bytes": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "additionalProperties": {
                        "anyOf": [
                           {
                              "type": "integer"
                           },
                           {
                              "type": "string"
                           }
                        ]
                     },
                     "type": "object"
                  }
               ],
               "title": "Item Bytes"
            },
            "price": {
               "title": "Price",
               "type": "integer"
            }
         },
         "required": [
            "auction_id",
            "seller",
            "seller_profile",
            "buyer",
            "timestamp",
            "item_bytes",
            "price"
         ],
         "title": "AuctionEndedItem",
         "type": "object"
      }
   },
   "required": [
      "lastUpdated",
      "auctions"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • auctions (List[asyncpixel.models.auctions_ended.AuctionEndedItem])

  • last_updated (datetime.datetime)

field auctions: List[AuctionEndedItem] [Required]#
field last_updated: datetime [Required] (alias 'lastUpdated')#
pydantic model asyncpixel.models.AuctionEndedItem[source]#

Ended auction model.

Parameters:
  • auction_id (UUID4) – Id of auction.

  • seller (UUID4) – Id of seller.

  • seller_profile (UUID4) – Profile_id of seller.

  • buyer (str) – Id of buyer.

  • timestamp (datetime.datetime) – Time when the auction was bought.

  • bin (bool) – Whether the auction is BIN (Buy It Now).

  • item_bytes (Union[str, Dict[str, Union[int, str]]]) – NBT-encoded item data.

  • price (int) – Final sell price of the auction.

Show JSON schema
{
   "title": "AuctionEndedItem",
   "description": "Ended auction model.\n\n    Args:\n        auction_id (UUID4): Id of auction.\n        seller (UUID4): Id of seller.\n        seller_profile (UUID4): Profile_id of seller.\n        buyer (str): Id of buyer.\n        timestamp (datetime.datetime): Time when the auction was bought.\n        bin (bool): Whether the auction is BIN (Buy It Now).\n        item_bytes (Union[str, Dict[str, Union[int, str]]]): NBT-encoded item data.\n        price (int): Final sell price of the auction.\n    ",
   "type": "object",
   "properties": {
      "auction_id": {
         "format": "uuid4",
         "title": "Auction Id",
         "type": "string"
      },
      "seller": {
         "format": "uuid4",
         "title": "Seller",
         "type": "string"
      },
      "seller_profile": {
         "format": "uuid4",
         "title": "Seller Profile",
         "type": "string"
      },
      "buyer": {
         "format": "uuid4",
         "title": "Buyer",
         "type": "string"
      },
      "timestamp": {
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      },
      "bin": {
         "default": false,
         "title": "Bin",
         "type": "boolean"
      },
      "item_bytes": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "additionalProperties": {
                  "anyOf": [
                     {
                        "type": "integer"
                     },
                     {
                        "type": "string"
                     }
                  ]
               },
               "type": "object"
            }
         ],
         "title": "Item Bytes"
      },
      "price": {
         "title": "Price",
         "type": "integer"
      }
   },
   "required": [
      "auction_id",
      "seller",
      "seller_profile",
      "buyer",
      "timestamp",
      "item_bytes",
      "price"
   ]
}

Fields:
  • auction_id (uuid.UUID[uuid.UUID])

  • bin (bool)

  • buyer (uuid.UUID[uuid.UUID])

  • item_bytes (str | Dict[str, int | str])

  • price (int)

  • seller (uuid.UUID[uuid.UUID])

  • seller_profile (uuid.UUID[uuid.UUID])

  • timestamp (datetime.datetime)

field auction_id: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field bin: bool = False#
field buyer: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field item_bytes: str | Dict[str, int | str] [Required]#
field price: int [Required]#
field seller: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field seller_profile: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field timestamp: datetime [Required]#
pydantic model asyncpixel.models.AuctionItem[source]#

Auction model.

Parameters:
  • uuid (UUID4) – Id of auction.

  • auctioneer (UUID4) – Id of seller.

  • profile_id (UUID4) – Profile_id of seller.

  • coop (str) – Amount bidded.

  • start (datetime.datetime) – Start time of auction.

  • end (datetime.datetime) – End time of auction.

  • item_name (str) – Name of auction item.

  • item_lore (str) – Lore of item.

  • extra (str) – extra.

  • category (str) – Item category

  • tier (str) – Tier of item.

  • starting_bid (int) – Starting Auction bid.

  • item_bytes (str) – Bytes of item.

  • claimed (bool) – Whether the auction has been won.

  • claimed_bidders (Optional[List[UUID4]]) – Amount bidded.

  • highest_bid_amount (int) – Highest amount bidded.

  • bids (List[Bids]) – List of bids on auction.

  • id (str) – Id of auction.

  • bin (bool) – Whether the auction is BIN (Buy instantly)

Show JSON schema
{
   "title": "AuctionItem",
   "description": "Auction model.\n\n    Args:\n        uuid (UUID4): Id of auction.\n        auctioneer (UUID4): Id of seller.\n        profile_id (UUID4): Profile_id of seller.\n        coop (str): Amount bidded.\n        start (datetime.datetime): Start time of auction.\n        end (datetime.datetime): End time of auction.\n        item_name (str): Name of auction item.\n        item_lore (str): Lore of item.\n        extra (str): extra.\n        category (str): Item category\n        tier (str): Tier of item.\n        starting_bid (int): Starting Auction bid.\n        item_bytes (str): Bytes of item.\n        claimed (bool): Whether the auction has been won.\n        claimed_bidders (Optional[List[UUID4]]): Amount bidded.\n        highest_bid_amount (int): Highest amount bidded.\n        bids (List[Bids]): List of bids on auction.\n        id (str): Id of auction.\n        bin (bool): Whether the auction is BIN (Buy instantly)\n\n    ",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid4",
         "title": "Uuid",
         "type": "string"
      },
      "auctioneer": {
         "format": "uuid4",
         "title": "Auctioneer",
         "type": "string"
      },
      "profile_id": {
         "format": "uuid4",
         "title": "Profile Id",
         "type": "string"
      },
      "coop": {
         "items": {
            "format": "uuid4",
            "type": "string"
         },
         "title": "Coop",
         "type": "array"
      },
      "start": {
         "format": "date-time",
         "title": "Start",
         "type": "string"
      },
      "end": {
         "format": "date-time",
         "title": "End",
         "type": "string"
      },
      "item_name": {
         "title": "Item Name",
         "type": "string"
      },
      "item_lore": {
         "title": "Item Lore",
         "type": "string"
      },
      "extra": {
         "title": "Extra",
         "type": "string"
      },
      "category": {
         "title": "Category",
         "type": "string"
      },
      "tier": {
         "title": "Tier",
         "type": "string"
      },
      "starting_bid": {
         "title": "Starting Bid",
         "type": "integer"
      },
      "item_bytes": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "additionalProperties": {
                  "anyOf": [
                     {
                        "type": "integer"
                     },
                     {
                        "type": "string"
                     }
                  ]
               },
               "type": "object"
            }
         ],
         "title": "Item Bytes"
      },
      "claimed": {
         "title": "Claimed",
         "type": "boolean"
      },
      "claimed_bidders": {
         "anyOf": [
            {
               "items": {
                  "format": "uuid4",
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Claimed Bidders"
      },
      "highest_bid_amount": {
         "title": "Highest Bid Amount",
         "type": "integer"
      },
      "bids": {
         "items": {
            "$ref": "#/$defs/Bids"
         },
         "title": "Bids",
         "type": "array"
      },
      "_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": " Id"
      },
      "bin": {
         "default": false,
         "title": "Bin",
         "type": "boolean"
      }
   },
   "$defs": {
      "Bids": {
         "description": "Bid models.\n\n    Args:\n        auction_id (UUID4): Id of auction.\n        bidder (UUID4): Id of bidder.\n        profile_id (UUID4): Profile_id of seller.\n        amount (str): Amount bidded.\n        timestamp (datetime.datetime): Timestamp of bid placed.\n    ",
         "properties": {
            "auction_id": {
               "format": "uuid4",
               "title": "Auction Id",
               "type": "string"
            },
            "bidder": {
               "format": "uuid4",
               "title": "Bidder",
               "type": "string"
            },
            "profile_id": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Profile Id"
            },
            "amount": {
               "title": "Amount",
               "type": "integer"
            },
            "timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            }
         },
         "required": [
            "auction_id",
            "bidder",
            "amount",
            "timestamp"
         ],
         "title": "Bids",
         "type": "object"
      }
   },
   "required": [
      "uuid",
      "auctioneer",
      "profile_id",
      "coop",
      "start",
      "end",
      "item_name",
      "item_lore",
      "extra",
      "category",
      "tier",
      "starting_bid",
      "item_bytes",
      "claimed",
      "highest_bid_amount",
      "bids"
   ]
}

Fields:
  • auctioneer (uuid.UUID[uuid.UUID])

  • bids (List[asyncpixel.models.auctions.Bids])

  • bin (bool)

  • category (str)

  • claimed (bool)

  • claimed_bidders (List[uuid.UUID[uuid.UUID]] | None)

  • coop (List[uuid.UUID[uuid.UUID]])

  • end (datetime.datetime)

  • extra (str)

  • highest_bid_amount (int)

  • id (str | None)

  • item_bytes (str | Dict[str, int | str])

  • item_lore (str)

  • item_name (str)

  • profile_id (uuid.UUID[uuid.UUID])

  • start (datetime.datetime)

  • starting_bid (int)

  • tier (str)

  • uuid (uuid.UUID[uuid.UUID])

field auctioneer: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field bids: List[Bids] [Required]#
field bin: bool = False#
field category: str [Required]#
field claimed: bool [Required]#
field claimed_bidders: List[UUID[UUID]] | None = None#
field coop: List[UUID[UUID]] [Required]#
field end: datetime [Required]#
field extra: str [Required]#
field highest_bid_amount: int [Required]#
field id: str | None = None (alias '_id')#
field item_bytes: str | Dict[str, int | str] [Required]#
field item_lore: str [Required]#
field item_name: str [Required]#
field profile_id: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field start: datetime [Required]#
field starting_bid: int [Required]#
field tier: str [Required]#
field uuid: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

active() bool[source]#

Return if auction is active - you can bid on it.

lowest_possible_bid() int[source]#

Returns next lowest possible bid.

pydantic model asyncpixel.models.Bazaar[source]#

Bazaar object.

Parameters:

Show JSON schema
{
   "title": "Bazaar",
   "description": "Bazaar object.\n\n    Args:\n        last_updated (datetime.datetime): Time last updated.\n        bazaar_items (List[BazaarItem]): Items in bazaar.\n    ",
   "type": "object",
   "properties": {
      "last_updated": {
         "format": "date-time",
         "title": "Last Updated",
         "type": "string"
      },
      "bazaar_items": {
         "items": {
            "$ref": "#/$defs/BazaarItem"
         },
         "title": "Bazaar Items",
         "type": "array"
      }
   },
   "$defs": {
      "BazaarItem": {
         "description": "Bazaar item.\n\n    Args:\n        product_id (str): Product id.\n        sell_summary (List[BazaarSellSummary]): List of sell summary.\n        buy_summary (List[BazaarBuySummary]): List of buy summary.\n        quick_status (BazaarQuickStatus): Quick status.\n    ",
         "properties": {
            "product_id": {
               "title": "Product Id",
               "type": "string"
            },
            "sell_summary": {
               "items": {
                  "$ref": "#/$defs/BazaarSummary"
               },
               "title": "Sell Summary",
               "type": "array"
            },
            "buy_summary": {
               "items": {
                  "$ref": "#/$defs/BazaarSummary"
               },
               "title": "Buy Summary",
               "type": "array"
            },
            "quick_status": {
               "$ref": "#/$defs/BazaarQuickStatus"
            }
         },
         "required": [
            "product_id",
            "sell_summary",
            "buy_summary",
            "quick_status"
         ],
         "title": "BazaarItem",
         "type": "object"
      },
      "BazaarQuickStatus": {
         "description": "Bazaar quick status.\n\n    Args:\n        product_id (str): Id of product.\n        sell_price (int): Sell price per unit.\n        sell_volume (float): Volume of sale.\n        sell_moving_week (int): Sell moving week.\n        sell_orders (int): How many orders.\n        buy_price (int): Buy price.\n        buy_volume (float): Volume of purchase.\n        buy_moving_week (int): How many orders.\n        buy_orders (int): How many orders.\n    ",
         "properties": {
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "sellPrice": {
               "title": "Sellprice",
               "type": "number"
            },
            "sellVolume": {
               "title": "Sellvolume",
               "type": "integer"
            },
            "sellMovingWeek": {
               "title": "Sellmovingweek",
               "type": "integer"
            },
            "sellOrders": {
               "title": "Sellorders",
               "type": "integer"
            },
            "buyPrice": {
               "title": "Buyprice",
               "type": "number"
            },
            "buyVolume": {
               "title": "Buyvolume",
               "type": "integer"
            },
            "buyMovingWeek": {
               "title": "Buymovingweek",
               "type": "integer"
            },
            "buyOrders": {
               "title": "Buyorders",
               "type": "integer"
            }
         },
         "required": [
            "productId",
            "sellPrice",
            "sellVolume",
            "sellMovingWeek",
            "sellOrders",
            "buyPrice",
            "buyVolume",
            "buyMovingWeek",
            "buyOrders"
         ],
         "title": "BazaarQuickStatus",
         "type": "object"
      },
      "BazaarSummary": {
         "description": "Bazaar object.\n\n    Args:\n        amount (int): Amount available to buy.\n        price_per_unit (float): Price per unit.\n        orders (int): How many orders.\n    ",
         "properties": {
            "amount": {
               "title": "Amount",
               "type": "integer"
            },
            "pricePerUnit": {
               "title": "Priceperunit",
               "type": "number"
            },
            "orders": {
               "title": "Orders",
               "type": "integer"
            }
         },
         "required": [
            "amount",
            "pricePerUnit",
            "orders"
         ],
         "title": "BazaarSummary",
         "type": "object"
      }
   },
   "required": [
      "last_updated",
      "bazaar_items"
   ]
}

Fields:
  • bazaar_items (List[asyncpixel.models.bazaar.BazaarItem])

  • last_updated (datetime.datetime)

field bazaar_items: List[BazaarItem] [Required]#
field last_updated: datetime [Required]#
pydantic model asyncpixel.models.BazaarItem[source]#

Bazaar item.

Parameters:
  • product_id (str) – Product id.

  • sell_summary (List[BazaarSellSummary]) – List of sell summary.

  • buy_summary (List[BazaarBuySummary]) – List of buy summary.

  • quick_status (BazaarQuickStatus) – Quick status.

Show JSON schema
{
   "title": "BazaarItem",
   "description": "Bazaar item.\n\n    Args:\n        product_id (str): Product id.\n        sell_summary (List[BazaarSellSummary]): List of sell summary.\n        buy_summary (List[BazaarBuySummary]): List of buy summary.\n        quick_status (BazaarQuickStatus): Quick status.\n    ",
   "type": "object",
   "properties": {
      "product_id": {
         "title": "Product Id",
         "type": "string"
      },
      "sell_summary": {
         "items": {
            "$ref": "#/$defs/BazaarSummary"
         },
         "title": "Sell Summary",
         "type": "array"
      },
      "buy_summary": {
         "items": {
            "$ref": "#/$defs/BazaarSummary"
         },
         "title": "Buy Summary",
         "type": "array"
      },
      "quick_status": {
         "$ref": "#/$defs/BazaarQuickStatus"
      }
   },
   "$defs": {
      "BazaarQuickStatus": {
         "description": "Bazaar quick status.\n\n    Args:\n        product_id (str): Id of product.\n        sell_price (int): Sell price per unit.\n        sell_volume (float): Volume of sale.\n        sell_moving_week (int): Sell moving week.\n        sell_orders (int): How many orders.\n        buy_price (int): Buy price.\n        buy_volume (float): Volume of purchase.\n        buy_moving_week (int): How many orders.\n        buy_orders (int): How many orders.\n    ",
         "properties": {
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "sellPrice": {
               "title": "Sellprice",
               "type": "number"
            },
            "sellVolume": {
               "title": "Sellvolume",
               "type": "integer"
            },
            "sellMovingWeek": {
               "title": "Sellmovingweek",
               "type": "integer"
            },
            "sellOrders": {
               "title": "Sellorders",
               "type": "integer"
            },
            "buyPrice": {
               "title": "Buyprice",
               "type": "number"
            },
            "buyVolume": {
               "title": "Buyvolume",
               "type": "integer"
            },
            "buyMovingWeek": {
               "title": "Buymovingweek",
               "type": "integer"
            },
            "buyOrders": {
               "title": "Buyorders",
               "type": "integer"
            }
         },
         "required": [
            "productId",
            "sellPrice",
            "sellVolume",
            "sellMovingWeek",
            "sellOrders",
            "buyPrice",
            "buyVolume",
            "buyMovingWeek",
            "buyOrders"
         ],
         "title": "BazaarQuickStatus",
         "type": "object"
      },
      "BazaarSummary": {
         "description": "Bazaar object.\n\n    Args:\n        amount (int): Amount available to buy.\n        price_per_unit (float): Price per unit.\n        orders (int): How many orders.\n    ",
         "properties": {
            "amount": {
               "title": "Amount",
               "type": "integer"
            },
            "pricePerUnit": {
               "title": "Priceperunit",
               "type": "number"
            },
            "orders": {
               "title": "Orders",
               "type": "integer"
            }
         },
         "required": [
            "amount",
            "pricePerUnit",
            "orders"
         ],
         "title": "BazaarSummary",
         "type": "object"
      }
   },
   "required": [
      "product_id",
      "sell_summary",
      "buy_summary",
      "quick_status"
   ]
}

Fields:
  • buy_summary (List[asyncpixel.models.bazaar.BazaarSummary])

  • product_id (str)

  • quick_status (asyncpixel.models.bazaar.BazaarQuickStatus)

  • sell_summary (List[asyncpixel.models.bazaar.BazaarSummary])

field buy_summary: List[BazaarSummary] [Required]#
field product_id: str [Required]#
field quick_status: BazaarQuickStatus [Required]#
field sell_summary: List[BazaarSummary] [Required]#
pydantic model asyncpixel.models.BazaarQuickStatus[source]#

Bazaar quick status.

Parameters:
  • product_id (str) – Id of product.

  • sell_price (int) – Sell price per unit.

  • sell_volume (float) – Volume of sale.

  • sell_moving_week (int) – Sell moving week.

  • sell_orders (int) – How many orders.

  • buy_price (int) – Buy price.

  • buy_volume (float) – Volume of purchase.

  • buy_moving_week (int) – How many orders.

  • buy_orders (int) – How many orders.

Show JSON schema
{
   "title": "BazaarQuickStatus",
   "description": "Bazaar quick status.\n\n    Args:\n        product_id (str): Id of product.\n        sell_price (int): Sell price per unit.\n        sell_volume (float): Volume of sale.\n        sell_moving_week (int): Sell moving week.\n        sell_orders (int): How many orders.\n        buy_price (int): Buy price.\n        buy_volume (float): Volume of purchase.\n        buy_moving_week (int): How many orders.\n        buy_orders (int): How many orders.\n    ",
   "type": "object",
   "properties": {
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "sellPrice": {
         "title": "Sellprice",
         "type": "number"
      },
      "sellVolume": {
         "title": "Sellvolume",
         "type": "integer"
      },
      "sellMovingWeek": {
         "title": "Sellmovingweek",
         "type": "integer"
      },
      "sellOrders": {
         "title": "Sellorders",
         "type": "integer"
      },
      "buyPrice": {
         "title": "Buyprice",
         "type": "number"
      },
      "buyVolume": {
         "title": "Buyvolume",
         "type": "integer"
      },
      "buyMovingWeek": {
         "title": "Buymovingweek",
         "type": "integer"
      },
      "buyOrders": {
         "title": "Buyorders",
         "type": "integer"
      }
   },
   "required": [
      "productId",
      "sellPrice",
      "sellVolume",
      "sellMovingWeek",
      "sellOrders",
      "buyPrice",
      "buyVolume",
      "buyMovingWeek",
      "buyOrders"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • buy_moving_week (int)

  • buy_orders (int)

  • buy_price (float)

  • buy_volume (int)

  • product_id (str)

  • sell_moving_week (int)

  • sell_orders (int)

  • sell_price (float)

  • sell_volume (int)

field buy_moving_week: int [Required] (alias 'buyMovingWeek')#
field buy_orders: int [Required] (alias 'buyOrders')#
field buy_price: float [Required] (alias 'buyPrice')#
field buy_volume: int [Required] (alias 'buyVolume')#
field product_id: str [Required] (alias 'productId')#
field sell_moving_week: int [Required] (alias 'sellMovingWeek')#
field sell_orders: int [Required] (alias 'sellOrders')#
field sell_price: float [Required] (alias 'sellPrice')#
field sell_volume: int [Required] (alias 'sellVolume')#
pydantic model asyncpixel.models.BazaarSummary[source]#

Bazaar object.

Parameters:
  • amount (int) – Amount available to buy.

  • price_per_unit (float) – Price per unit.

  • orders (int) – How many orders.

Show JSON schema
{
   "title": "BazaarSummary",
   "description": "Bazaar object.\n\n    Args:\n        amount (int): Amount available to buy.\n        price_per_unit (float): Price per unit.\n        orders (int): How many orders.\n    ",
   "type": "object",
   "properties": {
      "amount": {
         "title": "Amount",
         "type": "integer"
      },
      "pricePerUnit": {
         "title": "Priceperunit",
         "type": "number"
      },
      "orders": {
         "title": "Orders",
         "type": "integer"
      }
   },
   "required": [
      "amount",
      "pricePerUnit",
      "orders"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • amount (int)

  • orders (int)

  • price_per_unit (float)

field amount: int [Required]#
field orders: int [Required]#
field price_per_unit: float [Required] (alias 'pricePerUnit')#
pydantic model asyncpixel.models.Bids[source]#

Bid models.

Parameters:
  • auction_id (UUID4) – Id of auction.

  • bidder (UUID4) – Id of bidder.

  • profile_id (UUID4) – Profile_id of seller.

  • amount (str) – Amount bidded.

  • timestamp (datetime.datetime) – Timestamp of bid placed.

Show JSON schema
{
   "title": "Bids",
   "description": "Bid models.\n\n    Args:\n        auction_id (UUID4): Id of auction.\n        bidder (UUID4): Id of bidder.\n        profile_id (UUID4): Profile_id of seller.\n        amount (str): Amount bidded.\n        timestamp (datetime.datetime): Timestamp of bid placed.\n    ",
   "type": "object",
   "properties": {
      "auction_id": {
         "format": "uuid4",
         "title": "Auction Id",
         "type": "string"
      },
      "bidder": {
         "format": "uuid4",
         "title": "Bidder",
         "type": "string"
      },
      "profile_id": {
         "anyOf": [
            {
               "format": "uuid4",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Profile Id"
      },
      "amount": {
         "title": "Amount",
         "type": "integer"
      },
      "timestamp": {
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      }
   },
   "required": [
      "auction_id",
      "bidder",
      "amount",
      "timestamp"
   ]
}

Fields:
  • amount (int)

  • auction_id (uuid.UUID[uuid.UUID])

  • bidder (uuid.UUID[uuid.UUID])

  • profile_id (uuid.UUID[uuid.UUID] | None)

  • timestamp (datetime.datetime)

field amount: int [Required]#
field auction_id: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field bidder: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

field profile_id: UUID[UUID] | None = None#
field timestamp: datetime [Required]#
pydantic model asyncpixel.models.Booster[source]#

Main booster class.

Parameters:
  • id (str) – ID

  • purchaser_uuid (uuid.UUID) – UUID of booster.

  • amount (int) – Amount of boosters.

  • original_length (int) – Original length of booster.

  • length (int) – Length of booster.

  • game_type (GameType) – Game type.

  • date_activated (datetime.datetime) – Date boost activated.

  • stacked (Union[List[uuid.UUID], bool]) – Whether boosters stacked.

Show JSON schema
{
   "title": "Booster",
   "description": "Main booster class.\n\n    Args:\n        id (str): ID\n        purchaser_uuid (uuid.UUID): UUID of booster.\n        amount (int): Amount of boosters.\n        original_length (int): Original length of booster.\n        length (int): Length of booster.\n        game_type (GameType): Game type.\n        date_activated (datetime.datetime): Date boost activated.\n        stacked (Union[List[uuid.UUID], bool]): Whether boosters stacked.\n    ",
   "type": "object",
   "properties": {
      "_id": {
         "title": " Id",
         "type": "string"
      },
      "purchaserUuid": {
         "format": "uuid",
         "title": "Purchaseruuid",
         "type": "string"
      },
      "amount": {
         "title": "Amount",
         "type": "number"
      },
      "originalLength": {
         "title": "Originallength",
         "type": "integer"
      },
      "length": {
         "title": "Length",
         "type": "integer"
      },
      "gameType": {
         "$ref": "#/$defs/GameType"
      },
      "dateActivated": {
         "format": "date-time",
         "title": "Dateactivated",
         "type": "string"
      },
      "stacked": {
         "anyOf": [
            {
               "items": {
                  "format": "uuid",
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "boolean"
            }
         ],
         "default": false,
         "title": "Stacked"
      }
   },
   "$defs": {
      "GameType": {
         "description": "Main game class.\n\n    Args:\n        id (str): ID\n        purchaser_uuid (uuid.UUID): UUID of booster.\n        amount (int): Amount of boosters.\n        original_length (int): Original length of booster.\n        length (int): Length of booster.\n        game_type (int): Game type.\n        date_activated (datetime.datetime): Date boost activated.\n        stacked (Union[List[uuid.UUID], bool]): Whether boosters stacked.\n    ",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "type_name": {
               "title": "Type Name",
               "type": "string"
            },
            "database_name": {
               "title": "Database Name",
               "type": "string"
            },
            "lobby_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lobby Name"
            },
            "clean_name": {
               "title": "Clean Name",
               "type": "string"
            },
            "standard_name": {
               "title": "Standard Name",
               "type": "string"
            },
            "legacy": {
               "default": false,
               "title": "Legacy",
               "type": "boolean"
            }
         },
         "required": [
            "id",
            "type_name",
            "database_name",
            "clean_name",
            "standard_name"
         ],
         "title": "GameType",
         "type": "object"
      }
   },
   "required": [
      "_id",
      "purchaserUuid",
      "amount",
      "originalLength",
      "length",
      "gameType",
      "dateActivated"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • amount (float)

  • date_activated (datetime.datetime)

  • game_type (asyncpixel.constants.GameType)

  • id (str)

  • length (int)

  • original_length (int)

  • purchaser_uuid (uuid.UUID)

  • stacked (List[uuid.UUID] | bool)

Validators:
  • _validate_game_type » game_type

field amount: float [Required]#
field date_activated: datetime [Required] (alias 'dateActivated')#
field game_type: GameType [Required] (alias 'gameType')#
Validated by:
  • _validate_game_type

field id: str [Required] (alias '_id')#
field length: int [Required]#
field original_length: int [Required] (alias 'originalLength')#
field purchaser_uuid: UUID [Required] (alias 'purchaserUuid')#
field stacked: List[UUID] | bool = False#
pydantic model asyncpixel.models.Boosters[source]#

Object containing boosters.

Parameters:
  • booster_state_decrementing (bool) – Whether booster state decrementing.

  • boosters (List[Booster]) – List of boosters online.

Show JSON schema
{
   "title": "Boosters",
   "description": "Object containing boosters.\n\n    Args:\n        booster_state_decrementing (bool): Whether booster state decrementing.\n        boosters (List[Booster]): List of boosters online.\n    ",
   "type": "object",
   "properties": {
      "decrementing": {
         "title": "Decrementing",
         "type": "boolean"
      },
      "boosters": {
         "items": {
            "$ref": "#/$defs/Booster"
         },
         "title": "Boosters",
         "type": "array"
      }
   },
   "$defs": {
      "Booster": {
         "description": "Main booster class.\n\n    Args:\n        id (str): ID\n        purchaser_uuid (uuid.UUID): UUID of booster.\n        amount (int): Amount of boosters.\n        original_length (int): Original length of booster.\n        length (int): Length of booster.\n        game_type (GameType): Game type.\n        date_activated (datetime.datetime): Date boost activated.\n        stacked (Union[List[uuid.UUID], bool]): Whether boosters stacked.\n    ",
         "properties": {
            "_id": {
               "title": " Id",
               "type": "string"
            },
            "purchaserUuid": {
               "format": "uuid",
               "title": "Purchaseruuid",
               "type": "string"
            },
            "amount": {
               "title": "Amount",
               "type": "number"
            },
            "originalLength": {
               "title": "Originallength",
               "type": "integer"
            },
            "length": {
               "title": "Length",
               "type": "integer"
            },
            "gameType": {
               "$ref": "#/$defs/GameType"
            },
            "dateActivated": {
               "format": "date-time",
               "title": "Dateactivated",
               "type": "string"
            },
            "stacked": {
               "anyOf": [
                  {
                     "items": {
                        "format": "uuid",
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "default": false,
               "title": "Stacked"
            }
         },
         "required": [
            "_id",
            "purchaserUuid",
            "amount",
            "originalLength",
            "length",
            "gameType",
            "dateActivated"
         ],
         "title": "Booster",
         "type": "object"
      },
      "GameType": {
         "description": "Main game class.\n\n    Args:\n        id (str): ID\n        purchaser_uuid (uuid.UUID): UUID of booster.\n        amount (int): Amount of boosters.\n        original_length (int): Original length of booster.\n        length (int): Length of booster.\n        game_type (int): Game type.\n        date_activated (datetime.datetime): Date boost activated.\n        stacked (Union[List[uuid.UUID], bool]): Whether boosters stacked.\n    ",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "type_name": {
               "title": "Type Name",
               "type": "string"
            },
            "database_name": {
               "title": "Database Name",
               "type": "string"
            },
            "lobby_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lobby Name"
            },
            "clean_name": {
               "title": "Clean Name",
               "type": "string"
            },
            "standard_name": {
               "title": "Standard Name",
               "type": "string"
            },
            "legacy": {
               "default": false,
               "title": "Legacy",
               "type": "boolean"
            }
         },
         "required": [
            "id",
            "type_name",
            "database_name",
            "clean_name",
            "standard_name"
         ],
         "title": "GameType",
         "type": "object"
      }
   },
   "required": [
      "decrementing",
      "boosters"
   ]
}

Fields:
  • booster_state_decrementing (bool)

  • boosters (List[asyncpixel.models.booster.Booster])

field booster_state_decrementing: bool [Required] (alias 'decrementing')#
field boosters: List[Booster] [Required]#
pydantic model asyncpixel.models.Friend[source]#

Friend object.

Parameters:
  • id (bool) – Id of friend.

  • uuid_sender (UUID4) – UUID of player sending friend request.

  • uuid_receiver (UUID4) – UUID of player receiving friend request.

  • started (datetime.datetime) – Time players started being friends.

Show JSON schema
{
   "title": "Friend",
   "description": "Friend object.\n\n    Args:\n        id (bool): Id of friend.\n        uuid_sender (UUID4): UUID of player sending friend request.\n        uuid_receiver (UUID4): UUID of player receiving friend request.\n        started (datetime.datetime): Time players started being friends.\n    ",
   "type": "object",
   "properties": {
      "_id": {
         "title": " Id",
         "type": "string"
      },
      "uuidSender": {
         "format": "uuid4",
         "title": "Uuidsender",
         "type": "string"
      },
      "uuidReceiver": {
         "format": "uuid4",
         "title": "Uuidreceiver",
         "type": "string"
      },
      "started": {
         "format": "date-time",
         "title": "Started",
         "type": "string"
      }
   },
   "required": [
      "_id",
      "uuidSender",
      "uuidReceiver",
      "started"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • id (str)

  • started (datetime.datetime)

  • uuid_receiver (uuid.UUID[uuid.UUID])

  • uuid_sender (uuid.UUID[uuid.UUID])

field id: str [Required] (alias '_id')#
field started: datetime [Required]#
field uuid_receiver: UUID[UUID] [Required] (alias 'uuidReceiver')#
Constraints:
  • uuid_version = 4

field uuid_sender: UUID[UUID] [Required] (alias 'uuidSender')#
Constraints:
  • uuid_version = 4

pydantic model asyncpixel.models.Game[source]#

Game class.

Parameters:
  • date (datetime.datetime) – Time game started.

  • game_type (GameType) – Game Type.

  • mode (Optional[str]) – Game mode.

  • map (Optional[str]) – Map the game is on.

  • ended (Optional[datetime.datetime]) – Time game ended. Defaults to None.

Show JSON schema
{
   "title": "Game",
   "description": "Game class.\n\n    Args:\n        date (datetime.datetime): Time game started.\n        game_type (GameType): Game Type.\n        mode (Optional[str]): Game mode.\n        map (Optional[str]): Map the game is on.\n        ended (Optional[datetime.datetime]): Time game ended. Defaults to None.\n    ",
   "type": "object",
   "properties": {
      "date": {
         "format": "date-time",
         "title": "Date",
         "type": "string"
      },
      "gameType": {
         "$ref": "#/$defs/GameType"
      },
      "mode": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Mode"
      },
      "map": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Map"
      },
      "ended": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ended"
      }
   },
   "$defs": {
      "GameType": {
         "description": "Main game class.\n\n    Args:\n        id (str): ID\n        purchaser_uuid (uuid.UUID): UUID of booster.\n        amount (int): Amount of boosters.\n        original_length (int): Original length of booster.\n        length (int): Length of booster.\n        game_type (int): Game type.\n        date_activated (datetime.datetime): Date boost activated.\n        stacked (Union[List[uuid.UUID], bool]): Whether boosters stacked.\n    ",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "type_name": {
               "title": "Type Name",
               "type": "string"
            },
            "database_name": {
               "title": "Database Name",
               "type": "string"
            },
            "lobby_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lobby Name"
            },
            "clean_name": {
               "title": "Clean Name",
               "type": "string"
            },
            "standard_name": {
               "title": "Standard Name",
               "type": "string"
            },
            "legacy": {
               "default": false,
               "title": "Legacy",
               "type": "boolean"
            }
         },
         "required": [
            "id",
            "type_name",
            "database_name",
            "clean_name",
            "standard_name"
         ],
         "title": "GameType",
         "type": "object"
      }
   },
   "required": [
      "date",
      "gameType"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • date (datetime.datetime)

  • ended (datetime.datetime | None)

  • game_type (asyncpixel.constants.GameType)

  • map (str | None)

  • mode (str | None)

Validators:
  • _validate_game_type » game_type

field date: datetime [Required]#
field ended: datetime | None = None#
field game_type: GameType [Required] (alias 'gameType')#
Validated by:
  • _validate_game_type

field map: str | None = None#
field mode: str | None = None#
pydantic model asyncpixel.models.GameCounts[source]#

Game Count class.

Parameters:
  • games (Dict[str, GameCountsGame]) – dict of all game and their game counts.

  • player_count (int) – total number of players online.

Show JSON schema
{
   "title": "GameCounts",
   "description": "Game Count class.\n\n    Args:\n        games (Dict[str, GameCountsGame]): dict of all game and their game counts.\n        player_count (int): total number of players online.\n    ",
   "type": "object",
   "properties": {
      "games": {
         "additionalProperties": {
            "$ref": "#/$defs/GameCountsGame"
         },
         "title": "Games",
         "type": "object"
      },
      "playerCount": {
         "title": "Playercount",
         "type": "integer"
      }
   },
   "$defs": {
      "GameCountsGame": {
         "description": "Game count game.\n\n    Args:\n        players (int): Number of players in a game.\n        uuid_sender (Optional[Dict[str, int]]): Dict of game modes and people in them.\n    ",
         "properties": {
            "players": {
               "title": "Players",
               "type": "integer"
            },
            "modes": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "integer"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Modes"
            }
         },
         "required": [
            "players"
         ],
         "title": "GameCountsGame",
         "type": "object"
      }
   },
   "required": [
      "games",
      "playerCount"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • games (Dict[str, asyncpixel.models.game_count.GameCountsGame])

  • player_count (int)

field games: Dict[str, GameCountsGame] [Required]#
field player_count: int [Required] (alias 'playerCount')#
pydantic model asyncpixel.models.GameCountsGame[source]#

Game count game.

Parameters:
  • players (int) – Number of players in a game.

  • uuid_sender (Optional[Dict[str, int]]) – Dict of game modes and people in them.

Show JSON schema
{
   "title": "GameCountsGame",
   "description": "Game count game.\n\n    Args:\n        players (int): Number of players in a game.\n        uuid_sender (Optional[Dict[str, int]]): Dict of game modes and people in them.\n    ",
   "type": "object",
   "properties": {
      "players": {
         "title": "Players",
         "type": "integer"
      },
      "modes": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "integer"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Modes"
      }
   },
   "required": [
      "players"
   ]
}

Fields:
  • modes (Dict[str, int] | None)

  • players (int)

field modes: Dict[str, int] | None = None#
field players: int [Required]#
pydantic model asyncpixel.models.Guild[source]#

Guild object.

Parameters:
  • id (str) – Guild ID.

  • created (datetime.datetime) – Timestamp this guild was created at.

  • name (str) – Name of guild.

  • (str (name_lower) – Priority of role.

  • description (str) – Description of this guild that appears in the guild list and /g info.

  • tag (str) – Tag of guild.

  • exp (int) – Exp or guild.

  • members (List[GuildMembers]) – Array of guild members.

  • achievements (Dict[str, int]) – Guild achievements earned and the current progress.

  • ranks (List[Rank]) – Array of guild ranks.

  • joinable (bool) – Whether this guild can be joined using /g join.

  • legacy_ranking (int) – Ranking in the number of guild coins owned in the legacy guild system (0-indexed).

  • publicly_listed (bool) – Whether this guild is listed in the Guild Finder.

  • preferred_games (List[str]) – This guild’s set preferred games.

  • chat_mute (datetime.datetime) – Timestamp guild chat will be unmuted at, or 0 if guild chat is not muted.

  • guild_exp_by_game_type (Dict[str, str]) – Amount of EXP earned for this guild by which game it was earned in.

  • tag_color (Optional[str]) – Color of this guild’s tag, if set. Defaults to None.

Show JSON schema
{
   "title": "Guild",
   "description": "Guild object.\n\n    Args:\n        id (str): Guild ID.\n        created (datetime.datetime): Timestamp this guild was created at.\n        name (str): Name of guild.\n        name_lower (str: Priority of role.\n        description (str): Description of this guild that appears in the\n            guild list and /g info.\n        tag (str): Tag of guild.\n        exp (int): Exp or guild.\n        members (List[GuildMembers]): Array of guild members.\n        achievements (Dict[str, int]): Guild achievements earned and\n            the current progress.\n        ranks (List[Rank]): Array of guild ranks.\n        joinable (bool): Whether this guild can be joined using /g join.\n        legacy_ranking (int): Ranking in the number of guild coins owned in\n            the legacy guild system (0-indexed).\n        publicly_listed (bool): Whether this guild is listed in the Guild Finder.\n        preferred_games (List[str]): This guild's set preferred games.\n        chat_mute (datetime.datetime): Timestamp guild chat will be unmuted at,\n            or 0 if guild chat is not muted.\n        guild_exp_by_game_type (Dict[str, str]): Amount of EXP earned for this guild\n            by which game it was earned in.\n        tag_color (Optional[str]): Color of this guild's tag, if set. Defaults to None.\n    ",
   "type": "object",
   "properties": {
      "_id": {
         "title": " Id",
         "type": "string"
      },
      "created": {
         "format": "date-time",
         "title": "Created",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "name_lower": {
         "title": "Name Lower",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "tag": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tag"
      },
      "exp": {
         "title": "Exp",
         "type": "integer"
      },
      "members": {
         "items": {
            "$ref": "#/$defs/GuildMembers"
         },
         "title": "Members",
         "type": "array"
      },
      "achievements": {
         "additionalProperties": {
            "type": "integer"
         },
         "title": "Achievements",
         "type": "object"
      },
      "ranks": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Rank"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ranks"
      },
      "joinable": {
         "default": false,
         "title": "Joinable",
         "type": "boolean"
      },
      "legacyRanking": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Legacyranking"
      },
      "publiclyListed": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Publiclylisted"
      },
      "preferredGames": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Preferredgames"
      },
      "chatMute": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Chatmute"
      },
      "guildExpByGameType": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "integer"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Guildexpbygametype"
      },
      "tagColor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tagcolor"
      }
   },
   "$defs": {
      "GuildMembers": {
         "description": "Members in a guild.\n\n    Args:\n        uuid (uuid.UUID): UUID of player.\n        rank (str): Rank of player.\n        joined (datetime.datetime): Time player joined guild.\n        exp_history (Dict[str, int]): Exp history of player.\n        quest_participation (int): How many quests the player has participated in.\n        muted_till (Optional[datetime.datetime]): Time player unmuted. Defaults to None.\n    ",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "rank": {
               "title": "Rank",
               "type": "string"
            },
            "joined": {
               "format": "date-time",
               "title": "Joined",
               "type": "string"
            },
            "expHistory": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "integer"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Exphistory"
            },
            "questParticipation": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Questparticipation"
            },
            "mutedTill": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Mutedtill"
            }
         },
         "required": [
            "uuid",
            "rank",
            "joined"
         ],
         "title": "GuildMembers",
         "type": "object"
      },
      "Rank": {
         "description": "Rank.\n\n    Args:\n        name (str): Name of rank.\n        default (bool): whether its the default.\n        created (int): Created.\n        priority (int): Priority of role.\n        tag (str): Tag of role.\n    ",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "default": {
               "title": "Default",
               "type": "boolean"
            },
            "created": {
               "title": "Created",
               "type": "integer"
            },
            "priority": {
               "title": "Priority",
               "type": "integer"
            },
            "tag": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tag"
            }
         },
         "required": [
            "name",
            "default",
            "created",
            "priority"
         ],
         "title": "Rank",
         "type": "object"
      }
   },
   "required": [
      "_id",
      "created",
      "name",
      "name_lower",
      "exp",
      "members",
      "achievements"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • achievements (Dict[str, int])

  • chat_mute (datetime.datetime | None)

  • created (datetime.datetime)

  • description (str | None)

  • exp (int)

  • guild_exp_by_game_type (Dict[str, int] | None)

  • id (str)

  • joinable (bool)

  • legacy_ranking (int | None)

  • members (List[asyncpixel.models.guild.GuildMembers])

  • name (str)

  • name_lower (str)

  • preferred_games (List[str] | None)

  • publicly_listed (bool | None)

  • ranks (List[asyncpixel.models.guild.Rank] | None)

  • tag (str | None)

  • tag_color (str | None)

field achievements: Dict[str, int] [Required]#
field chat_mute: datetime | None = None (alias 'chatMute')#
field created: datetime [Required]#
field description: str | None = None#
field exp: int [Required]#
field guild_exp_by_game_type: Dict[str, int] | None = None (alias 'guildExpByGameType')#
field id: str [Required] (alias '_id')#
field joinable: bool = False#
field legacy_ranking: int | None = None (alias 'legacyRanking')#
field members: List[GuildMembers] [Required]#
field name: str [Required]#
field name_lower: str [Required]#
field preferred_games: List[str] | None = None (alias 'preferredGames')#
field publicly_listed: bool | None = None (alias 'publiclyListed')#
field ranks: List[Rank] | None = None#
field tag: str | None = None#
field tag_color: str | None = None (alias 'tagColor')#
pydantic model asyncpixel.models.GuildMembers[source]#

Members in a guild.

Parameters:
  • uuid (uuid.UUID) – UUID of player.

  • rank (str) – Rank of player.

  • joined (datetime.datetime) – Time player joined guild.

  • exp_history (Dict[str, int]) – Exp history of player.

  • quest_participation (int) – How many quests the player has participated in.

  • muted_till (Optional[datetime.datetime]) – Time player unmuted. Defaults to None.

Show JSON schema
{
   "title": "GuildMembers",
   "description": "Members in a guild.\n\n    Args:\n        uuid (uuid.UUID): UUID of player.\n        rank (str): Rank of player.\n        joined (datetime.datetime): Time player joined guild.\n        exp_history (Dict[str, int]): Exp history of player.\n        quest_participation (int): How many quests the player has participated in.\n        muted_till (Optional[datetime.datetime]): Time player unmuted. Defaults to None.\n    ",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "rank": {
         "title": "Rank",
         "type": "string"
      },
      "joined": {
         "format": "date-time",
         "title": "Joined",
         "type": "string"
      },
      "expHistory": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "integer"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Exphistory"
      },
      "questParticipation": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Questparticipation"
      },
      "mutedTill": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Mutedtill"
      }
   },
   "required": [
      "uuid",
      "rank",
      "joined"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • exp_history (Dict[str, int] | None)

  • joined (datetime.datetime)

  • muted_till (datetime.datetime | None)

  • quest_participation (int | None)

  • rank (str)

  • uuid (uuid.UUID)

field exp_history: Dict[str, int] | None = None (alias 'expHistory')#
field joined: datetime [Required]#
field muted_till: datetime | None = None (alias 'mutedTill')#
field quest_participation: int | None = None (alias 'questParticipation')#
field rank: str [Required]#
field uuid: UUID [Required]#
pydantic model asyncpixel.models.InvArmor[source]#

Armor.

Parameters:
  • type (int) – Type of armor.

  • data (str) – Data of armor.

Show JSON schema
{
   "title": "InvArmor",
   "description": "Armor.\n\n    Args:\n        type (int): Type of armor.\n        data (str): Data of armor.\n    ",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "integer"
      },
      "data": {
         "title": "Data",
         "type": "string"
      }
   },
   "required": [
      "type",
      "data"
   ]
}

Fields:
  • data (str)

  • type (int)

field data: str [Required]#
field type: int [Required]#
pydantic model asyncpixel.models.Item[source]#

News Item.

Parameters:
  • material (str) – Material of article.

  • data (Optional[int]) – Data.

Show JSON schema
{
   "title": "Item",
   "description": "News Item.\n\n    Args:\n        material (str): Material of article.\n        data (Optional[int]): Data.\n    ",
   "type": "object",
   "properties": {
      "material": {
         "title": "Material",
         "type": "string"
      },
      "data": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data"
      }
   },
   "required": [
      "material"
   ]
}

Fields:
  • data (int | None)

  • material (str)

field data: int | None = None#
field material: str [Required]#
pydantic model asyncpixel.models.Key[source]#

Main class for key data.

Parameters:
  • key (uuid.UUID) – key text.

  • owner (uuid.UUID) – uuid of owner.

  • limit (int) – Limit of toal queries.

  • queries_in_past_min (int) – Queries in the past minute.

  • total_queries (int) – Total queries using the key.

Show JSON schema
{
   "title": "Key",
   "description": "Main class for key data.\n\n    Args:\n        key (uuid.UUID): key text.\n        owner (uuid.UUID): uuid of owner.\n        limit (int): Limit of toal queries.\n        queries_in_past_min (int): Queries in the past minute.\n        total_queries (int): Total queries using the key.\n    ",
   "type": "object",
   "properties": {
      "key": {
         "format": "uuid",
         "title": "Key",
         "type": "string"
      },
      "owner": {
         "format": "uuid",
         "title": "Owner",
         "type": "string"
      },
      "limit": {
         "title": "Limit",
         "type": "integer"
      },
      "queriesInPastMin": {
         "title": "Queriesinpastmin",
         "type": "integer"
      },
      "totalQueries": {
         "title": "Totalqueries",
         "type": "integer"
      }
   },
   "required": [
      "key",
      "owner",
      "limit",
      "queriesInPastMin",
      "totalQueries"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • key (uuid.UUID)

  • limit (int)

  • owner (uuid.UUID)

  • queries_in_past_min (int)

  • total_queries (int)

field key: UUID [Required]#
field limit: int [Required]#
field owner: UUID [Required]#
field queries_in_past_min: int [Required] (alias 'queriesInPastMin')#
field total_queries: int [Required] (alias 'totalQueries')#
pydantic model asyncpixel.models.Leaderboards[source]#

Game count game.

Parameters:
  • path (int) – Path.

  • prefix (str) – Prefix.

  • title (str) – Title of leaderboard.

  • location (Tuple[int, int, int]) – Location of leaderboard in lobby.

  • count (int) – Count of leaderboards.

  • leaders (List[uuid.UUID]) – List of leaders on the leaderboard.

Show JSON schema
{
   "title": "Leaderboards",
   "description": "Game count game.\n\n    Args:\n        path (int): Path.\n        prefix (str): Prefix.\n        title (str): Title of leaderboard.\n        location (Tuple[int, int, int]): Location of leaderboard in lobby.\n        count (int): Count of leaderboards.\n        leaders (List[uuid.UUID]): List of leaders on the leaderboard.\n    ",
   "type": "object",
   "properties": {
      "path": {
         "title": "Path",
         "type": "string"
      },
      "prefix": {
         "title": "Prefix",
         "type": "string"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "location": {
         "maxItems": 3,
         "minItems": 3,
         "prefixItems": [
            {
               "type": "integer"
            },
            {
               "type": "integer"
            },
            {
               "type": "integer"
            }
         ],
         "title": "Location",
         "type": "array"
      },
      "count": {
         "title": "Count",
         "type": "integer"
      },
      "leaders": {
         "items": {
            "format": "uuid",
            "type": "string"
         },
         "title": "Leaders",
         "type": "array"
      }
   },
   "required": [
      "path",
      "prefix",
      "title",
      "location",
      "count",
      "leaders"
   ]
}

Fields:
  • count (int)

  • leaders (List[uuid.UUID])

  • location (Tuple[int, int, int])

  • path (str)

  • prefix (str)

  • title (str)

field count: int [Required]#
field leaders: List[UUID] [Required]#
field location: Tuple[int, int, int] [Required]#
field path: str [Required]#
field prefix: str [Required]#
field title: str [Required]#
pydantic model asyncpixel.models.Members[source]#

Member.

Parameters:
  • last_save (datetime.datetime) – Time last saved.

  • inv_armor (InvArmor) – Armor.

  • first_join (datetime.datetime) – Time first joined.

  • first_join_hub (Optional[datetime.datetime]) – first joined hub.

  • stats (Dict[str, int]) – Member stats.

  • objectives (Dict[str, Objective]) – Objectives.

  • tutorial (List[str]) – Tutorial.

  • quests (Dict[str, Quests]) – Quests done.

  • coin_purse (Optional[int]) – Amount of coins in purse.

  • last_death (datetime.datetime) – Time last died.

  • crafted_generators (List[str]) – Crafted generators.

  • visited_zones (Optional[List[str]]) – Visited zones.

  • fairy_souls_collected (int) – Souls collected.

  • fairy_souls (Optional[int]) – Fairy souls.

  • death_count (Optional[int]) – death count.

  • slayer_bosses (Dict[str, Dict[str, Any]]) – Slayer bosses.

  • pets (List[ProfilePet]) – Pets.

Show JSON schema
{
   "title": "Members",
   "description": "Member.\n\n    Args:\n        last_save (datetime.datetime):Time last saved.\n        inv_armor (InvArmor): Armor.\n        first_join (datetime.datetime): Time first joined.\n        first_join_hub (Optional[datetime.datetime]): first joined hub.\n        stats (Dict[str, int]): Member stats.\n        objectives (Dict[str, Objective]): Objectives.\n        tutorial (List[str]): Tutorial.\n        quests (Dict[str, Quests]): Quests done.\n        coin_purse (Optional[int]): Amount of coins in purse.\n        last_death (datetime.datetime): Time last died.\n        crafted_generators (List[str]): Crafted generators.\n        visited_zones (Optional[List[str]]): Visited zones.\n        fairy_souls_collected (int): Souls collected.\n        fairy_souls (Optional[int]): Fairy souls.\n        death_count (Optional[int]): death count.\n        slayer_bosses (Dict[str, Dict[str, Any]]): Slayer bosses.\n        pets (List[ProfilePet]): Pets.\n    ",
   "type": "object",
   "properties": {
      "last_save": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Save"
      },
      "first_join": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "First Join"
      },
      "coin_purse": {
         "default": 0,
         "title": "Coin Purse",
         "type": "number"
      },
      "fairy_souls_collected": {
         "default": 0,
         "title": "Fairy Souls Collected",
         "type": "integer"
      },
      "fairy_souls": {
         "default": 0,
         "title": "Fairy Souls",
         "type": "integer"
      },
      "fairy_exchanges": {
         "default": 0,
         "title": "Fairy Exchanges",
         "type": "integer"
      },
      "pets": {
         "default": [],
         "items": {
            "$ref": "#/$defs/ProfilePet"
         },
         "title": "Pets",
         "type": "array"
      },
      "collection": {
         "default": {},
         "title": "Collection",
         "type": "object"
      },
      "collections_unlocked": {
         "default": 0,
         "title": "Collections Unlocked",
         "type": "integer"
      },
      "inv_armor": {
         "anyOf": [
            {
               "$ref": "#/$defs/InvArmor"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "first_join_hub": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "First Join Hub"
      },
      "stats": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "number"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Stats"
      },
      "tutorial": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Tutorial",
         "type": "array"
      },
      "last_death": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Death"
      },
      "crafted_generators": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Crafted Generators",
         "type": "array"
      },
      "visited_zones": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Visited Zones",
         "type": "array"
      },
      "death_count": {
         "default": 0,
         "title": "Death Count",
         "type": "integer"
      }
   },
   "$defs": {
      "InvArmor": {
         "description": "Armor.\n\n    Args:\n        type (int): Type of armor.\n        data (str): Data of armor.\n    ",
         "properties": {
            "type": {
               "title": "Type",
               "type": "integer"
            },
            "data": {
               "title": "Data",
               "type": "string"
            }
         },
         "required": [
            "type",
            "data"
         ],
         "title": "InvArmor",
         "type": "object"
      },
      "ProfilePet": {
         "description": "Profile Pet.\n\n    Parameters\n    ----------\n    uuid : Optional[UUID4]\n        UUID of the pet\n    type : str\n        Type of the pet\n    exp : float\n        Experience of the pet\n    active : bool\n        Whether the pet is active\n    tier : str\n        Tier of the pet\n    held_item : Optional[str]\n        Item held by the pet\n    candy_used : int\n        Amount of candy used on the pet\n    skin : Optional[str]\n        Skin of the pet\n    ",
         "properties": {
            "uuid": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Uuid"
            },
            "type": {
               "title": "Type",
               "type": "string"
            },
            "exp": {
               "title": "Exp",
               "type": "number"
            },
            "active": {
               "title": "Active",
               "type": "boolean"
            },
            "tier": {
               "title": "Tier",
               "type": "string"
            },
            "heldItem": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Helditem"
            },
            "candyUsed": {
               "title": "Candyused",
               "type": "integer"
            },
            "skin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Skin"
            }
         },
         "required": [
            "type",
            "exp",
            "active",
            "tier",
            "candyUsed"
         ],
         "title": "ProfilePet",
         "type": "object"
      }
   }
}

Fields:
  • coin_purse (float)

  • collection (Dict[str, Any])

  • collections_unlocked (int)

  • crafted_generators (List[str])

  • death_count (int)

  • fairy_exchanges (int)

  • fairy_souls (int)

  • fairy_souls_collected (int)

  • first_join (datetime.datetime | None)

  • first_join_hub (int | None)

  • inv_armor (asyncpixel.models.player_profile.InvArmor | None)

  • last_death (int | None)

  • last_save (datetime.datetime | None)

  • pets (List[asyncpixel.models.pet.ProfilePet])

  • stats (Dict[str, float] | None)

  • tutorial (List[str])

  • visited_zones (List[str])

field coin_purse: float = 0#
field collection: Dict[str, Any] = {}#
field collections_unlocked: int = 0#
field crafted_generators: List[str] = []#
field death_count: int = 0#
field fairy_exchanges: int = 0#
field fairy_souls: int = 0#
field fairy_souls_collected: int = 0#
field first_join: datetime | None = None#
field first_join_hub: int | None = None#
field inv_armor: InvArmor | None = None#
field last_death: int | None = None#
field last_save: datetime | None = None#
field pets: List[ProfilePet] = []#
field stats: Dict[str, float] | None = None#
field tutorial: List[str] = []#
field visited_zones: List[str] = []#
property fairy_bonus: Dict[str, int]#

Bonus from fairy.

Returns:

Fairy bonus.

Return type:

Dict[str, int]

pydantic model asyncpixel.models.News[source]#

News object.

Parameters:
  • item (Item) – News item.

  • link (str) – Link to article.

  • text (text) – Text of news.

  • title (str) – Title of news article.

Show JSON schema
{
   "title": "News",
   "description": "News object.\n\n    Args:\n        item (Item): News item.\n        link (str): Link to article.\n        text (text): Text of news.\n        title (str): Title of news article.\n    ",
   "type": "object",
   "properties": {
      "item": {
         "$ref": "#/$defs/Item"
      },
      "link": {
         "title": "Link",
         "type": "string"
      },
      "text": {
         "title": "Text",
         "type": "string"
      },
      "title": {
         "title": "Title",
         "type": "string"
      }
   },
   "$defs": {
      "Item": {
         "description": "News Item.\n\n    Args:\n        material (str): Material of article.\n        data (Optional[int]): Data.\n    ",
         "properties": {
            "material": {
               "title": "Material",
               "type": "string"
            },
            "data": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Data"
            }
         },
         "required": [
            "material"
         ],
         "title": "Item",
         "type": "object"
      }
   },
   "required": [
      "item",
      "link",
      "text",
      "title"
   ]
}

Fields:
  • item (asyncpixel.models.news.Item)

  • link (str)

  • text (str)

  • title (str)

field item: Item [Required]#
field text: str [Required]#
field title: str [Required]#
pydantic model asyncpixel.models.Objective[source]#

Armor.

Parameters:
  • status (str) – Status of objective.

  • progress (int) – Progress through objective.

  • completed_at (Optional[datetime.datetime]) – Time compelted at. Defaults to None.

Show JSON schema
{
   "title": "Objective",
   "description": "Armor.\n\n    Args:\n        status (str): Status of objective.\n        progress (int): Progress through objective.\n        completed_at (Optional[datetime.datetime]): Time compelted at. Defaults to None.\n    ",
   "type": "object",
   "properties": {
      "status": {
         "title": "Status",
         "type": "string"
      },
      "progress": {
         "title": "Progress",
         "type": "integer"
      },
      "completed_at": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Completed At"
      }
   },
   "required": [
      "status",
      "progress"
   ]
}

Fields:
  • completed_at (datetime.datetime | None)

  • progress (int)

  • status (str)

field completed_at: datetime | None = None#
field progress: int [Required]#
field status: str [Required]#
pydantic model asyncpixel.models.Pattern[source]#

Pattern.

Parameters:
  • color (int) – colour.

  • pattern (str) – pattern.

Show JSON schema
{
   "title": "Pattern",
   "description": "Pattern.\n\n    Args:\n        color (int): colour.\n        pattern (str): pattern.\n    ",
   "type": "object",
   "properties": {
      "color": {
         "title": "Color",
         "type": "integer"
      },
      "pattern": {
         "title": "Pattern",
         "type": "string"
      }
   },
   "required": [
      "color",
      "pattern"
   ]
}

Fields:
  • color (int)

  • pattern (str)

field color: int [Required]#
field pattern: str [Required]#
pydantic model asyncpixel.models.Pet[source]#

Pet.

Parameters:
  • thirst (Optional[PetStat]) – Thirst stat

  • exercise (Optional[PetStat]) – Exercise stat

  • hunger (Optional[PetStat]) – Hunger stat

  • experience (Optional[int]) – Experience of the pet

  • name (Optional[str]) – Name of the pet

Show JSON schema
{
   "title": "Pet",
   "description": "Pet.\n\n    Parameters\n    ----------\n    thirst : Optional[PetStat]\n        Thirst stat\n    exercise : Optional[PetStat]\n        Exercise stat\n    hunger : Optional[PetStat]\n        Hunger stat\n    experience : Optional[int]\n        Experience of the pet\n    name : Optional[str]\n        Name of the pet\n    ",
   "type": "object",
   "properties": {
      "THIRST": {
         "anyOf": [
            {
               "$ref": "#/$defs/PetStat"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "EXERCISE": {
         "anyOf": [
            {
               "$ref": "#/$defs/PetStat"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "HUNGER": {
         "anyOf": [
            {
               "$ref": "#/$defs/PetStat"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "experience": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experience"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      }
   },
   "$defs": {
      "PetStat": {
         "description": "Pet State.\n\n    Parameters\n    ----------\n    timestamp : datetime.datetime\n        Timestamp of the stat\n    value : int\n        Value of the stat\n    ",
         "properties": {
            "timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "type": "integer"
            }
         },
         "required": [
            "timestamp",
            "value"
         ],
         "title": "PetStat",
         "type": "object"
      }
   }
}

Config:
  • alias_generator: function = <function to_upper at 0x7f30fa1dd8b0>

Fields:
  • exercise (asyncpixel.models.pet.PetStat | None)

  • experience (int | None)

  • hunger (asyncpixel.models.pet.PetStat | None)

  • name (str | None)

  • thirst (asyncpixel.models.pet.PetStat | None)

field exercise: PetStat | None = None (alias 'EXERCISE')#
field experience: int | None = None#
field hunger: PetStat | None = None (alias 'HUNGER')#
field name: str | None = None#
field thirst: PetStat | None = None (alias 'THIRST')#
pydantic model asyncpixel.models.PetStat[source]#

Pet State.

Parameters:

Show JSON schema
{
   "title": "PetStat",
   "description": "Pet State.\n\n    Parameters\n    ----------\n    timestamp : datetime.datetime\n        Timestamp of the stat\n    value : int\n        Value of the stat\n    ",
   "type": "object",
   "properties": {
      "timestamp": {
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "type": "integer"
      }
   },
   "required": [
      "timestamp",
      "value"
   ]
}

Fields:
  • timestamp (datetime.datetime)

  • value (int)

field timestamp: datetime [Required]#
field value: int [Required]#
pydantic model asyncpixel.models.Player[source]#

Player.

Parameters:
  • uuid (UUID4) – uuid of user.

  • displayname (Optional[str]) – Display name of user.

  • rank (Optional[str]) – Rank of user

  • first_login (datetime.datetime) – First login date.

  • last_login (Optional[datetime.datetime]) – Most recent login date.

  • last_logout (Optional[datetime.datetime]) – Last logout.

  • stats (Stats) – Stats for various game types.

  • social_media (Optional[Social]) – Social media accounts.

  • id (Optional[str]) – id of user.

  • playername (Optional[str]) – Playername.

  • known_aliases (Optional[List[str]]) – known aliases.

  • known_aliases_lower (Optional[List[str]]) – known aliases in lowercase.

  • achievements_one_time (Optional[List[str]]) – Achievements.

  • mc_version_rp (Optional[str]) – Minecraft version.

  • network_exp (Optional[float]) – Network experience.

  • karma (Optional[int]) – Player karma.

  • last_adsense_generate_time (Optional[datetime.datetime]) – Last generate time for adsense.

  • last_claimed_reward (Optional[int]) – Last claimed reward.

  • total_rewards (Optional[int]) – Total rewards.

  • total_daily_rewards (Optional[int]) – Total daily awards.

  • reward_streak (Optional[int]) – Current reward streak.

  • reward_score (Optional[int]) – Reward score.

  • reward_high_score (Optional[int]) – High score for rewards.

  • friend_requests_uuid (Optional[List[UUID4]]) – UUID of friend requests.

  • achievement_tracking (Optional[List[str]]) – Achievement tracking.

  • achievement_points (Optional[int]) – achievement points.

  • current_gadget (Optional[str]) – Current equipped gadget.

  • channel (Optional[str]) – Channel.

  • most_recent_game_type (Optional[GameType]) – Most recent Game Type that has been played.

  • level (Optional[float]) – Level of user.

  • pet_stats (Optional[Pet]) – Pet stats.

  • raw (Dict[str, Any]) – raw data

Show JSON schema
{
   "title": "Player",
   "description": "Player.\n\n    Args:\n        uuid (UUID4): uuid of user.\n        displayname (Optional[str]): Display name of user.\n        rank (Optional[str]): Rank of user\n        first_login (datetime.datetime): First login date.\n        last_login (Optional[datetime.datetime]): Most recent login date.\n        last_logout (Optional[datetime.datetime]): Last logout.\n        stats (Stats): Stats for various game types.\n        social_media (Optional[Social]): Social media accounts.\n        id (Optional[str]): id of user.\n        playername (Optional[str]): Playername.\n        known_aliases (Optional[List[str]]): known aliases.\n        known_aliases_lower (Optional[List[str]]): known aliases in lowercase.\n        achievements_one_time (Optional[List[str]]): Achievements.\n        mc_version_rp (Optional[str]): Minecraft version.\n        network_exp (Optional[float]): Network experience.\n        karma (Optional[int]): Player karma.\n        last_adsense_generate_time (Optional[datetime.datetime]): Last generate\n            time for adsense.\n        last_claimed_reward (Optional[int]): Last claimed reward.\n        total_rewards (Optional[int]): Total rewards.\n        total_daily_rewards (Optional[int]): Total daily awards.\n        reward_streak (Optional[int]): Current reward streak.\n        reward_score (Optional[int]): Reward score.\n        reward_high_score (Optional[int]): High score for rewards.\n        friend_requests_uuid (Optional[List[UUID4]]): UUID of friend requests.\n        achievement_tracking (Optional[List[str]]): Achievement tracking.\n        achievement_points (Optional[int]): achievement points.\n        current_gadget (Optional[str]): Current equipped gadget.\n        channel (Optional[str]): Channel.\n        most_recent_game_type (Optional[GameType]): Most recent Game Type that\n            has been played.\n        level (Optional[float]): Level of user.\n        pet_stats (Optional[Pet]): Pet stats.\n        raw (Dict[str, Any]): raw data\n    ",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid4",
         "title": "Uuid",
         "type": "string"
      },
      "displayname": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Displayname"
      },
      "rank": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Rank"
      },
      "firstLogin": {
         "format": "date-time",
         "title": "Firstlogin",
         "type": "string"
      },
      "lastLogin": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lastlogin"
      },
      "lastLogout": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lastlogout"
      },
      "stats": {
         "$ref": "#/$defs/Stats"
      },
      "socialMedia": {
         "anyOf": [
            {
               "$ref": "#/$defs/Social"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": " Id"
      },
      "playername": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Playername"
      },
      "knownAliases": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Knownaliases"
      },
      "knownAliasesLower": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Knownaliaseslower"
      },
      "achievementsOneTime": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Achievementsonetime"
      },
      "mcVersionRp": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Mcversionrp"
      },
      "networkExp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Networkexp"
      },
      "karma": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Karma"
      },
      "lastAdsenseGenerateTime": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lastadsensegeneratetime"
      },
      "lastClaimedReward": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lastclaimedreward"
      },
      "totalRewards": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Totalrewards"
      },
      "totalDailyRewards": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Totaldailyrewards"
      },
      "rewardStreak": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Rewardstreak"
      },
      "rewardScore": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Rewardscore"
      },
      "rewardHighScore": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Rewardhighscore"
      },
      "friendRequestsUuid": {
         "anyOf": [
            {
               "items": {
                  "format": "uuid4",
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Friendrequestsuuid"
      },
      "achievementTracking": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Achievementtracking"
      },
      "achievementPoints": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Achievementpoints"
      },
      "currentGadget": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Currentgadget"
      },
      "channel": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Channel"
      },
      "mostRecentGameType": {
         "anyOf": [
            {
               "$ref": "#/$defs/GameType"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "petStats": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/Pet"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Petstats"
      },
      "level": {
         "title": "Level",
         "type": "number"
      },
      "raw": {
         "title": "Raw",
         "type": "object"
      }
   },
   "$defs": {
      "Arcade": {
         "description": "Arcade games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Arcade",
         "type": "object"
      },
      "Arena": {
         "description": "Arena games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Arena",
         "type": "object"
      },
      "Battleground": {
         "description": "Battleground games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Battleground",
         "type": "object"
      },
      "Bedwars": {
         "description": "Bedwars Stats.\n\n    Args:\n        kills (int): Total kills across all Bedwars gamemodes. Defaults to 0.\n        wins (int): Total wins across all Bedwars gamemodes. Defaults to 0.\n        coins (int): Total coins collected. Defaults to 0.\n        games_played (int): Number of bedwars games played. Defaults to 0.\n        final_deaths (int): Number of final deaths across all Bedwars gamemodes.\n            Defaults to 0.\n        deaths (int): Number of deaths across all Bedwars gamemodes. Defaults to 0.\n        final_kills (int): Number of final kills across all Bedwars gamemodes.\n            Defaults to 0.\n        losses (int): Total bedwars games lost. Defaults to 0.\n        beds_lost (int): Number of beds lost across all Bedwars gamemodes.\n            Defaults to 0.\n        beds_broken (int): Number of beds broken across all Bedwars gamemodes.\n            Defaults to 0.\n        winstreak (int): Current winstreak. Defaults to 0.\n        experience (int): Total bedwars experience. Defaults to 0.\n        singles (Optional[BedwarsGame]): Stats for the singles Gamemode.\n        doubles (Optional[BedwarsGame]): Stats for the doubles Gamemode.\n        triples (Optional[BedwarsGame]): Stats for the triples Gamemode.\n        quads (Optional[BedwarsGame]): Stats for the quads Gamemode.\n        four_v_four (Optional[BedwarsGame]): Stats for the four vs four Gamemode.\n        quads_ultimate (Optional[BedwarsGame]): Stats for the quads ultimate Gamemode.\n        doubles_ultimate (Optional[BedwarsGame]): Stats for the doubles\n            ultimate Gamemode.\n        castle (Optional[BedwarsGame]): Stats for the castle Gamemode.\n        entity_attack_deaths (int): Deaths to an entity. Defaults to 0.\n        entity_attack_final_deaths (int): Final deaths to an entity. Defaults to 0.\n        fall_deaths (int): Overall fall deaths. Defaults to 0.\n        fall_final_deaths (int): Overall final fall deaths Defaults to 0.\n        projectile_deaths (int): Projectile deaths. Defaults to 0.\n        suffocation_deaths (int): Overall suffocation deaths. Defaults to 0.\n        magic_deaths (int): Overall magic deaths. Defaults to 0.\n        entity_explosion_deaths (int): Overall explosion deaths. Defaults to 0.\n        magic_final_deaths (int): Overall magic final deaths. Defaults to 0.\n        void_deaths (int): Overall void deaths. Defaults to 0.\n        void_final_death (int): Overall void final deaths. Defaults to 0.\n        fire_tick_final_death (int): Overall fire final deaths. Defaults to 0.\n        void_kills (int): Overall void kills. Defaults to 0.\n        entity_attack_kills (int): Overall entity attack kills. Defaults to 0.\n        entity_attack_final_kills (int): Overall entity attack final kills.\n            Defaults to 0.\n        projectile_final_kills (int): Overall projectile final kills. Defaults to 0.\n        entity_explosion_kills (int): Overall entity explosion kills. Defaults to 0.\n        projectile_kills (int): Overall projectile kills. Defaults to 0.\n        fall_final_kills (int): Overall final fall kills. Defaults to 0.\n        fall_kills (int): Overall fall kills. Defaults to 0.\n        resources_collected (int): Overall resources collected. Defaults to 0.\n        iron_resources_collected (int): Overall iron resources collected. Defaults to 0.\n        diamond_resources_collected (int): Overall diamond resources collected.\n            Defaults to 0.\n        emerald_resources_collected (int): Overall emerald resources collected.\n            Defaults to 0.\n        items_purchased (int): Overall items purchased. Defaults to 0.\n        permanent_items_purchased (int): Overall permanent items purchased.\n            Defaults to 0.\n        bedwars_box_rares (int): Bedwars boxes that are rare. Defaults to 0.\n        bedwars_box (int): Total Bedwars boxes. Defaults to 0.\n        chest_history_new (List[str]): Chest history.  Defaults to [].\n        bedwars_box_commons (int): Total common Bedwars boxes. Defaults to 0.\n        spray_glyph_field (str): Current spray glyph.  Defaults to \"\".\n        active_island_topper (str): Current island topper.  Defaults to \"\".\n        active_projectile_trail (str): Current projectile trail.  Defaults to \"\".\n        bedwars_easter_boxes (int): Bedwars easters boxes. Defaults to 0.\n        Bedwars_opened_chests (int): Total chests opened in Bedwars. Defaults to 0.\n        Bedwars_opened_rares (int): Total rare chests opened in Bedwars.\n            Defaults to 0.\n        Bedwars_opened_commons (int): Total common chests opened in Bedwars.\n            Defaults to 0.\n        active_npc_skin (str): Current active NPC skin.  Defaults to \"\".\n        favourites_2 (str): Favourites.  Defaults to \"\".\n        Bedwars_opened_epics (int): Total epic chests opened in Bedwars.\n            Defaults to 0.\n        active_death_cry (str): Equipped active death cry.  Defaults to \"\".\n        active_kill_effect (str): Equipped kill effect.  Defaults to \"\".\n        active_sprays (str): Equipped spray.  Defaults to \"\".\n        active_glyph (str): Active glyph.  Defaults to \"\".\n        selected_ultimate (str): Selected Ultimate.  Defaults to \"\".\n    ",
         "properties": {
            "kills_bedwars": {
               "default": 0,
               "title": "Kills Bedwars",
               "type": "integer"
            },
            "wins_bedwars": {
               "default": 0,
               "title": "Wins Bedwars",
               "type": "integer"
            },
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "games_played_bedwars": {
               "default": 0,
               "title": "Games Played Bedwars",
               "type": "integer"
            },
            "final_deaths_bedwars": {
               "default": 0,
               "title": "Final Deaths Bedwars",
               "type": "integer"
            },
            "deaths_bedwars": {
               "default": 0,
               "title": "Deaths Bedwars",
               "type": "integer"
            },
            "final_kills_bedwars": {
               "default": 0,
               "title": "Final Kills Bedwars",
               "type": "integer"
            },
            "losses_bedwars": {
               "default": 0,
               "title": "Losses Bedwars",
               "type": "integer"
            },
            "beds_lost_bedwars": {
               "default": 0,
               "title": "Beds Lost Bedwars",
               "type": "integer"
            },
            "beds_broken_bedwars": {
               "default": 0,
               "title": "Beds Broken Bedwars",
               "type": "integer"
            },
            "winstreak": {
               "default": 0,
               "title": "Winstreak",
               "type": "integer"
            },
            "Experience": {
               "default": 0,
               "title": "Experience",
               "type": "integer"
            },
            "singles": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "doubles": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "triples": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "quads": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "four_v_four": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "quads_ultimate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "doubles_ultimate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "castle": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "entity_attack_deaths_bedwars": {
               "default": 0,
               "title": "Entity Attack Deaths Bedwars",
               "type": "integer"
            },
            "entity_attack_final_deaths_bedwars": {
               "default": 0,
               "title": "Entity Attack Final Deaths Bedwars",
               "type": "integer"
            },
            "fall_deaths_bedwars": {
               "default": 0,
               "title": "Fall Deaths Bedwars",
               "type": "integer"
            },
            "fall_final_deaths_bedwars": {
               "default": 0,
               "title": "Fall Final Deaths Bedwars",
               "type": "integer"
            },
            "projectile_deaths_bedwars": {
               "default": 0,
               "title": "Projectile Deaths Bedwars",
               "type": "integer"
            },
            "suffocation_deaths_bedwars": {
               "default": 0,
               "title": "Suffocation Deaths Bedwars",
               "type": "integer"
            },
            "magic_deaths_bedwars": {
               "default": 0,
               "title": "Magic Deaths Bedwars",
               "type": "integer"
            },
            "entity_explosion_deaths_bedwars": {
               "default": 0,
               "title": "Entity Explosion Deaths Bedwars",
               "type": "integer"
            },
            "magic_final_deaths_bedwars": {
               "default": 0,
               "title": "Magic Final Deaths Bedwars",
               "type": "integer"
            },
            "void_deaths_bedwars": {
               "default": 0,
               "title": "Void Deaths Bedwars",
               "type": "integer"
            },
            "void_final_deaths_bedwars": {
               "default": 0,
               "title": "Void Final Deaths Bedwars",
               "type": "integer"
            },
            "fire_tick_final_deaths_bedwars": {
               "default": 0,
               "title": "Fire Tick Final Deaths Bedwars",
               "type": "integer"
            },
            "void_kills_bedwars": {
               "default": 0,
               "title": "Void Kills Bedwars",
               "type": "integer"
            },
            "entity_attack_kills_bedwars": {
               "default": 0,
               "title": "Entity Attack Kills Bedwars",
               "type": "integer"
            },
            "entity_attack_final_kills_bedwars": {
               "default": 0,
               "title": "Entity Attack Final Kills Bedwars",
               "type": "integer"
            },
            "projectile_final_kills_bedwars": {
               "default": 0,
               "title": "Projectile Final Kills Bedwars",
               "type": "integer"
            },
            "entity_explosion_kills_bedwars": {
               "default": 0,
               "title": "Entity Explosion Kills Bedwars",
               "type": "integer"
            },
            "projectile_kills_bedwars": {
               "default": 0,
               "title": "Projectile Kills Bedwars",
               "type": "integer"
            },
            "fall_final_kills_bedwars": {
               "default": 0,
               "title": "Fall Final Kills Bedwars",
               "type": "integer"
            },
            "fall_kills_bedwars": {
               "default": 0,
               "title": "Fall Kills Bedwars",
               "type": "integer"
            },
            "resources_collected_bedwars": {
               "default": 0,
               "title": "Resources Collected Bedwars",
               "type": "integer"
            },
            "iron_resources_collected_bedwars": {
               "default": 0,
               "title": "Iron Resources Collected Bedwars",
               "type": "integer"
            },
            "diamond_resources_collected_bedwars": {
               "default": 0,
               "title": "Diamond Resources Collected Bedwars",
               "type": "integer"
            },
            "emerald_resources_collected_bedwars": {
               "default": 0,
               "title": "Emerald Resources Collected Bedwars",
               "type": "integer"
            },
            "_items_purchased_bedwars": {
               "default": 0,
               "title": " Items Purchased Bedwars",
               "type": "integer"
            },
            "permanent_items_purchased_bedwars": {
               "default": 0,
               "title": "Permanent Items Purchased Bedwars",
               "type": "integer"
            },
            "bedwars_box_rares": {
               "default": 0,
               "title": "Bedwars Box Rares",
               "type": "integer"
            },
            "bedwars_box": {
               "default": 0,
               "title": "Bedwars Box",
               "type": "integer"
            },
            "chest_history_new": {
               "default": [],
               "items": {
                  "type": "string"
               },
               "title": "Chest History New",
               "type": "array"
            },
            "bedwars_box_commons": {
               "default": 0,
               "title": "Bedwars Box Commons",
               "type": "integer"
            },
            "spray_glyph_field": {
               "default": "",
               "title": "Spray Glyph Field",
               "type": "string"
            },
            "activeIslandTopper": {
               "default": "",
               "title": "Activeislandtopper",
               "type": "string"
            },
            "activeProjectileTrail": {
               "default": "",
               "title": "Activeprojectiletrail",
               "type": "string"
            },
            "Bedwars_openedChests": {
               "default": 0,
               "title": "Bedwars Openedchests",
               "type": "integer"
            },
            "Bedwars_openedRares": {
               "default": 0,
               "title": "Bedwars Openedrares",
               "type": "integer"
            },
            "Bedwars_openedCommons": {
               "default": 0,
               "title": "Bedwars Openedcommons",
               "type": "integer"
            },
            "activeNPCSkin": {
               "default": "",
               "title": "Activenpcskin",
               "type": "string"
            },
            "favourites_2": {
               "default": "",
               "title": "Favourites 2",
               "type": "string"
            },
            "Bedwars_openedEpics": {
               "default": 0,
               "title": "Bedwars Openedepics",
               "type": "integer"
            },
            "activeDeathCry": {
               "default": "",
               "title": "Activedeathcry",
               "type": "string"
            },
            "activeKillEffect": {
               "default": "",
               "title": "Activekilleffect",
               "type": "string"
            },
            "activeSprays": {
               "default": "",
               "title": "Activesprays",
               "type": "string"
            },
            "activeGlyph": {
               "default": "",
               "title": "Activeglyph",
               "type": "string"
            },
            "selected_ultimate": {
               "default": "",
               "title": "Selected Ultimate",
               "type": "string"
            }
         },
         "title": "Bedwars",
         "type": "object"
      },
      "BedwarsGame": {
         "description": "Bedwars GameMode stats.\n\n    Args:\n        items_purchased (int): Total Items purchased. Defaults to 0.\n        diamond_resources_collected (int): Total diamonds collected. Defaults to 0.\n        games_played (int): Number of games played. Defaults to 0.\n        losses (int): Games lost for this Game Mode. Defaults to 0.\n        gold_resources_collected (int): Total gold collected. Defaults to 0.\n        void_deaths (int): Deaths to the void Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n        winstreak (int): Current winstreak. Defaults to 0.\n        beds_lost (int): Total beds lost. Defaults to 0.\n        final_deaths (int): Total final deaths. Defaults to 0.\n        entity_attack_deaths (int): Number of deaths to an entity. Defaults to 0.\n        beds_broken (int): Beds broken. Defaults to 0.\n        entity_attack_final_deaths (int): Number of deaths to an entity. Defaults to 0.\n        fall_deaths (int): Total deaths from fall damage. Defaults to 0.\n        magic_deaths (int): Total deaths to magic. Defaults to 0.\n        permanent_items_purchased (int): Number of items that are not lost\n            in the game purchased. Defaults to 0.\n        void_kills (int): Kills using the void. Defaults to 0.\n        kills (int): Total Total kills. Defaults to 0.\n        wins (int): Total games won. Defaults to 0.\n        void_final_deaths (int): Total final deaths to the void. Defaults to 0.\n        final_kills (int): Total final kills. Defaults to 0.\n    ",
         "properties": {
            "items_purchased_bedwars": {
               "default": 0,
               "title": "Items Purchased Bedwars",
               "type": "integer"
            },
            "diamond_resources_collected_bedwars": {
               "default": 0,
               "title": "Diamond Resources Collected Bedwars",
               "type": "integer"
            },
            "games_played_bedwars": {
               "default": 0,
               "title": "Games Played Bedwars",
               "type": "integer"
            },
            "losses_bedwars": {
               "default": 0,
               "title": "Losses Bedwars",
               "type": "integer"
            },
            "iron_resources_collected_bedwars": {
               "default": 0,
               "title": "Iron Resources Collected Bedwars",
               "type": "integer"
            },
            "resources_collected_bedwars": {
               "default": 0,
               "title": "Resources Collected Bedwars",
               "type": "integer"
            },
            "gold_resources_collected_bedwars": {
               "default": 0,
               "title": "Gold Resources Collected Bedwars",
               "type": "integer"
            },
            "void_deaths_bedwars": {
               "default": 0,
               "title": "Void Deaths Bedwars",
               "type": "integer"
            },
            "deaths_bedwars": {
               "default": 0,
               "title": "Deaths Bedwars",
               "type": "integer"
            },
            "winstreak": {
               "default": 0,
               "title": "Winstreak",
               "type": "integer"
            },
            "beds_lost_bedwars": {
               "default": 0,
               "title": "Beds Lost Bedwars",
               "type": "integer"
            },
            "final_deaths_bedwars": {
               "default": 0,
               "title": "Final Deaths Bedwars",
               "type": "integer"
            },
            "entity_attack_deaths_bedwars": {
               "default": 0,
               "title": "Entity Attack Deaths Bedwars",
               "type": "integer"
            },
            "beds_broken_bedwars": {
               "default": 0,
               "title": "Beds Broken Bedwars",
               "type": "integer"
            },
            "entity_attack_final_deaths_bedwars": {
               "default": 0,
               "title": "Entity Attack Final Deaths Bedwars",
               "type": "integer"
            },
            "fall_deaths_bedwars": {
               "default": 0,
               "title": "Fall Deaths Bedwars",
               "type": "integer"
            },
            "magic_deaths_bedwars": {
               "default": 0,
               "title": "Magic Deaths Bedwars",
               "type": "integer"
            },
            "permanent _items_purchased_bedwars": {
               "default": 0,
               "title": "Permanent  Items Purchased Bedwars",
               "type": "integer"
            },
            "void_kills_bedwars": {
               "default": 0,
               "title": "Void Kills Bedwars",
               "type": "integer"
            },
            "kills_bedwars": {
               "default": 0,
               "title": "Kills Bedwars",
               "type": "integer"
            },
            "wins_bedwars": {
               "default": 0,
               "title": "Wins Bedwars",
               "type": "integer"
            },
            "void_final_deaths_bedwars": {
               "default": 0,
               "title": "Void Final Deaths Bedwars",
               "type": "integer"
            },
            "final_kills_bedwars": {
               "default": 0,
               "title": "Final Kills Bedwars",
               "type": "integer"
            }
         },
         "title": "BedwarsGame",
         "type": "object"
      },
      "BuildBattle": {
         "description": "Build Battle games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        games_played (int): Total games played. Defaults to 0.\n        score (int): Score. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "games_played": {
               "default": 0,
               "title": "Games Played",
               "type": "integer"
            },
            "score": {
               "default": 0,
               "title": "Score",
               "type": "integer"
            }
         },
         "title": "BuildBattle",
         "type": "object"
      },
      "Duels": {
         "description": "Duels games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        deaths (int): Totaldeaths. Defaults to 0.\n        losses (int): Games lost. Defaults to 0.\n        losses (int): Games won. Defaults to 0.\n        damage_dealt (int): Damage dealt in total. Defaults to 0.\n        rounds_played (int): Number of rounds played. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            },
            "losses": {
               "default": 0,
               "title": "Losses",
               "type": "integer"
            },
            "wins": {
               "default": 0,
               "title": "Wins",
               "type": "integer"
            },
            "damage_dealt": {
               "default": 0,
               "title": "Damage Dealt",
               "type": "integer"
            },
            "rounds_played": {
               "default": 0,
               "title": "Rounds Played",
               "type": "integer"
            }
         },
         "title": "Duels",
         "type": "object"
      },
      "GameType": {
         "description": "Main game class.\n\n    Args:\n        id (str): ID\n        purchaser_uuid (uuid.UUID): UUID of booster.\n        amount (int): Amount of boosters.\n        original_length (int): Original length of booster.\n        length (int): Length of booster.\n        game_type (int): Game type.\n        date_activated (datetime.datetime): Date boost activated.\n        stacked (Union[List[uuid.UUID], bool]): Whether boosters stacked.\n    ",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "type_name": {
               "title": "Type Name",
               "type": "string"
            },
            "database_name": {
               "title": "Database Name",
               "type": "string"
            },
            "lobby_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lobby Name"
            },
            "clean_name": {
               "title": "Clean Name",
               "type": "string"
            },
            "standard_name": {
               "title": "Standard Name",
               "type": "string"
            },
            "legacy": {
               "default": false,
               "title": "Legacy",
               "type": "boolean"
            }
         },
         "required": [
            "id",
            "type_name",
            "database_name",
            "clean_name",
            "standard_name"
         ],
         "title": "GameType",
         "type": "object"
      },
      "GingerBread": {
         "description": "GingerBread games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "GingerBread",
         "type": "object"
      },
      "Housing": {
         "description": "Housing games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        total_kills (int): Total kills. Defaults to 0.\n        total_wins (int): Total wins. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "total_kills": {
               "default": 0,
               "title": "Total Kills",
               "type": "integer"
            },
            "total_wins": {
               "default": 0,
               "title": "Total Wins",
               "type": "integer"
            }
         },
         "title": "Housing",
         "type": "object"
      },
      "HungerGames": {
         "description": "Hunger Games games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n        damage (int): Total damage dealt. Defaults to 0.\n        wins (int): Total wins. Defaults to 0.\n        games_played (int): Total games player. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            },
            "damage": {
               "default": 0,
               "title": "Damage",
               "type": "integer"
            },
            "wins": {
               "default": 0,
               "title": "Wins",
               "type": "integer"
            },
            "games_played": {
               "default": 0,
               "title": "Games Played",
               "type": "integer"
            }
         },
         "title": "HungerGames",
         "type": "object"
      },
      "Legacy": {
         "description": "Legacy games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        total_kills (int): Total kills. Defaults to 0.\n        total_wins (int): Total wins. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "total_kills": {
               "default": 0,
               "title": "Total Kills",
               "type": "integer"
            },
            "total_wins": {
               "default": 0,
               "title": "Total Wins",
               "type": "integer"
            }
         },
         "title": "Legacy",
         "type": "object"
      },
      "MCGO": {
         "description": "MCGO games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n        shots_fired (int): Total shots fired. Defaults to 0.\n        round_wins (int): Total round wins. Defaults to 0.\n        bombs_planted (int): Total bombs planted. Defaults to 0.\n        game_wins_deathmatch (int): Total games won of deathmatch. Defaults to 0.\n        wins (int): Total wins. Defaults to 0.\n        kills (int): Total kills. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            },
            "shots_fired": {
               "default": 0,
               "title": "Shots Fired",
               "type": "integer"
            },
            "round_wins": {
               "default": 0,
               "title": "Round Wins",
               "type": "integer"
            },
            "bombs_planted": {
               "default": 0,
               "title": "Bombs Planted",
               "type": "integer"
            },
            "game_wins_deathmatch": {
               "default": 0,
               "title": "Game Wins Deathmatch",
               "type": "integer"
            },
            "game_wins": {
               "default": 0,
               "title": "Game Wins",
               "type": "integer"
            },
            "kills": {
               "default": 0,
               "title": "Kills",
               "type": "integer"
            }
         },
         "title": "MCGO",
         "type": "object"
      },
      "Paintball": {
         "description": "Paintball games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n        wins (int): Total wins. Defaults to 0.\n        shots_fired (int): Total shots fired. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            },
            "wins": {
               "default": 0,
               "title": "Wins",
               "type": "integer"
            },
            "shots_fired": {
               "default": 0,
               "title": "Shots Fired",
               "type": "integer"
            }
         },
         "title": "Paintball",
         "type": "object"
      },
      "Pet": {
         "description": "Pet.\n\n    Parameters\n    ----------\n    thirst : Optional[PetStat]\n        Thirst stat\n    exercise : Optional[PetStat]\n        Exercise stat\n    hunger : Optional[PetStat]\n        Hunger stat\n    experience : Optional[int]\n        Experience of the pet\n    name : Optional[str]\n        Name of the pet\n    ",
         "properties": {
            "THIRST": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PetStat"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "EXERCISE": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PetStat"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "HUNGER": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PetStat"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "experience": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Experience"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "Pet",
         "type": "object"
      },
      "PetStat": {
         "description": "Pet State.\n\n    Parameters\n    ----------\n    timestamp : datetime.datetime\n        Timestamp of the stat\n    value : int\n        Value of the stat\n    ",
         "properties": {
            "timestamp": {
               "format": "date-time",
               "title": "Timestamp",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "type": "integer"
            }
         },
         "required": [
            "timestamp",
            "value"
         ],
         "title": "PetStat",
         "type": "object"
      },
      "Pit": {
         "description": "Pit games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        total_kills (int): Total kills. Defaults to 0.\n        total_wins (int): Total wins. Defaults to 0.\n        shots_fired (int): Total shots fired. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "total_kills": {
               "default": 0,
               "title": "Total Kills",
               "type": "integer"
            },
            "total_wins": {
               "default": 0,
               "title": "Total Wins",
               "type": "integer"
            }
         },
         "title": "Pit",
         "type": "object"
      },
      "Quake": {
         "description": "Quake games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Quake",
         "type": "object"
      },
      "SkyClash": {
         "description": "SkyClash games stats.\n\n    Args:\n        card_packs (int): Card packs. Defaults to 0.\n    ",
         "properties": {
            "card_packs": {
               "default": 0,
               "title": "Card Packs",
               "type": "integer"
            }
         },
         "title": "SkyClash",
         "type": "object"
      },
      "Skywars": {
         "description": "Skywars games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        games_played (int): Total games played. Defaults to 0.\n        tokens (int): Number of tokens. Defaults to 0.\n        souls (int): Souls. Defaults to 0.\n        winstreak (int): Current winstreak. Defaults to 0.\n        kills (int): Total kills. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n        wins (int): Total wins Defaults to 0.\n        losses (int): Total losses. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "games_played_skywars": {
               "default": 0,
               "title": "Games Played Skywars",
               "type": "integer"
            },
            "cosmetic_tokens": {
               "default": 0,
               "title": "Cosmetic Tokens",
               "type": "integer"
            },
            "souls": {
               "default": 0,
               "title": "Souls",
               "type": "integer"
            },
            "win_streak": {
               "default": 0,
               "title": "Win Streak",
               "type": "integer"
            },
            "kills": {
               "default": 0,
               "title": "Kills",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            },
            "wins": {
               "default": 0,
               "title": "Wins",
               "type": "integer"
            },
            "losses": {
               "default": 0,
               "title": "Losses",
               "type": "integer"
            }
         },
         "title": "Skywars",
         "type": "object"
      },
      "Social": {
         "description": "Social accounts.\n\n    Args:\n        twitter (Optional[str]): Twitter.\n        youtube (Optional[str]): YouTube.\n        instagram (Optional[str]): Instagram.\n        twitch (Optional[str]): Twitch.\n        discord (Optional[str]): Discord.\n        hypixel_forums (Optional[str]): Hypixel Forums.\n    ",
         "properties": {
            "twitter": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Twitter"
            },
            "youtube": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Youtube"
            },
            "instagram": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Instagram"
            },
            "twitch": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Twitch"
            },
            "discord": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Discord"
            },
            "hypixel_forums": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Hypixel Forums"
            }
         },
         "title": "Social",
         "type": "object"
      },
      "Stats": {
         "description": "Game Stats.\n\n    Args:\n        bedwars (Optional[Bedwars]): bedwars stats.\n        arcade (Optional[Arcade]): Arcade stats.\n        build_battle (Optional[BuildBattle]): Build Battle stats.\n        duels (Optional[Duels]): Duels stats.\n        battleground (Optional[Battleground]): Battleground stats.\n        hunger_games (Optional[HungerGames]): Hunger Games stats.\n        ginger_bread (Optional[GingerBread]): Ginger Bread stats.\n        paintball (Optional[Paintball]): Paintball stats.\n        quake (Optional[Quake]): Quake stats.\n        vampirez (Optional[VampireZ]): VampireZ stats.\n        tnt_games (Optional[TNTGames]): TNT Games stats.\n        uhc (Optional[UHC]): UHC stats.\n        mcgo (Optional[MCGO]): MCGO stats.\n        walls3 (Optional[Walls3]): Walls3 stats.\n        walls (Optional[Walls]): Walls stats.\n        arena (Optional[Arena]): Arena stats.\n        sky_clash (Optional[SkyClash]): SkyClash stats.\n        pit (Optional[Pit]): Pit stats.\n        housing (Optional[Housing]): Housing stats.\n        legacy (Optional[Legacy]): Legacy stats.\n    ",
         "properties": {
            "Bedwars": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Bedwars"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Arcade": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Arcade"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "BuildBattle": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BuildBattle"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Duels": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Duels"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Battleground": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Battleground"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "HungerGames": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HungerGames"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "GingerBread": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GingerBread"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Paintball": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Paintball"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Quake": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Quake"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "VampireZ": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VampireZ"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "TNTGames": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TNTGames"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "UHC": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/UHC"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "MCGO": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MCGO"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Walls3": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Walls3"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Walls": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Walls"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Arena": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Arena"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SkyClash": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SkyClash"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Pit": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Pit"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Housing": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Housing"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "Legacy": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Legacy"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SkyWars": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Skywars"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Stats",
         "type": "object"
      },
      "TNTGames": {
         "description": "TNT games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n        wins (int): Total wins. Defaults to 0.\n        record (int): Record. Defaults to 0.\n        winstreak (int): Current winstreak. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "deaths_tntrun": {
               "default": 0,
               "title": "Deaths Tntrun",
               "type": "integer"
            },
            "wins": {
               "default": 0,
               "title": "Wins",
               "type": "integer"
            },
            "record_tntrun": {
               "default": 0,
               "title": "Record Tntrun",
               "type": "integer"
            },
            "winstreak": {
               "default": 0,
               "title": "Winstreak",
               "type": "integer"
            }
         },
         "title": "TNTGames",
         "type": "object"
      },
      "UHC": {
         "description": "UHC games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "UHC",
         "type": "object"
      },
      "VampireZ": {
         "description": "VampireZ games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        human_deaths (int): Total deaths as a human. Defaults to 0.\n        vampire_deaths (int): Total deaths as a vampire. Defaults to 0.\n        zombie_kills (int): Total kills of a zombie. Defaults to 0.\n        vampire_kills (int): Total kills of a vampire. Defaults to 0.\n        most_vampire_kills_new (int): Most Vampire kills Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "human_deaths": {
               "default": 0,
               "title": "Human Deaths",
               "type": "integer"
            },
            "vampire_deaths": {
               "default": 0,
               "title": "Vampire Deaths",
               "type": "integer"
            },
            "zombie_kills": {
               "default": 0,
               "title": "Zombie Kills",
               "type": "integer"
            },
            "vampire_kills": {
               "default": 0,
               "title": "Vampire Kills",
               "type": "integer"
            },
            "most_vampire_kills_new": {
               "default": 0,
               "title": "Most Vampire Kills New",
               "type": "integer"
            }
         },
         "title": "VampireZ",
         "type": "object"
      },
      "Walls": {
         "description": "Walls games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        losses (int): Games lost. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "losses": {
               "default": 0,
               "title": "Losses",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            }
         },
         "title": "Walls",
         "type": "object"
      },
      "Walls3": {
         "description": "Walls3 games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n        losses (int): Games lost. Defaults to 0.\n        deaths (int): Total deaths. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "losses": {
               "default": 0,
               "title": "Losses",
               "type": "integer"
            },
            "deaths": {
               "default": 0,
               "title": "Deaths",
               "type": "integer"
            }
         },
         "title": "Walls3",
         "type": "object"
      }
   },
   "required": [
      "uuid",
      "firstLogin",
      "stats",
      "level",
      "raw"
   ]
}

Config:
  • alias_generator: function = <function to_camel at 0x7f30fa1dd820>

Fields:
  • achievement_points (int | None)

  • achievement_tracking (List[str] | None)

  • achievements_one_time (List[str] | None)

  • channel (str | None)

  • current_gadget (str | None)

  • displayname (str | None)

  • first_login (datetime.datetime)

  • friend_requests_uuid (List[uuid.UUID[uuid.UUID]] | None)

  • id (str | None)

  • karma (int | None)

  • known_aliases (List[str] | None)

  • known_aliases_lower (List[str] | None)

  • last_adsense_generate_time (datetime.datetime | None)

  • last_claimed_reward (int | None)

  • last_login (datetime.datetime | None)

  • last_logout (datetime.datetime | None)

  • level (float)

  • mc_version_rp (str | None)

  • most_recent_game_type (asyncpixel.constants.GameType | None)

  • network_exp (float | None)

  • pet_stats (Dict[str, asyncpixel.models.pet.Pet] | None)

  • playername (str | None)

  • rank (str | None)

  • raw (Dict[str, Any])

  • reward_high_score (int | None)

  • reward_score (int | None)

  • reward_streak (int | None)

  • social_media (asyncpixel.models.player.Social | None)

  • stats (asyncpixel.models.player.Stats)

  • total_daily_rewards (int | None)

  • total_rewards (int | None)

  • uuid (uuid.UUID[uuid.UUID])

Validators:
  • _validate_game_type » most_recent_game_type

  • create_level » all fields

  • create_rank » all fields

  • create_raw » all fields

field achievement_points: int | None = None (alias 'achievementPoints')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field achievement_tracking: List[str] | None = None (alias 'achievementTracking')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field achievements_one_time: List[str] | None = None (alias 'achievementsOneTime')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field channel: str | None = None#
Validated by:
  • create_level

  • create_rank

  • create_raw

field current_gadget: str | None = None (alias 'currentGadget')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field displayname: str | None = None#
Validated by:
  • create_level

  • create_rank

  • create_raw

field first_login: datetime [Required] (alias 'firstLogin')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field friend_requests_uuid: List[UUID[UUID]] | None = None (alias 'friendRequestsUuid')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field id: str | None = None (alias '_id')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field karma: int | None = None#
Validated by:
  • create_level

  • create_rank

  • create_raw

field known_aliases: List[str] | None = None (alias 'knownAliases')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field known_aliases_lower: List[str] | None = None (alias 'knownAliasesLower')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field last_adsense_generate_time: datetime | None = None (alias 'lastAdsenseGenerateTime')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field last_claimed_reward: int | None = None (alias 'lastClaimedReward')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field last_login: datetime | None = None (alias 'lastLogin')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field last_logout: datetime | None = None (alias 'lastLogout')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field level: float [Required]#
Validated by:
  • create_level

  • create_rank

  • create_raw

field mc_version_rp: str | None = None (alias 'mcVersionRp')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field most_recent_game_type: GameType | None = None (alias 'mostRecentGameType')#
Validated by:
  • _validate_game_type

  • create_level

  • create_rank

  • create_raw

field network_exp: float | None = None (alias 'networkExp')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field pet_stats: Dict[str, Pet] | None = None (alias 'petStats')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field playername: str | None = None#
Validated by:
  • create_level

  • create_rank

  • create_raw

field rank: str | None = None#
Validated by:
  • create_level

  • create_rank

  • create_raw

field raw: Dict[str, Any] [Required]#
Validated by:
  • create_level

  • create_rank

  • create_raw

field reward_high_score: int | None = None (alias 'rewardHighScore')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field reward_score: int | None = None (alias 'rewardScore')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field reward_streak: int | None = None (alias 'rewardStreak')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field social_media: Social | None = None (alias 'socialMedia')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field stats: Stats [Required]#
Validated by:
  • create_level

  • create_rank

  • create_raw

field total_daily_rewards: int | None = None (alias 'totalDailyRewards')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field total_rewards: int | None = None (alias 'totalRewards')#
Validated by:
  • create_level

  • create_rank

  • create_raw

field uuid: UUID[UUID] [Required]#
Constraints:
  • uuid_version = 4

Validated by:
  • create_level

  • create_rank

  • create_raw

validator create_level  »  all fields[source]#

Create level.

validator create_rank  »  all fields[source]#

Get the rank.

validator create_raw  »  all fields[source]#

Create a copy of the values to directly access.

pydantic model asyncpixel.models.Profile[source]#

Profile.

Parameters:
  • profile_id (str) – Id of profile

  • cute_name (Optional[str]) – Cute name of profile

  • members (Dict[str, Members]) – Dict of all members in profile.

Show JSON schema
{
   "title": "Profile",
   "description": "Profile.\n\n    Args:\n        profile_id (str): Id of profile\n        cute_name (Optional[str]): Cute name of profile\n        members (Dict[str, Members]): Dict of all members in profile.\n    ",
   "type": "object",
   "properties": {
      "profile_id": {
         "format": "uuid",
         "title": "Profile Id",
         "type": "string"
      },
      "cute_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cute Name"
      },
      "members": {
         "additionalProperties": {
            "$ref": "#/$defs/Members"
         },
         "title": "Members",
         "type": "object"
      },
      "banking": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Banking"
      },
      "community_upgrades": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Community Upgrades"
      }
   },
   "$defs": {
      "InvArmor": {
         "description": "Armor.\n\n    Args:\n        type (int): Type of armor.\n        data (str): Data of armor.\n    ",
         "properties": {
            "type": {
               "title": "Type",
               "type": "integer"
            },
            "data": {
               "title": "Data",
               "type": "string"
            }
         },
         "required": [
            "type",
            "data"
         ],
         "title": "InvArmor",
         "type": "object"
      },
      "Members": {
         "description": "Member.\n\n    Args:\n        last_save (datetime.datetime):Time last saved.\n        inv_armor (InvArmor): Armor.\n        first_join (datetime.datetime): Time first joined.\n        first_join_hub (Optional[datetime.datetime]): first joined hub.\n        stats (Dict[str, int]): Member stats.\n        objectives (Dict[str, Objective]): Objectives.\n        tutorial (List[str]): Tutorial.\n        quests (Dict[str, Quests]): Quests done.\n        coin_purse (Optional[int]): Amount of coins in purse.\n        last_death (datetime.datetime): Time last died.\n        crafted_generators (List[str]): Crafted generators.\n        visited_zones (Optional[List[str]]): Visited zones.\n        fairy_souls_collected (int): Souls collected.\n        fairy_souls (Optional[int]): Fairy souls.\n        death_count (Optional[int]): death count.\n        slayer_bosses (Dict[str, Dict[str, Any]]): Slayer bosses.\n        pets (List[ProfilePet]): Pets.\n    ",
         "properties": {
            "last_save": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Last Save"
            },
            "first_join": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "First Join"
            },
            "coin_purse": {
               "default": 0,
               "title": "Coin Purse",
               "type": "number"
            },
            "fairy_souls_collected": {
               "default": 0,
               "title": "Fairy Souls Collected",
               "type": "integer"
            },
            "fairy_souls": {
               "default": 0,
               "title": "Fairy Souls",
               "type": "integer"
            },
            "fairy_exchanges": {
               "default": 0,
               "title": "Fairy Exchanges",
               "type": "integer"
            },
            "pets": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/ProfilePet"
               },
               "title": "Pets",
               "type": "array"
            },
            "collection": {
               "default": {},
               "title": "Collection",
               "type": "object"
            },
            "collections_unlocked": {
               "default": 0,
               "title": "Collections Unlocked",
               "type": "integer"
            },
            "inv_armor": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/InvArmor"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "first_join_hub": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "First Join Hub"
            },
            "stats": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "number"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Stats"
            },
            "tutorial": {
               "default": [],
               "items": {
                  "type": "string"
               },
               "title": "Tutorial",
               "type": "array"
            },
            "last_death": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Last Death"
            },
            "crafted_generators": {
               "default": [],
               "items": {
                  "type": "string"
               },
               "title": "Crafted Generators",
               "type": "array"
            },
            "visited_zones": {
               "default": [],
               "items": {
                  "type": "string"
               },
               "title": "Visited Zones",
               "type": "array"
            },
            "death_count": {
               "default": 0,
               "title": "Death Count",
               "type": "integer"
            }
         },
         "title": "Members",
         "type": "object"
      },
      "ProfilePet": {
         "description": "Profile Pet.\n\n    Parameters\n    ----------\n    uuid : Optional[UUID4]\n        UUID of the pet\n    type : str\n        Type of the pet\n    exp : float\n        Experience of the pet\n    active : bool\n        Whether the pet is active\n    tier : str\n        Tier of the pet\n    held_item : Optional[str]\n        Item held by the pet\n    candy_used : int\n        Amount of candy used on the pet\n    skin : Optional[str]\n        Skin of the pet\n    ",
         "properties": {
            "uuid": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Uuid"
            },
            "type": {
               "title": "Type",
               "type": "string"
            },
            "exp": {
               "title": "Exp",
               "type": "number"
            },
            "active": {
               "title": "Active",
               "type": "boolean"
            },
            "tier": {
               "title": "Tier",
               "type": "string"
            },
            "heldItem": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Helditem"
            },
            "candyUsed": {
               "title": "Candyused",
               "type": "integer"
            },
            "skin": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Skin"
            }
         },
         "required": [
            "type",
            "exp",
            "active",
            "tier",
            "candyUsed"
         ],
         "title": "ProfilePet",
         "type": "object"
      }
   },
   "required": [
      "profile_id",
      "members"
   ]
}

Fields:
  • banking (Dict[str, Any] | None)

  • community_upgrades (Dict[str, Any] | None)

  • cute_name (str | None)

  • members (Dict[str, asyncpixel.models.player_profile.Members])

  • profile_id (uuid.UUID)

field banking: Dict[str, Any] | None = None#
field community_upgrades: Dict[str, Any] | None = None#
field cute_name: str | None = None#
field members: Dict[str, Members] [Required]#
field profile_id: UUID [Required]#
pydantic model asyncpixel.models.Quests[source]#

Armor.

Parameters:

Show JSON schema
{
   "title": "Quests",
   "description": "Armor.\n\n    Args:\n        status (str): Status of quest.\n        activated_at (datetime.datetime): Time activated.\n        activated_at_sb (datetime.datetime): Time activated.\n        completed_at (datetime.datetime): Time Completed.\n        completed_at_sb (datetime.datetime): Time Completed.\n    ",
   "type": "object",
   "properties": {
      "status": {
         "title": "Status",
         "type": "string"
      },
      "activated_at": {
         "format": "date-time",
         "title": "Activated At",
         "type": "string"
      },
      "activated_at_sb": {
         "format": "date-time",
         "title": "Activated At Sb",
         "type": "string"
      },
      "completed_at": {
         "format": "date-time",
         "title": "Completed At",
         "type": "string"
      },
      "completed_at_sb": {
         "format": "date-time",
         "title": "Completed At Sb",
         "type": "string"
      }
   },
   "required": [
      "status",
      "activated_at",
      "activated_at_sb",
      "completed_at",
      "completed_at_sb"
   ]
}

Fields:
  • activated_at (datetime.datetime)

  • activated_at_sb (datetime.datetime)

  • completed_at (datetime.datetime)

  • completed_at_sb (datetime.datetime)

  • status (str)

field activated_at: datetime [Required]#
field activated_at_sb: datetime [Required]#
field completed_at: datetime [Required]#
field completed_at_sb: datetime [Required]#
field status: str [Required]#
pydantic model asyncpixel.models.Rank[source]#

Rank.

Parameters:
  • name (str) – Name of rank.

  • default (bool) – whether its the default.

  • created (int) – Created.

  • priority (int) – Priority of role.

  • tag (str) – Tag of role.

Show JSON schema
{
   "title": "Rank",
   "description": "Rank.\n\n    Args:\n        name (str): Name of rank.\n        default (bool): whether its the default.\n        created (int): Created.\n        priority (int): Priority of role.\n        tag (str): Tag of role.\n    ",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "default": {
         "title": "Default",
         "type": "boolean"
      },
      "created": {
         "title": "Created",
         "type": "integer"
      },
      "priority": {
         "title": "Priority",
         "type": "integer"
      },
      "tag": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tag"
      }
   },
   "required": [
      "name",
      "default",
      "created",
      "priority"
   ]
}

Fields:
  • created (int)

  • default (bool)

  • name (str)

  • priority (int)

  • tag (str | None)

field created: int [Required]#
field default: bool [Required]#
field name: str [Required]#
field priority: int [Required]#
field tag: str | None = None#
pydantic model asyncpixel.models.Social[source]#

Social accounts.

Parameters:
  • twitter (Optional[str]) – Twitter.

  • youtube (Optional[str]) – YouTube.

  • instagram (Optional[str]) – Instagram.

  • twitch (Optional[str]) – Twitch.

  • discord (Optional[str]) – Discord.

  • hypixel_forums (Optional[str]) – Hypixel Forums.

Show JSON schema
{
   "title": "Social",
   "description": "Social accounts.\n\n    Args:\n        twitter (Optional[str]): Twitter.\n        youtube (Optional[str]): YouTube.\n        instagram (Optional[str]): Instagram.\n        twitch (Optional[str]): Twitch.\n        discord (Optional[str]): Discord.\n        hypixel_forums (Optional[str]): Hypixel Forums.\n    ",
   "type": "object",
   "properties": {
      "twitter": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Twitter"
      },
      "youtube": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Youtube"
      },
      "instagram": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Instagram"
      },
      "twitch": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Twitch"
      },
      "discord": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Discord"
      },
      "hypixel_forums": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Hypixel Forums"
      }
   }
}

Fields:
  • discord (str | None)

  • hypixel_forums (str | None)

  • instagram (str | None)

  • twitch (str | None)

  • twitter (str | None)

  • youtube (str | None)

Validators:
  • get_social_media » all fields

field discord: str | None = None#
Validated by:
  • get_social_media

field hypixel_forums: str | None = None#
Validated by:
  • get_social_media

field instagram: str | None = None#
Validated by:
  • get_social_media

field twitch: str | None = None#
Validated by:
  • get_social_media

field twitter: str | None = None#
Validated by:
  • get_social_media

field youtube: str | None = None#
Validated by:
  • get_social_media

validator get_social_media  »  all fields[source]#

Get social media in correct format.

pydantic model asyncpixel.models.Stats[source]#

Game Stats.

Parameters:
  • bedwars (Optional[Bedwars]) – bedwars stats.

  • arcade (Optional[Arcade]) – Arcade stats.

  • build_battle (Optional[BuildBattle]) – Build Battle stats.

  • duels (Optional[Duels]) – Duels stats.

  • battleground (Optional[Battleground]) – Battleground stats.

  • hunger_games (Optional[HungerGames]) – Hunger Games stats.

  • ginger_bread (Optional[GingerBread]) – Ginger Bread stats.

  • paintball (Optional[Paintball]) – Paintball stats.

  • quake (Optional[Quake]) – Quake stats.

  • vampirez (Optional[VampireZ]) – VampireZ stats.

  • tnt_games (Optional[TNTGames]) – TNT Games stats.

  • uhc (Optional[UHC]) – UHC stats.

  • mcgo (Optional[MCGO]) – MCGO stats.

  • walls3 (Optional[Walls3]) – Walls3 stats.

  • walls (Optional[Walls]) – Walls stats.

  • arena (Optional[Arena]) – Arena stats.

  • sky_clash (Optional[SkyClash]) – SkyClash stats.

  • pit (Optional[Pit]) – Pit stats.

  • housing (Optional[Housing]) – Housing stats.

  • legacy (Optional[Legacy]) – Legacy stats.

Show JSON schema
{
   "title": "Stats",
   "description": "Game Stats.\n\n    Args:\n        bedwars (Optional[Bedwars]): bedwars stats.\n        arcade (Optional[Arcade]): Arcade stats.\n        build_battle (Optional[BuildBattle]): Build Battle stats.\n        duels (Optional[Duels]): Duels stats.\n        battleground (Optional[Battleground]): Battleground stats.\n        hunger_games (Optional[HungerGames]): Hunger Games stats.\n        ginger_bread (Optional[GingerBread]): Ginger Bread stats.\n        paintball (Optional[Paintball]): Paintball stats.\n        quake (Optional[Quake]): Quake stats.\n        vampirez (Optional[VampireZ]): VampireZ stats.\n        tnt_games (Optional[TNTGames]): TNT Games stats.\n        uhc (Optional[UHC]): UHC stats.\n        mcgo (Optional[MCGO]): MCGO stats.\n        walls3 (Optional[Walls3]): Walls3 stats.\n        walls (Optional[Walls]): Walls stats.\n        arena (Optional[Arena]): Arena stats.\n        sky_clash (Optional[SkyClash]): SkyClash stats.\n        pit (Optional[Pit]): Pit stats.\n        housing (Optional[Housing]): Housing stats.\n        legacy (Optional[Legacy]): Legacy stats.\n    ",
   "type": "object",
   "properties": {
      "Bedwars": {
         "anyOf": [
            {
               "$ref": "#/$defs/Bedwars"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Arcade": {
         "anyOf": [
            {
               "$ref": "#/$defs/Arcade"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "BuildBattle": {
         "anyOf": [
            {
               "$ref": "#/$defs/BuildBattle"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Duels": {
         "anyOf": [
            {
               "$ref": "#/$defs/Duels"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Battleground": {
         "anyOf": [
            {
               "$ref": "#/$defs/Battleground"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "HungerGames": {
         "anyOf": [
            {
               "$ref": "#/$defs/HungerGames"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "GingerBread": {
         "anyOf": [
            {
               "$ref": "#/$defs/GingerBread"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Paintball": {
         "anyOf": [
            {
               "$ref": "#/$defs/Paintball"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Quake": {
         "anyOf": [
            {
               "$ref": "#/$defs/Quake"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "VampireZ": {
         "anyOf": [
            {
               "$ref": "#/$defs/VampireZ"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "TNTGames": {
         "anyOf": [
            {
               "$ref": "#/$defs/TNTGames"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "UHC": {
         "anyOf": [
            {
               "$ref": "#/$defs/UHC"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "MCGO": {
         "anyOf": [
            {
               "$ref": "#/$defs/MCGO"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Walls3": {
         "anyOf": [
            {
               "$ref": "#/$defs/Walls3"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Walls": {
         "anyOf": [
            {
               "$ref": "#/$defs/Walls"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Arena": {
         "anyOf": [
            {
               "$ref": "#/$defs/Arena"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "SkyClash": {
         "anyOf": [
            {
               "$ref": "#/$defs/SkyClash"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Pit": {
         "anyOf": [
            {
               "$ref": "#/$defs/Pit"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Housing": {
         "anyOf": [
            {
               "$ref": "#/$defs/Housing"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "Legacy": {
         "anyOf": [
            {
               "$ref": "#/$defs/Legacy"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "SkyWars": {
         "anyOf": [
            {
               "$ref": "#/$defs/Skywars"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "Arcade": {
         "description": "Arcade games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Arcade",
         "type": "object"
      },
      "Arena": {
         "description": "Arena games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Arena",
         "type": "object"
      },
      "Battleground": {
         "description": "Battleground games stats.\n\n    Args:\n        coins (int): Number of coins gathered in this Game Mode. Defaults to 0.\n    ",
         "properties": {
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            }
         },
         "title": "Battleground",
         "type": "object"
      },
      "Bedwars": {
         "description": "Bedwars Stats.\n\n    Args:\n        kills (int): Total kills across all Bedwars gamemodes. Defaults to 0.\n        wins (int): Total wins across all Bedwars gamemodes. Defaults to 0.\n        coins (int): Total coins collected. Defaults to 0.\n        games_played (int): Number of bedwars games played. Defaults to 0.\n        final_deaths (int): Number of final deaths across all Bedwars gamemodes.\n            Defaults to 0.\n        deaths (int): Number of deaths across all Bedwars gamemodes. Defaults to 0.\n        final_kills (int): Number of final kills across all Bedwars gamemodes.\n            Defaults to 0.\n        losses (int): Total bedwars games lost. Defaults to 0.\n        beds_lost (int): Number of beds lost across all Bedwars gamemodes.\n            Defaults to 0.\n        beds_broken (int): Number of beds broken across all Bedwars gamemodes.\n            Defaults to 0.\n        winstreak (int): Current winstreak. Defaults to 0.\n        experience (int): Total bedwars experience. Defaults to 0.\n        singles (Optional[BedwarsGame]): Stats for the singles Gamemode.\n        doubles (Optional[BedwarsGame]): Stats for the doubles Gamemode.\n        triples (Optional[BedwarsGame]): Stats for the triples Gamemode.\n        quads (Optional[BedwarsGame]): Stats for the quads Gamemode.\n        four_v_four (Optional[BedwarsGame]): Stats for the four vs four Gamemode.\n        quads_ultimate (Optional[BedwarsGame]): Stats for the quads ultimate Gamemode.\n        doubles_ultimate (Optional[BedwarsGame]): Stats for the doubles\n            ultimate Gamemode.\n        castle (Optional[BedwarsGame]): Stats for the castle Gamemode.\n        entity_attack_deaths (int): Deaths to an entity. Defaults to 0.\n        entity_attack_final_deaths (int): Final deaths to an entity. Defaults to 0.\n        fall_deaths (int): Overall fall deaths. Defaults to 0.\n        fall_final_deaths (int): Overall final fall deaths Defaults to 0.\n        projectile_deaths (int): Projectile deaths. Defaults to 0.\n        suffocation_deaths (int): Overall suffocation deaths. Defaults to 0.\n        magic_deaths (int): Overall magic deaths. Defaults to 0.\n        entity_explosion_deaths (int): Overall explosion deaths. Defaults to 0.\n        magic_final_deaths (int): Overall magic final deaths. Defaults to 0.\n        void_deaths (int): Overall void deaths. Defaults to 0.\n        void_final_death (int): Overall void final deaths. Defaults to 0.\n        fire_tick_final_death (int): Overall fire final deaths. Defaults to 0.\n        void_kills (int): Overall void kills. Defaults to 0.\n        entity_attack_kills (int): Overall entity attack kills. Defaults to 0.\n        entity_attack_final_kills (int): Overall entity attack final kills.\n            Defaults to 0.\n        projectile_final_kills (int): Overall projectile final kills. Defaults to 0.\n        entity_explosion_kills (int): Overall entity explosion kills. Defaults to 0.\n        projectile_kills (int): Overall projectile kills. Defaults to 0.\n        fall_final_kills (int): Overall final fall kills. Defaults to 0.\n        fall_kills (int): Overall fall kills. Defaults to 0.\n        resources_collected (int): Overall resources collected. Defaults to 0.\n        iron_resources_collected (int): Overall iron resources collected. Defaults to 0.\n        diamond_resources_collected (int): Overall diamond resources collected.\n            Defaults to 0.\n        emerald_resources_collected (int): Overall emerald resources collected.\n            Defaults to 0.\n        items_purchased (int): Overall items purchased. Defaults to 0.\n        permanent_items_purchased (int): Overall permanent items purchased.\n            Defaults to 0.\n        bedwars_box_rares (int): Bedwars boxes that are rare. Defaults to 0.\n        bedwars_box (int): Total Bedwars boxes. Defaults to 0.\n        chest_history_new (List[str]): Chest history.  Defaults to [].\n        bedwars_box_commons (int): Total common Bedwars boxes. Defaults to 0.\n        spray_glyph_field (str): Current spray glyph.  Defaults to \"\".\n        active_island_topper (str): Current island topper.  Defaults to \"\".\n        active_projectile_trail (str): Current projectile trail.  Defaults to \"\".\n        bedwars_easter_boxes (int): Bedwars easters boxes. Defaults to 0.\n        Bedwars_opened_chests (int): Total chests opened in Bedwars. Defaults to 0.\n        Bedwars_opened_rares (int): Total rare chests opened in Bedwars.\n            Defaults to 0.\n        Bedwars_opened_commons (int): Total common chests opened in Bedwars.\n            Defaults to 0.\n        active_npc_skin (str): Current active NPC skin.  Defaults to \"\".\n        favourites_2 (str): Favourites.  Defaults to \"\".\n        Bedwars_opened_epics (int): Total epic chests opened in Bedwars.\n            Defaults to 0.\n        active_death_cry (str): Equipped active death cry.  Defaults to \"\".\n        active_kill_effect (str): Equipped kill effect.  Defaults to \"\".\n        active_sprays (str): Equipped spray.  Defaults to \"\".\n        active_glyph (str): Active glyph.  Defaults to \"\".\n        selected_ultimate (str): Selected Ultimate.  Defaults to \"\".\n    ",
         "properties": {
            "kills_bedwars": {
               "default": 0,
               "title": "Kills Bedwars",
               "type": "integer"
            },
            "wins_bedwars": {
               "default": 0,
               "title": "Wins Bedwars",
               "type": "integer"
            },
            "coins": {
               "default": 0,
               "title": "Coins",
               "type": "integer"
            },
            "games_played_bedwars": {
               "default": 0,
               "title": "Games Played Bedwars",
               "type": "integer"
            },
            "final_deaths_bedwars": {
               "default": 0,
               "title": "Final Deaths Bedwars",
               "type": "integer"
            },
            "deaths_bedwars": {
               "default": 0,
               "title": "Deaths Bedwars",
               "type": "integer"
            },
            "final_kills_bedwars": {
               "default": 0,
               "title": "Final Kills Bedwars",
               "type": "integer"
            },
            "losses_bedwars": {
               "default": 0,
               "title": "Losses Bedwars",
               "type": "integer"
            },
            "beds_lost_bedwars": {
               "default": 0,
               "title": "Beds Lost Bedwars",
               "type": "integer"
            },
            "beds_broken_bedwars": {
               "default": 0,
               "title": "Beds Broken Bedwars",
               "type": "integer"
            },
            "winstreak": {
               "default": 0,
               "title": "Winstreak",
               "type": "integer"
            },
            "Experience": {
               "default": 0,
               "title": "Experience",
               "type": "integer"
            },
            "singles": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "doubles": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "triples": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BedwarsGame"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "quads": {
               "anyOf": [
                  {