API Endpoints

PreviousAPI Key NextCreators

Last updated 19 days ago

Get character metadata

get

Retrieve metadata for a specific character by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get character metadata retrieved successfully

application/json

404

character metadata not found

application/json

get

GET /api/metadata/characters/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text"
}

Get item metadata

get

Retrieve metadata for a specific item by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get item metadata retrieved successfully

application/json

404

item metadata not found

application/json

get

GET /api/metadata/items/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text"
}

Get tool metadata

get

Retrieve metadata for a specific tool by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get tool metadata retrieved successfully

application/json

404

tool metadata not found

application/json

get

GET /api/metadata/tools/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text"
}

Get monster metadata

get

Retrieve metadata for a specific monster by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get monster metadata retrieved successfully

application/json

404

monster metadata not found

application/json

get

GET /api/metadata/monsters/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text"
}

Get apartment metadata

get

Retrieve metadata for a specific apartment by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get apartment metadata retrieved successfully

application/json

404

apartment metadata not found

application/json

get

GET /api/metadata/apartments/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text"
}

Get friend metadata

get

Retrieve metadata for a specific friend by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get friend metadata retrieved successfully

application/json

404

friend metadata not found

application/json

get

GET /api/metadata/friends/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text"
}

Get animated profile pictures

get

Retrieve animated profile pictures for characters

Responses

200

Get animated profile pictures retrieved successfully

image/*

Responsestring · binary

404

animated profile pictures not found

application/json

get

GET /api/images/characters/animated-pfps HTTP/1.1
Host: 
Accept: */*

binary

Get static profile pictures

get

Retrieve static profile pictures for characters

Responses

200

Get static profile pictures retrieved successfully

image/*

Responsestring · binary

404

static profile pictures not found

application/json

get

GET /api/images/characters/static-pfps HTTP/1.1
Host: 
Accept: */*

binary

Get character overworld atlas

get

Retrieve overworld atlas for characters

Responses

200

Get character overworld atlas retrieved successfully

image/*

Responsestring · binary

404

character overworld atlas not found

application/json

get

GET /api/images/characters/overworld-atlas HTTP/1.1
Host: 
Accept: */*

binary

Get character GIFs

get

Retrieve character GIFs

Responses

200

Get character GIFs retrieved successfully

image/*

Responsestring · binary

404

character GIFs not found

application/json

get

GET /api/images/characters/gifs HTTP/1.1
Host: 
Accept: */*

binary

Get monster NFT image by ID

get

Retrieve image for a specific monster NFT by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get monster NFT image by ID retrieved successfully

image/*

Responsestring · binary

404

monster NFT image by ID not found

application/json

get

GET /api/images/monsters/nfts/{id} HTTP/1.1
Host: 
Accept: */*

binary

Get all monster NFT images

get

Retrieve all monster NFT images

Responses

200

Get all monster NFT images retrieved successfully

image/*

Responsestring · binary

404

all monster NFT images not found

application/json

get

GET /api/images/monsters/nfts HTTP/1.1
Host: 
Accept: */*

binary

Get monster NFT image by ID

get

Retrieve image for a specific monster NFT by ID

Path parameters

idstringRequired

Id ID

Responses

200

Get monster NFT image by ID retrieved successfully

image/*

Responsestring · binary

404

monster NFT image by ID not found

application/json

get

GET /api/images/monsters/nfts/page/{id} HTTP/1.1
Host: 
Accept: */*

binary

Get monster data by ID

get

Retrieve detailed data for a specific monster by ID

Authorizations

Path parameters

idstringRequired

Id ID

Responses

200

Get monster data by ID retrieved successfully

application/json

401

Unauthorized - Invalid or missing API token

application/json

404

monster data by ID not found

application/json

get

GET /api/data/monsters/{id} HTTP/1.1
Host: 
x-api-token: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "breedName": "text",
  "tokenId": "text",
  "variant": "text",
  "flags": {
    "changesColorWithSeason": true
  },
  "assets": {
    "profilePicture": "text",
    "frontSprite": "text",
    "backSprite": "text"
  },
  "name": "text",
  "level": 1,
  "experience": 1,
  "description": "text",
  "eggGroup": "text",
  "type": {
    "primary": "text",
    "secondary": "text"
  },
  "statistics": {
    "HP": 1,
    "SP": 1,
    "maxHP": 1,
    "maxSP": 1,
    "ATK": 1,
    "sATK": 1,
    "DEF": 1,
    "sDEF": 1,
    "SPE": 1,
    "trust": 1
  },
  "innatePotential": {
    "HP": 1,
    "SP": 1,
    "ATK": 1,
    "DEF": 1,
    "SPE": 1,
    "sATK": 1,
    "sDEF": 1,
    "total": 1
  },
  "visiblePotential": {
    "HP": 1,
    "SP": 1,
    "ATK": 1,
    "DEF": 1,
    "SPE": 1,
    "sATK": 1,
    "sDEF": 1
  },
  "likes": "text",
  "dislikes": "text",
  "ability": "text",
  "movesData": [
    {
      "name": "text",
      "class": "text",
      "type": "text",
      "power": 1,
      "accuracy": 1,
      "cost": 1,
      "description": "text"
    }
  ],
  "personality": "text",
  "originalHunter": "text",
  "gender": "text",
  "itemHeld": "text",
  "cosmeticItem": "text",
  "experienceForNextLevel": 1,
  "captureDetails": {},
  "createdAt": "2025-05-05T09:04:17.638Z",
  "availableMovesData": [
    {
      "name": "text",
      "class": "text",
      "type": "text",
      "power": 1,
      "accuracy": 1,
      "cost": 1,
      "description": "text"
    }
  ],
  "statusEffect": "text",
  "unallocatedPoints": 1,
  "isEgg": true,
  "eggDetails": {},
  "owner": "text"
}

Get user data by wallet address

get

Retrieve user data for a specific wallet address

Authorizations

Path parameters

addressstringRequired

Address ID

Responses

200

Get user data by wallet address retrieved successfully

application/json

401

Unauthorized - Invalid or missing API token

application/json

404

user data by wallet address not found

application/json

get

GET /api/data/users/{address} HTTP/1.1
Host: 
x-api-token: YOUR_API_KEY
Accept: */*

{
  "address": "text",
  "username": "text",
  "equippedOutfit": "text",
  "lastOnline": "2025-05-05T09:04:17.638Z",
  "currentGuild": "text",
  "squad": [
    "text"
  ]
}

Get guild data by ID

get

Retrieve detailed data for a specific guild by ID

Authorizations

Path parameters

idstringRequired

Id ID

Responses

200

Get guild data by ID retrieved successfully

application/json

401

Unauthorized - Invalid or missing API token

application/json

404

guild data by ID not found

application/json

get

GET /api/data/guilds/{id} HTTP/1.1
Host: 
x-api-token: YOUR_API_KEY
Accept: */*

{
  "name": "text",
  "description": "text",
  "apartment": "text",
  "parentGuildId": "text",
  "assets": {
    "logo": "text"
  },
  "experience": 1,
  "chestKeys": 1,
  "createdAt": "2025-05-05T09:04:17.638Z",
  "updatedAt": "2025-05-05T09:04:17.638Z",
  "logs": [
    {}
  ]
}

Get guild members with pagination

get

Retrieve members of a specific guild with pagination support

Authorizations

Path parameters

idstringRequired

Id ID

Query parameters

pageintegerOptional

Page number for pagination

Default: 1

limitintegerOptional

Number of items per page

Default: 10

Responses

200

Get guild members with pagination retrieved successfully

application/json

401

Unauthorized - Invalid or missing API token

application/json

404

guild members with pagination not found

application/json

get

GET /api/data/guilds/{id}/members HTTP/1.1
Host: 
x-api-token: YOUR_API_KEY
Accept: */*

{
  "members": [
    {
      "address": "text",
      "username": "text",
      "role": "text",
      "joinedAt": "2025-05-05T09:04:17.638Z",
      "updatedAt": "2025-05-05T09:04:17.638Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 1,
    "itemsPerPage": 1
  }
}