API Documentation | Bitjita - Developer API for Bitcraft Data

Parameters

code (string) Required

The unique verification code (without the bitjita:auth: prefix) that was posted in-game chat channel 2

Response

{
  "success": "boolean",
  "player": {
    "entityId": "string",
    "username": "string"
  },
  "verificationCode": "string",
  "verifiedAt": "string"
}

Try it out

POST /api/auth/chat/validate { "code": "your-unique-code" }

Parameters

limit (number) Optional

Number of messages to return (default: 50, max: 100)

since (string) Optional

Only return messages newer than this timestamp

Response

{
  "messages": "array",
  "total": "number"
}

Try it out

/api/chat?limit=20

Parameters

q (string) Optional

Search term for claim names (minimum 2 characters)

page (number) Optional

Page number (default: 1)

limit (number) Optional

Items per page (default: 20, max: 100)

sort (string) Optional

Sort field: entityId, name, neutral, regionName, supplies, numTiles, locationX, locationZ, treasury, createdAt, updatedAt, tier

order (string) Optional

Sort order: asc or desc (default: desc)

regionId (number) Optional

Filter by region ID (1-9)

Response

{
  "claims": "array",
  "count": "number"
}

Try it out

/api/claims?q=jita&page=1&limit=20&sort=name&order=desc

Parameters

id (string) Required

Claim entity ID

Response

{
  "claim": {
    "entityId": "string",
    "ownerPlayerEntityId": "string",
    "ownerBuildingEntityId": "string",
    "name": "string",
    "neutral": "boolean",
    "regionId": "number",
    "regionName": "string",
    "supplies": "number",
    "buildingMaintenance": "number",
    "numTiles": "number",
    "locationX": "number",
    "locationZ": "number",
    "locationDimension": "number",
    "treasury": "string",
    "ownerPlayerUsername": "string",
    "techResearching": "number",
    "techStartTimestamp": "string",
    "tileCost": "number",
    "upkeepCost": "number",
    "suppliesRunOut": "number",
    "tier": "number",
    "researchedTechs": "array"
  }
}

Try it out

/api/claims/288230376165363891

Parameters

id (string) Required

Claim entity ID

Response

[
  {
    "entityId": "string",
    "buildingDescriptionId": "number",
    "buildingName": "string",
    "iconAssetName": "string",
    "functions": [
      {
        "level": "number",
        "buff_ids": "array",
        "terraform": "boolean",
        "cargo_slots": "number",
        "trade_orders": "number",
        "function_type": "number",
        "housing_slots": "number",
        "storage_slots": "number",
        "crafting_slots": "number",
        "housing_income": "number",
        "item_slot_size": "number",
        "refining_slots": "number",
        "cargo_slot_size": "number",
        "refining_cargo_slots": "number",
        "allowed_item_id_per_slot": "array",
        "concurrent_crafts_per_player": "number"
      }
    ]
  }
]

Try it out

/api/claims/288230376165363891/buildings

Parameters

id (string) Required

Claim entity ID

Response

{
  "citizens": [
    {
      "entityId": "string",
      "userName": "string",
      "skills": "object",
      "totalSkills": "number",
      "highestLevel": "number",
      "totalLevel": "number",
      "totalXP": "number"
    }
  ],
  "count": "number",
  "skillNames": "object"
}

Try it out

/api/claims/288230376165363891/citizens

Parameters

id (string) Required

Claim entity ID

Response

{
  "buildings": [
    {
      "entityId": "string",
      "buildingDescriptionId": "number",
      "buildingName": "string",
      "buildingNickname": "string",
      "iconAssetName": "string",
      "inventory": [
        {
          "locked": "boolean",
          "volume": "number",
          "contents": {
            "item_id": "number",
            "quantity": "number",
            "item_type": "string"
          }
        }
      ]
    }
  ],
  "items": [
    {
      "id": "number",
      "name": "string",
      "iconAssetName": "string",
      "rarity": "number",
      "rarityStr": "string",
      "tier": "number",
      "tag": "string"
    }
  ],
  "cargos": [
    {
      "id": "number",
      "name": "string",
      "iconAssetName": "string",
      "rarity": "number",
      "rarityStr": "string",
      "tier": "number",
      "tag": "string"
    }
  ]
}

Try it out

/api/claims/288230376165363891/inventories

Parameters

id (string) Required

Claim entity ID

Response

{
  "version": "number",
  "name": "string",
  "placements": "array",
  "buildings": "array",
  "tiles": "array",
  "mapMetadata": "object"
}

Try it out

/api/claims/288230376165363891/layout

Parameters

id (string) Required

Claim entity ID

Response

{
  "members": [
    {
      "entityId": "string",
      "claimEntityId": "string",
      "playerEntityId": "string",
      "userName": "string",
      "inventoryPermission": "number",
      "buildPermission": "number",
      "officerPermission": "number",
      "coOwnerPermission": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "lastLoginTimestamp": "string"
    }
  ],
  "count": "number"
}

Try it out

/api/claims/288230376165363891/members

Parameters

id (string) Required

Claim entity ID

Response

{
  "recruitment": [
    {
      "entityId": "string",
      "claimEntityId": "string",
      "remainingStock": "number",
      "requiredSkillId": "number",
      "requiredSkillLevel": "number",
      "requiredApproval": "boolean",
      "requiredSkillName": "string",
      "requiredSkillTitle": "string"
    }
  ],
  "count": "number"
}

Try it out

/api/claims/288230376165363891/recruitment

Parameters

id (string) Required

Claim entity ID (path parameter, digit string).

page (number) Optional

Page number, starting at 1. Defaults to 1.

limit (number) Optional

Rows per page. Defaults to 50, max 200.

side (string) Optional

"sell" or "buy" to restrict to one side of the order book. Omit to return both.

itemType (string) Optional

"item" or "cargo" to restrict to one item type. Omit to return both.

itemId (number) Optional

Restrict to a single item ID (matched against the chosen itemType, or both types if itemType is omitted).

Response

{
  "listings": [
    {
      "entityId": "string",
      "side": "\"sell\" | \"buy\"",
      "ownerEntityId": "string",
      "ownerUsername": "string | null",
      "claimEntityId": "string",
      "itemId": "number",
      "itemType": "number (0 = item, 1 = cargo)",
      "itemName": "string | null",
      "itemTier": "number | null",
      "itemTag": "string | null",
      "itemRarity": "number | null",
      "itemRarityStr": "string | null",
      "iconAssetName": "string | null",
      "price": "string (bigint as string)",
      "quantity": "string (bigint as string)",
      "timestamp": "string",
      "storedCoins": "string",
      "regionId": "number",
      "regionName": "string | null",
      "updatedAt": "string"
    }
  ],
  "count": "number",
  "page": "number",
  "limit": "number",
  "totalPages": "number",
  "claim": {
    "entityId": "string",
    "name": "string | null"
  }
}

Try it out

GET /api/claims/360287970189639680/market/listings?side=sell&limit=100

Parameters

q (string) Optional

Search term (min 2 chars); returns max 50 matches without ownership stats

Response

{
  "collectibles": "array",
  "metrics": {
    "totalCollectibles": "number",
    "totalTypes": "number",
    "withItemForm": "number",
    "withoutItemForm": "number"
  }
}

Try it out

/api/collectibles?q=wagon

Parameters

id (number) Required

Collectible ID

Response

{
  "collectible": "object",
  "summary": {
    "totalOwners": "number",
    "totalOwned": "number",
    "totalActivated": "number",
    "totalDeployed": "number"
  },
  "holders": "array"
}

Try it out

/api/collectibles/139

Parameters

claimEntityId (string) Optional

Filter by specific claim entity ID

playerEntityId (string) Optional

Filter by player entity ID

regionId (number) Optional

Filter by region ID (1-9)

completed (boolean) Optional

Show completed crafts (default: false, shows incomplete)

skillId (number) Optional

Filter by skill ID

Response

{
  "craftResults": "array",
  "items": "array",
  "cargos": "array",
  "claims": "array"
}

Try it out

/api/crafts?regionId=1&completed=false

Parameters

craftId (string) Required

Craft entity ID

Response

{
  "craft": {
    "entityId": "string",
    "buildingEntityId": "string",
    "ownerEntityId": "string",
    "regionId": "number",
    "progress": "number",
    "recipeId": "number",
    "craftCount": "number",
    "lockExpiration": "string",
    "functionType": "number",
    "lastCritOutcome": "number",
    "preparation": "boolean",
    "actionsRequiredPerItem": "number",
    "craftedItem": [
      {
        "item_id": "number",
        "quantity": "number",
        "item_type": "string",
        "durability": "number"
      }
    ],
    "levelRequirements": [
      {
        "level": "number",
        "skill_id": "number",
        "skillName": "string",
        "skillIcon": "string",
        "skillTitle": "string"
      }
    ],
    "toolRequirements": [
      {
        "level": "number",
        "power": "number",
        "tool_type": "number",
        "name": "string",
        "skill_id": "number"
      }
    ],
    "buildingName": "string",
    "ownerUsername": "string",
    "claimEntityId": "string",
    "claimName": "string",
    "claimLocationX": "number",
    "claimLocationZ": "number",
    "totalActionsRequired": "number",
    "completed": "boolean"
  },
  "items": [
    {
      "id": "number",
      "name": "string",
      "iconAssetName": "string",
      "rarity": "number",
      "rarityStr": "string",
      "tier": "number",
      "tag": "string"
    }
  ],
  "cargos": "array"
}

Try it out

/api/crafts/123456789

Parameters

craftId (string) Required

Craft entity ID

Response

{
  "contributions": [
    {
      "contributorEntityId": "string",
      "contributorUsername": "string | null",
      "totalProgressContributed": "number",
      "contributionCount": "number",
      "firstContributedAt": "string",
      "lastContributedAt": "string"
    }
  ]
}

Try it out

/api/crafts/123456789/contributions

Parameters

q (string) Optional

Search term for creatures (minimum 2 characters)

Response

{
  "creatures": "array",
  "count": "number",
  "metrics": {
    "totalCreatures": "number",
    "totalTags": "number",
    "huntableCreatures": "number",
    "averageTier": "number"
  }
}

Try it out

/api/creatures?q=wolf

Parameters

id (number) Required

Creature enemy type ID

Response

{
  "creature": {
    "enemyType": "number",
    "name": "string",
    "description": "string",
    "tier": "number",
    "tag": "string",
    "rarityStr": "string",
    "huntable": "boolean",
    "maxHealth": "number",
    "minDamage": "number",
    "maxDamage": "number",
    "armor": "number",
    "accuracy": "number",
    "evasion": "number",
    "strength": "number"
  }
}

Try it out

/api/creatures/1

Parameters

q (string) Optional

Search term for deployables (minimum 2 characters)

Response

{
  "deployables": "array",
  "count": "number",
  "metrics": {
    "totalDeployables": "number",
    "totalTypes": "number",
    "landMounts": "number",
    "waterMounts": "number",
    "withStorage": "number"
  }
}

Try it out

/api/deployables?q=horse

Parameters

id (number) Required

Deployable ID

Response

{
  "deployable": {
    "id": "number",
    "name": "string",
    "deployableTypeName": "string",
    "movementTypeName": "string",
    "speed": "array",
    "capacity": "number",
    "storage": "number",
    "stats": "array",
    "pathfinding": "object"
  }
}

Try it out

/api/deployables/1

Parameters

q (string) Optional

Search term for empire names (minimum 2 characters)

Response

{
  "empires": "array",
  "totalClaims": "number",
  "totalMembers": "number",
  "totalTreasury": "string",
  "count": "number"
}

Try it out

/api/empires?q=tlr

Parameters

id (string) Required

Empire entity ID

Response

[
  {
    "entityId": "string",
    "locationX": "number",
    "locationZ": "number",
    "locationDimension": "number",
    "energy": "number",
    "upkeep": "number",
    "active": "boolean",
    "nickname": "string",
    "siege": [
      {
        "active": "boolean",
        "energy": "number",
        "startTimestamp": "string",
        "empireEntityId": "number",
        "empireName": "string",
        "attacker": "boolean"
      }
    ]
  }
]

Try it out

/api/empires/1807/towers

Parameters

q (string) Optional

Search term for food items (minimum 2 characters)

Response

{
  "food": "array",
  "count": "number",
  "metrics": {
    "totalFood": "number",
    "consumableInCombat": "number",
    "withBuffs": "number",
    "withHpRestore": "number",
    "withStaminaRestore": "number",
    "withTeleportEnergy": "number"
  }
}

Try it out

/api/food?q=pie

Parameters

itemId (number) Required

Food item ID

Response

{
  "food": {
    "itemId": "number",
    "hp": "number",
    "stamina": "number",
    "hunger": "number",
    "teleportationEnergy": "number",
    "consumableWhileInCombat": "boolean",
    "buffs": "array",
    "itemName": "string",
    "iconAssetName": "string",
    "tier": "number",
    "rarityStr": "string"
  }
}

Try it out

/api/food/1421716234

Parameters

eventName (string) Optional

Filter by specific event name

Response

{
  "entries": "array",
  "events": "array",
  "metrics": {
    "totalPackages": "number",
    "bestValueId": "number",
    "maxBonusPercentage": "number"
  }
}

Try it out

/api/hexite-exchange

Parameters

bucket (string) Optional

Time aggregation bucket: 1 hour, 4 hours, 12 hours, 1 day, 1 week (default: 1 day)

entryId (number) Optional

Filter by specific exchange entry ID

eventName (string) Optional

Filter by event name

limit (number) Optional

Maximum results to return (default: 100, max: 500)

Response

{
  "historyData": "array"
}

Try it out

/api/hexite-exchange/history?bucket=1 day&limit=30

Parameters

q (string) Optional

Search term for items (minimum 2 characters)

Response

{
  "items": "array",
  "metrics": {
    "totalItems": "number",
    "totalCategories": "number"
  }
}

Try it out

/api/items?q=pickaxe

Parameters

itemId (number) Required

The ID of the item

Response

{
  "item": "object",
  "craftingRecipes": "array",
  "extractionRecipes": "array",
  "relatedSkills": "array",
  "marketStats": "object",
  "recipesUsingItem": "array",
  "itemListPossibilities": "array"
}

Try it out

/api/items/1421716234

Parameters

cargoId (number) Required

Cargo item ID

Response

{
  "item": "object",
  "summary": {
    "totalHolders": "number",
    "totalQuantity": "number",
    "averagePerHolder": "number"
  },
  "holdings": "array"
}

Try it out

/api/leaderboard/cargo/550000

Parameters

sortBy (string) Optional

Sort field: totalExploredChunks, totalPercentageExplored, username (default: totalExploredChunks)

sortOrder (string) Optional

Sort order: asc or desc (default: desc)

page (number) Optional

Page number (default: 1)

pageSize (number) Optional

Items per page (default: 100)

Response

{
  "players": "array",
  "count": "number",
  "totalChunks": "number",
  "regionCount": "number",
  "chunksPerRegion": "number",
  "globalStats": "object",
  "pagination": "object"
}

Try it out

/api/leaderboard/exploration?sortBy=totalExploredChunks&page=1&pageSize=50

Parameters

itemId (number) Required

Item ID

Response

{
  "item": "object",
  "collectibles": "array",
  "summary": {
    "totalHolders": "number",
    "totalQuantity": "number",
    "averagePerHolder": "number"
  },
  "holdings": "array"
}

Try it out

/api/leaderboard/items/1421716234

Parameters

sortBy (string) Optional

Sort field: timePlayed, timeSignedIn, username (default: timePlayed)

sortOrder (string) Optional

Sort order: asc or desc (default: desc)

page (number) Optional

Page number (default: 1)

pageSize (number) Optional

Items per page (default: 100, max: 100)

search (string) Optional

Username search (case-insensitive)

Response

{
  "players": "array",
  "count": "number",
  "globalStats": {
    "maxTimePlayed": "number",
    "totalTimePlayed": "number",
    "averageTimePlayed": "number"
  },
  "pagination": "object"
}

Try it out

/api/leaderboard/playtime?sortBy=timePlayed&page=1&pageSize=50

Parameters

sortBy (string) Optional

Sort field: highestLevel, totalXP, totalLevel, totalSkills, username, or skill ID (default: highestLevel)

sortOrder (string) Optional

Sort order: asc or desc (default: desc)

page (number) Optional

Page number (default: 1)

pageSize (number) Optional

Items per page (default: 100)

regionId (number) Optional

Filter by region ID

Response

{
  "players": "array",
  "count": "number",
  "skillNames": "object",
  "totalSkills": "number",
  "globalHighestLevel": "number",
  "pagination": "object"
}

Try it out

/api/leaderboard/skills?sortBy=highestLevel&page=1&pageSize=50

Parameters

playerEntityId (string) Optional

Player entity ID to get full player storage history (at least one parameter required)

buildingEntityId (string) Optional

Building entity ID to get full building storage history (at least one parameter required)

claimEntityId (string) Optional

Claim entity ID to get storage history across all of the claim's buildings (at least one parameter required; combine with playerEntityId to narrow to one player's actions)

limit (number) Optional

Maximum number of logs to return (default: 100, max: 1000)

afterId (string) Optional

Use the last returned log ID to fetch older entries (IDs less than this value)

since (string) Optional

ISO timestamp to get logs since this date (e.g., 2024-01-01T00:00:00Z)

Response

{
  "logs": "array",
  "items": "array",
  "cargos": "array"
}

Try it out

/api/logs/storage?playerEntityId=123456789

Parameters

q (string) Optional

Search term for items

category (string) Optional

Filter by category

hasOrders (boolean) Optional

Only show items with orders

hasSellOrders (boolean) Optional

Only show items with sell orders

hasBuyOrders (boolean) Optional

Only show items with buy orders

claimEntityId (string) Optional

Filter results to show only items with orders from the specified claim entity ID

Response

{
  "data": {
    "items": "array",
    "categories": "array",
    "metrics": "object"
  }
}

Try it out

/api/market?q=Astralite&category=Miner Tool&hasOrders=true&claimEntityId=288230376165363891

Parameters

itemOrCargo (string) Required

Type: item or cargo

itemId (number) Required

Item or cargo ID

claimEntityId (string) Optional

Filter orders to show only those from the specified claim entity ID

Response

{
  "item": "object",
  "sellOrders": "array",
  "buyOrders": "array",
  "stats": "object"
}

Try it out

/api/market/item/1421716234?claimEntityId=288230376165363891

Parameters

itemOrCargo (string) Required

Type: 'items' or 'cargo'

itemId (number) Required

Item or cargo ID

bucket (string) Optional

Time aggregation bucket: 5 minutes, 1 hour, 4 hours, 8 hours, 12 hours, 1 day, 1 week, 1 month (default: 1 hour)

limit (number) Optional

Max number of time buckets (default: 500, max: 1000)

regionId (number) Optional

Filter by region ID

Response

{
  "priceData": "array",
  "priceStats": {
    "avg24h": "number | null",
    "avg7d": "number | null",
    "avg30d": "number | null",
    "allTimeHigh": "number | null",
    "allTimeLow": "number | null",
    "priceChange24h": "number | null",
    "priceChange7d": "number | null",
    "totalTrades": "number",
    "totalVolume": "number",
    "soldVolume24h": "number",
    "soldVolume7d": "number",
    "soldVolume30d": "number",
    "boughtVolume24h": "number",
    "boughtVolume7d": "number",
    "boughtVolume30d": "number"
  },
  "recentTrades": "array"
}

Try it out

/api/market/items/1421716234/price-history?bucket=1 day&limit=30

Parameters

playerId (string) Required

Player entity ID

Response

{
  "playerId": "string",
  "playerUsername": "string",
  "sellOrders": "array",
  "buyOrders": "array"
}

Try it out

/api/market/player/360287970203109911

Parameters

playerId (string) Required

Player entity ID

status (string) Optional

Filter by order status: OPEN, PARTIALLY_COMPLETED, or COMPLETED (default: all)

type (string) Optional

Filter by order type: sell or buy (default: both). When both, limit/offset are split evenly between sell and buy queries

limit (number) Optional

Max number of orders to return (default: 50)

offset (number) Optional

Pagination offset (default: 0)

Response

{
  "playerId": "string",
  "playerUsername": "string",
  "sellOrderHistory": [
    {
      "entityId": "string",
      "itemId": "number",
      "itemType": "number",
      "priceThreshold": "string",
      "quantity": "string",
      "status": "string",
      "itemName": "string",
      "iconAssetName": "string",
      "claimName": "string",
      "regionName": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "buyOrderHistory": "array (same structure)",
  "totalSellOrders": "number",
  "totalBuyOrders": "number"
}

Try it out

/api/market/player/360287970203109911/history?type=sell&status=COMPLETED&limit=20

Parameters

playerId (string) Required

Player entity ID

type (string) Optional

Filter by trade role: sell (player was seller) or buy (player was buyer). Default: both

limit (number) Optional

Max number of trades to return (default: 50)

offset (number) Optional

Pagination offset (default: 0)

orderEntityId (string) Optional

Filter trades by a specific order entity ID

itemId (number) Optional

Filter by item ID (must be used with itemType)

itemType (number) Optional

Filter by item type: 0 for items, 1 for cargo (must be used with itemId)

Response

{
  "trades": [
    {
      "id": "string",
      "itemId": "string",
      "itemType": "number",
      "quantity": "string",
      "unitPrice": "string",
      "totalPrice": "string",
      "sellerEntityId": "string",
      "purchaserEntityId": "string",
      "orderEntityId": "string",
      "tradeType": "string",
      "sellerUsername": "string",
      "purchaserUsername": "string",
      "itemName": "string",
      "iconAssetName": "string",
      "itemTier": "number",
      "itemRarityStr": "string",
      "regionName": "string",
      "createdAt": "string"
    }
  ]
}

Try it out

/api/market/player/360287970203109911/trades?type=sell&limit=10

Parameters

itemIds (number[]) Optional

Array of item IDs (max 100). At least one of itemIds or cargoIds required.

cargoIds (number[]) Optional

Array of cargo IDs (max 100). At least one of itemIds or cargoIds required.

claimEntityId (string) Optional

Optional claim entity ID (digit string). When provided, lowest sell, highest buy, order counts, totals, and 24h volume are all scoped to that claim’s market instead of being computed globally.

Response

{
  "data": {
    "items": {
      "[itemId]": {
        "lowestSellPrice": "number | null",
        "highestBuyPrice": "number | null",
        "spread": "number | null",
        "volume24h": "number",
        "sellOrderCount": "number",
        "buyOrderCount": "number",
        "totalSellQuantity": "number",
        "totalBuyQuantity": "number",
        "vwap24h": "number | null",
        "vwap7d": "number | null"
      }
    },
    "cargo": {
      "[cargoId]": "(same structure as items)"
    }
  }
}

Try it out

POST /api/market/prices/bulk { "itemIds": [1, 2, 3], "cargoIds": [1, 2], "claimEntityId": "360287970189639680" }

Parameters

id (string) Required

Player entity ID

Response

{
  "player": "object",
  "claims": "array",
  "empires": "array",
  "marketOrders": "array",
  "skills": "array"
}

Try it out

/api/players/360287970203109911

Parameters

id (string) Required

Player entity ID

completed (string) Optional

Filter crafts by completion: 'true', 'false', or 'all' (default: all)

Response

{
  "crafts": "array"
}

Try it out

/api/players/360287970203109911/crafts?completed=all

Parameters

id (string) Required

Player entity ID

Response

{
  "bitmap": "string (base64)",
  "exploredChunksCount": "number",
  "regions": "array",
  "meta": {
    "totalChunks": "number",
    "regionCount": "number",
    "chunksPerRegion": "number"
  }
}

Try it out

/api/players/360287970203109911/exploration

Parameters

id (string) Required

Player entity ID

Response

[
  {
    "buildingEntityId": "string",
    "buildingName": "string",
    "playerEntityId": "string",
    "rank": "number",
    "lockedUntil": "string",
    "isEmpty": "boolean",
    "regionId": "number",
    "entranceDimensionId": "number",
    "claimName": "string",
    "claimRegionId": "number",
    "claimEntityId": "string",
    "locationX": "number",
    "locationZ": "number",
    "locationDimension": "number",
    "locationRegionId": "number"
  }
]

Try it out

/api/players/360287970203109911/housing

Parameters

id (string) Required

Player entity ID

houseId (string) Required

Housing entity ID

Response

{
  "buildingEntityId": "string",
  "buildingName": "string",
  "playerEntityId": "string",
  "rank": "number",
  "lockedUntil": "string",
  "isEmpty": "boolean",
  "regionId": "number",
  "entranceDimensionId": "number",
  "claimName": "string",
  "claimRegionId": "number",
  "claimEntityId": "string",
  "locationX": "number",
  "locationZ": "number",
  "locationDimension": "number",
  "inventories": [
    {
      "entityId": "string",
      "inventory": [
        {
          "locked": "boolean",
          "volume": "number",
          "contents": {
            "item_id": "number",
            "quantity": "number",
            "item_type": "string"
          }
        }
      ],
      "buildingName": "string",
      "buildingNickname": "string"
    }
  ],
  "items": [
    {
      "id": "number",
      "name": "string",
      "iconAssetName": "string",
      "rarity": "number",
      "rarityStr": "string",
      "tier": "number",
      "tag": "string"
    }
  ],
  "cargos": [
    {
      "id": "number",
      "name": "string",
      "iconAssetName": "string",
      "rarity": "number",
      "rarityStr": "string",
      "tier": "number",
      "tag": "string"
    }
  ]
}

Try it out

/api/players/360287970203109911/housing/288230376227360710

Parameters

id (string) Required

Player entity ID

q (string) Optional

Filter pockets by item/cargo name. Space-separated partial words match in any order (e.g. "seed fine emb")

Response

{
  "inventories": "array",
  "items": "array",
  "cargos": "array"
}

Try it out

/api/players/360287970203109911/inventories

Parameters

id (string) Required

Player entity ID

status (string) Optional

Filter by status: 'queued', 'processing', 'complete', or 'all'

Response

{
  "craftResults": "array",
  "items": "array",
  "cargos": "array",
  "count": "number"
}

Try it out

/api/players/360287970203109911/passive-crafts?status=all

Parameters

id (string) Required

Player entity ID

Response

{
  "rankings": "object (skillId → { rank, totalPlayers, xp })",
  "totalPlayers": "number"
}

Try it out

/api/players/360287970203109911/skill-rankings

Parameters

id (string) Required

Player entity ID

Response

{
  "stats": {
    "entityId": "string",
    "values": "number[]",
    "regionId": "number",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Try it out

/api/players/360287970203109911/stats

Parameters

id (string) Required

Player entity ID

Response

{
  "tasks": "array",
  "items": "object",
  "cargo": "object",
  "expirationTimestamp": "number | null"
}

Try it out

/api/players/360287970203109911/traveler-tasks

Response

{
  "regions": [
    {
      "regionId": "number",
      "regionName": "string",
      "signedInPlayers": "number",
      "playersInQueue": "number",
      "active": "boolean",
      "syncing": "boolean"
    }
  ]
}

Try it out

/api/regions/status

Parameters

q (string) Optional

Search term for resources (minimum 2 characters)

Response

{
  "resources": "array",
  "count": "number",
  "metrics": {
    "totalResources": "number",
    "totalTags": "number"
  }
}

Try it out

/api/resources?q=oak

Parameters

resourceId (number) Required

Resource ID

Response

{
  "resource": {
    "id": "number",
    "name": "string",
    "description": "string",
    "tier": "number",
    "tag": "string",
    "rarity": "number",
    "max_health": "number",
    "scheduled_respawn_time": "number"
  }
}

Try it out

/api/resources/1

Parameters

bucket (string) Optional

Time bucket: 5 minutes, 1 hour, 4 hours, 8 hours, 12 hours, 1 day, 1 week, 1 month, 1 year (default: 1 hour)

limit (number) Optional

Maximum number of buckets to return (default: 1000)

Response

{
  "buckets": [
    {
      "bucket": "string",
      "inventoryHex": "number",
      "buyOrderState": "number",
      "sellOrderState": "number",
      "claimsTreasury": "number",
      "closedListingState": "number",
      "totalCirculation": "number"
    }
  ]
}

Try it out

/api/stats/hexcoin?bucket=1 day&limit=30

Parameters

bucket (string) Optional

Time bucket: 5 minutes, 1 hour, 4 hours, 8 hours, 12 hours, 1 day, 1 week, 1 month, 1 year (default: 1 hour)

limit (number) Optional

Maximum number of data points (default: 1000)

regionId (number) Optional

Filter by region ID

Response

{
  "buckets": "array",
  "items": "array",
  "overall": "object",
  "regions": "array",
  "selectedRegionId": "number | null"
}

Try it out

/api/stats/trade-volume?bucket=1 day&limit=30

Parameters

bucket (string) Optional

Time bucket: 5 minutes, 1 hour, 4 hours, 8 hours, 12 hours, 1 day, 1 week, 1 month, 1 year (default: 5 minutes)

limit (number) Optional

Number of data points to return (default: 2000)

Response

{
  "count": "number",
  "buckets": "array"
}

Try it out

/api/status/chart?bucket=1 hour&limit=1000

Parameters

limit (number) Optional

Historical data points to return (default: 90, max: 365)

Response

{
  "count": "number",
  "buckets": "array",
  "current": {
    "dau": "number",
    "mau": "number",
    "dauTiers": "object",
    "mauTiers": "object"
  }
}

Try it out

/api/status/dau-mau?limit=30

Response

{
  "params": [
    {
      "id": "number",
      "scale": "number",
      "weight": "number",
      "cycleSec": "string (bigint)"
    }
  ],
  "debug": [
    {
      "id": "number",
      "timeMultiplier": "number"
    }
  ]
}

Try it out

/api/wind

Parameters

regionId (number) Optional

Filter to a single region

Response

{
  "makerTrees": "array",
  "sealedVaults": "array",
  "counts": {
    "makerTreesActive": "number",
    "makerTreesRespawning": "number",
    "sealedVaultsActive": "number",
    "sealedVaultsRespawning": "number"
  },
  "generatedAt": "string"
}

Try it out

/api/world-events

Bitjita API

Parameters

Response

Try it out

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response

Try it out

Parameters

Response