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

# Get rarity information on protos

Returns rarity information about protos

# 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/rarity": {
      "get": {
        "summary": "Get rarity information on protos",
        "tags": [
          "proto"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Rarity"
                }
              }
            }
          }
        },
        "operationId": "listRarity",
        "description": "Returns rarity information about protos",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "schema": {
              "type": "string",
              "enum": [
                "proto",
                "plain",
                "shadow",
                "gold",
                "diamond"
              ]
            },
            "in": "query",
            "name": "sort"
          },
          {
            "$ref": "#/components/parameters/order"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "user",
            "description": "get rarity info about cards owned by a specific address"
          },
          {
            "$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": {
      "Rarity": {
        "description": "",
        "type": "object",
        "x-examples": {
          "example-1": {
            "100": {
              "proto": 100,
              "plain": "2165",
              "shadow": "161",
              "gold": "43",
              "diamond": "5"
            },
            "101": {
              "proto": 101,
              "plain": "33034",
              "shadow": "1719",
              "gold": "313",
              "diamond": "60"
            }
          }
        }
      }
    },
    "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"
      },
      "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": "proto"
    }
  ],
  "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
    }
  }
}
```