---
agentTools:
  projectIndex: https://imx.readme.io/llms.txt
---

# Get user inventory

Returns the inventory of the user with address address, including token, shadow and centralized cards.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Gods Unchained API",
    "version": "1.0",
    "description": "Gods Unchained API",
    "contact": {
      "name": "Immutable",
      "url": "https://godsunchained.com"
    },
    "termsOfService": "https://github.com/immutable/gods-unchained-api"
  },
  "servers": [
    {
      "url": "https://api.godsunchained.com"
    }
  ],
  "paths": {
    "/v0/user/{address}/inventory": {
      "parameters": [
        {
          "schema": {
            "type": "string"
          },
          "name": "address",
          "in": "path",
          "required": true,
          "description": "user ethereum address"
        }
      ],
      "get": {
        "summary": "Get user inventory",
        "tags": [
          "user"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserInventoryItemList"
                }
              }
            }
          }
        },
        "operationId": "getUserInventory",
        "description": "Returns the inventory of the user with address address, including token, shadow and centralized cards.",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/order"
          },
          {
            "$ref": "#/components/parameters/rarity"
          },
          {
            "$ref": "#/components/parameters/quality"
          },
          {
            "$ref": "#/components/parameters/god"
          },
          {
            "$ref": "#/components/parameters/type"
          },
          {
            "$ref": "#/components/parameters/tribe"
          },
          {
            "$ref": "#/components/parameters/purity"
          },
          {
            "$ref": "#/components/parameters/mana"
          },
          {
            "$ref": "#/components/parameters/health"
          },
          {
            "$ref": "#/components/parameters/attack"
          },
          {
            "$ref": "#/components/parameters/proto"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "UserInventoryItem": {
        "description": "",
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "mana": {
            "type": "number"
          },
          "health": {
            "type": "object",
            "properties": {
              "Int64": {
                "type": "number"
              },
              "Valid": {
                "type": "boolean"
              }
            },
            "required": [
              "Int64",
              "Valid"
            ]
          },
          "attack": {
            "type": "object",
            "properties": {
              "Int64": {
                "type": "number"
              },
              "Valid": {
                "type": "boolean"
              }
            },
            "required": [
              "Int64",
              "Valid"
            ]
          },
          "tribe": {
            "type": "object",
            "properties": {
              "String": {
                "type": "string",
                "minLength": 1
              },
              "Valid": {
                "type": "boolean"
              }
            },
            "required": [
              "String",
              "Valid"
            ]
          },
          "rarity": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "god": {
            "type": "string",
            "minLength": 1
          },
          "effect": {
            "type": "string",
            "minLength": 1
          },
          "user": {
            "type": "string",
            "minLength": 1
          },
          "id": {
            "type": "object",
            "properties": {
              "Int64": {
                "type": "number"
              },
              "Valid": {
                "type": "boolean"
              }
            },
            "required": [
              "Int64",
              "Valid"
            ]
          },
          "proto": {
            "type": "number"
          },
          "purity": {
            "type": "number"
          },
          "opened": {
            "type": "boolean"
          },
          "set": {
            "type": "object",
            "properties": {
              "String": {
                "type": "string",
                "minLength": 1
              },
              "Valid": {
                "type": "boolean"
              }
            },
            "required": [
              "String",
              "Valid"
            ]
          }
        },
        "required": [
          "name",
          "mana",
          "health",
          "attack",
          "tribe",
          "rarity",
          "type",
          "god",
          "effect",
          "user",
          "id",
          "proto",
          "purity",
          "opened",
          "set"
        ],
        "x-examples": {
          "example-1": {
            "name": "Rolling Watcher",
            "mana": 2,
            "health": {
              "Int64": 0,
              "Valid": false
            },
            "attack": {
              "Int64": 0,
              "Valid": true
            },
            "tribe": {
              "String": "atlantean",
              "Valid": true
            },
            "rarity": "common",
            "type": "creature",
            "god": "neutral",
            "effect": "At the start of each turn, this creature gets +1 strength.",
            "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
            "id": {
              "Int64": 35,
              "Valid": true
            },
            "proto": 35,
            "purity": 161,
            "opened": true,
            "set": {
              "String": "genesis",
              "Valid": true
            }
          }
        }
      },
      "UserInventoryItemList": {
        "description": "",
        "type": "object",
        "x-examples": {
          "example-1": {
            "total": 925,
            "page": 1,
            "perPage": 20,
            "records": [
              {
                "name": "Rolling Watcher",
                "mana": 2,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": true
                },
                "tribe": {
                  "String": "atlantean",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "At the start of each turn, this creature gets +1 strength.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 35,
                  "Valid": true
                },
                "proto": 35,
                "purity": 161,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Whetstone",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": false
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "common",
                "type": "spell",
                "god": "war",
                "effect": "Give your relic +4 strength for its next attack.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 303,
                  "Valid": true
                },
                "proto": 303,
                "purity": 599,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Shadow Scryer",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 1,
                  "Valid": true
                },
                "tribe": {
                  "String": "mystic",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "magic",
                "effect": "Protected. Ward.\nAt the start of your turn, foresee 1.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 199,
                  "Valid": true
                },
                "proto": 199,
                "purity": 322,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Leviathan Hunter",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "viking",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "Roar: Equip a 1/1 Barbed Hook. If you control another Viking, equip a 1/2 Barbed Hook instead.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 206,
                  "Valid": true
                },
                "proto": 206,
                "purity": 482,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Compost Charm",
                "mana": 2,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": false
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "epic",
                "type": "spell",
                "god": "nature",
                "effect": "Heal your god for 10.\nIf you have eight cards in your void, add a random Nature card into your hand.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 134,
                  "Valid": true
                },
                "proto": 134,
                "purity": 486,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Deathsworn Raider",
                "mana": 3,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 3,
                  "Valid": true
                },
                "tribe": {
                  "String": "viking",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "war",
                "effect": "Roar: Give +2/+1 to a friendly Viking.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 211,
                  "Valid": true
                },
                "proto": 211,
                "purity": 354,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Sentinel Princess",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "atlantean",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "Roar: If you control another Atlantean, this gets +1 strength.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 33,
                  "Valid": true
                },
                "proto": 33,
                "purity": 558,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Healing Insight",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": false
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "common",
                "type": "spell",
                "god": "light",
                "effect": "Give a friendly creature +2 health and fully heal it.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 14,
                  "Valid": true
                },
                "proto": 14,
                "purity": 80,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Sharpen",
                "mana": 2,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": false
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "common",
                "type": "spell",
                "god": "war",
                "effect": "Give +3 strength to your relic and to target friendly creature for their next attack.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 334,
                  "Valid": true
                },
                "proto": 334,
                "purity": 633,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Daemonic Offering",
                "mana": 3,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": false
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "epic",
                "type": "spell",
                "god": "death",
                "effect": "Destroy target friendly creature. Summon two random anims. They gain the tribe Nether.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 181,
                  "Valid": true
                },
                "proto": 181,
                "purity": 262,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Warden of Kauket",
                "mana": 8,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 3,
                  "Valid": true
                },
                "tribe": {
                  "String": "anubian",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "Whenever your god takes damage, deal 2 damage to each other creature.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 259,
                  "Valid": true
                },
                "proto": 259,
                "purity": 845,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Gentle Monk",
                "mana": 4,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "common",
                "type": "creature",
                "god": "light",
                "effect": "Roar: Set an enemy creature's strength to 1.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 139,
                  "Valid": true
                },
                "proto": 139,
                "purity": 59,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Gentle Monk",
                "mana": 4,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "common",
                "type": "creature",
                "god": "light",
                "effect": "Roar: Set an enemy creature's strength to 1.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 139,
                  "Valid": true
                },
                "proto": 139,
                "purity": 151,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Felid Tracker",
                "mana": 2,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 5,
                  "Valid": true
                },
                "tribe": {
                  "String": "wild",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "Flank.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 45,
                  "Valid": true
                },
                "proto": 45,
                "purity": 675,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Fusing Fleshspawn",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 3,
                  "Valid": true
                },
                "tribe": {
                  "String": "nether",
                  "Valid": true
                },
                "rarity": "epic",
                "type": "creature",
                "god": "death",
                "effect": "Roar: Destroy a friendly creature. This creature gains health equal to that creature's strength.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 124,
                  "Valid": true
                },
                "proto": 124,
                "purity": 578,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Quicksilver Dragon",
                "mana": 7,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 7,
                  "Valid": true
                },
                "tribe": {
                  "String": "dragon",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "Roar: If you have six cards or more in hand after this enters the board, this creature gains blitz.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 184,
                  "Valid": true
                },
                "proto": 184,
                "purity": 348,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Omnipresence",
                "mana": 3,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "nether",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "death",
                "effect": "Roar: Copy the strength and health of a random creature from your void.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 277,
                  "Valid": true
                },
                "proto": 277,
                "purity": 144,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "A Real Man",
                "mana": 1,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 0,
                  "Valid": true
                },
                "tribe": {
                  "String": "",
                  "Valid": false
                },
                "rarity": "common",
                "type": "creature",
                "god": "deception",
                "effect": "Cannot attack.\nRoar: Hide a friendly creature for 1 turn.\nAfterlife: Draw a card.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 126,
                  "Valid": true
                },
                "proto": 126,
                "purity": 149,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Millenium Matryoshka",
                "mana": 4,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "atlantean",
                  "Valid": true
                },
                "rarity": "common",
                "type": "creature",
                "god": "neutral",
                "effect": "Afterlife: Summon a random anim.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 215,
                  "Valid": true
                },
                "proto": 215,
                "purity": 826,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              },
              {
                "name": "Wizened Warlock",
                "mana": 3,
                "health": {
                  "Int64": 0,
                  "Valid": false
                },
                "attack": {
                  "Int64": 2,
                  "Valid": true
                },
                "tribe": {
                  "String": "amazon",
                  "Valid": true
                },
                "rarity": "epic",
                "type": "creature",
                "god": "neutral",
                "effect": "Ward.\nAt the end of your turn, deal 1 damage to a random enemy.",
                "user": "0xd8cf31951c8aa768b68ca1e2bff973b2a8b0a183",
                "id": {
                  "Int64": 158,
                  "Valid": true
                },
                "proto": 158,
                "purity": 798,
                "opened": true,
                "set": {
                  "String": "genesis",
                  "Valid": true
                }
              }
            ]
          }
        },
        "properties": {
          "total": {
            "type": "number"
          },
          "page": {
            "type": "number"
          },
          "perPage": {
            "type": "number"
          },
          "records": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "$ref": "#/components/schemas/UserInventoryItem"
            }
          }
        },
        "required": [
          "total",
          "page",
          "perPage",
          "records"
        ]
      }
    },
    "parameters": {
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "schema": {
          "type": "number"
        },
        "description": "page number"
      },
      "perPage": {
        "name": "perPage",
        "in": "query",
        "required": false,
        "schema": {
          "type": "number"
        },
        "description": "number of items per page to return"
      },
      "sort": {
        "name": "sort",
        "in": "query",
        "schema": {
          "type": "string"
        }
      },
      "order": {
        "name": "order",
        "in": "query",
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ]
        }
      },
      "god": {
        "name": "god",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "light",
            "death",
            "nature",
            "war",
            "magic",
            "deception"
          ]
        },
        "description": "card god type"
      },
      "rarity": {
        "name": "rarity",
        "in": "query",
        "schema": {
          "type": "string",
          "enum": [
            "common",
            "rare",
            "epic",
            "legendary",
            "mythic"
          ]
        },
        "description": "card rarity"
      },
      "type": {
        "name": "type",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "creature",
            "spell",
            "weapon"
          ]
        },
        "description": "card type"
      },
      "tribe": {
        "name": "tribe",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "nether",
            "aether",
            "atlantean",
            "viking",
            "olympian",
            "anubian",
            "amazon"
          ]
        },
        "description": "card tribe type"
      },
      "quality": {
        "name": "quality",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "plain",
            "shadow",
            "gold",
            "diamond"
          ]
        },
        "description": "card quality"
      },
      "mana": {
        "name": "mana",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "card mana range"
      },
      "health": {
        "name": "health",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "card health range"
      },
      "attack": {
        "name": "attack",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "card attack range"
      },
      "purity": {
        "name": "purity",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "card purity range"
      },
      "proto": {
        "name": "proto",
        "in": "query",
        "required": false,
        "schema": {
          "type": "number"
        },
        "description": "card prototype id"
      }
    }
  },
  "tags": [
    {
      "name": "user"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 222,
      "2": 72,
      "3": 136,
      "4": 234,
      "5": 204,
      "6": 69,
      "7": 0,
      "8": 66,
      "9": 174,
      "10": 18,
      "11": 91
    }
  }
}
```