Between Worlds API

Items API

The Items API provides access to all in-game items, including their properties, stats, crafting requirements, and usage information.

Endpoint

GET /v2/items

Authentication

All requests require the X-API-Key header. See Authentication for details.

Query Parameters

ParameterTypeRequiredDescription
namestringNoFilter for a specific item by name

Response

Item Object

{
  name: string;
  qualityAdjectives: string[]; // 5 quality levels
  worthMultiplier: number;
  level: number;
  imageUrl: string;
  qualityDescriptions: string[]; // 5 quality descriptions
  type: number; // 1=Consumable, 2=Equipment, 3=Material, 4=Quest, 5=Resource

  // Equipment-specific (type 2)
  equipmentType?: number; // 1=Head, 2=Torso, 3=Mainhand, 5=Waist, 6=Legs, 7=Feet, 13=Ship
  modules?: any[];
  moduleSlots?: number;
  skillEffects?: Array<{
    id: string;
    activationChance: number;
    activationCooldown: number;
    type: string;
    skillName: string;
  }>;

  // Consumable-specific (type 1)
  consumeEffects?: Array<{
    type: number;
    min?: number;
    max?: number;
    duration?: number;
    skillName?: string;
    craftingSchematicName?: string;
    worthMultiplier?: number;
  }>;
  overdoseChance?: number;
  overdoseCooldown?: number;
}

Examples

Get All Items

Returns a list of all items in the game (excluding items marked as hidden from API).

curl -H "X-API-Key: YOUR_API_KEY" \
     https://api.betweenworlds.net/v2/items

Response:

[
  {
    "name": "Metal Stick",
    "qualityAdjectives": ["Ragged", "Rough", "Reliable", "Polished", "Exquisite"],
    "worthMultiplier": 100,
    "level": 3,
    "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1690636345/items/tradingicons/tradingicons_89_xjh16c.webp",
    "qualityDescriptions": [
      "It's a stick with metal attached.",
      "It's a stick with metal attached.",
      "It's a stick with metal attached.",
      "It's a stick with metal attached.",
      "It's a stick with metal attached."
    ],
    "type": 2,
    "equipmentType": 3,
    "modules": [],
    "moduleSlots": 0
  },
  {
    "name": "Nutrient Packet",
    "qualityAdjectives": ["Weak", "Mild", "Potent", "Strong", "Overwhelming"],
    "worthMultiplier": 8,
    "level": 1,
    "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1690642026/items/sci-fiiconspack/b_37_jtvr8w.webp",
    "qualityDescriptions": [
      "You can put whatever you want inside. People still eat it.",
      "You can put whatever you want inside. People still eat it.",
      "You can put whatever you want inside. People still eat it.",
      "You can put whatever you want inside. People still eat it.",
      "You can put whatever you want inside. People still eat it."
    ],
    "type": 1,
    "overdoseChance": 10,
    "overdoseCooldown": 1,
    "consumeEffects": [
      { "type": 3, "min": 2, "max": 4 },
      { "type": 2, "min": 2, "max": 4 }
    ]
  },
  {
    "name": "Metal Covered Shirt",
    "qualityAdjectives": ["Ragged", "Rough", "Reliable", "Polished", "Exquisite"],
    "worthMultiplier": 25,
    "level": 3,
    "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1618670593/sci-fi-armor-icons/armor_s06_swnp42.webp",
    "qualityDescriptions": [
      "A shirt covered in metal.",
      "A shirt covered in metal.",
      "A shirt covered in metal.",
      "A shirt covered in metal.",
      "A shirt covered in metal."
    ],
    "type": 2,
    "equipmentType": 2,
    "modules": [],
    "moduleSlots": 0
  }
]

Get Specific Item

curl -H "X-API-Key: YOUR_API_KEY" \
     "https://api.betweenworlds.net/v2/items?name=Shield%20Belt"

Response:

{
  "name": "Shield Belt",
  "qualityAdjectives": ["Ragged", "Rough", "Reliable", "Polished", "Exquisite"],
  "worthMultiplier": 15000,
  "level": 1,
  "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1618670587/sci-fi-armor-icons/belt_s03_krf3f2.webp",
  "qualityDescriptions": [
    "A portable electrical shield which automatically intercepts attacks.",
    "A portable electrical shield which automatically intercepts attacks.",
    "A portable electrical shield which automatically intercepts attacks.",
    "A portable electrical shield which automatically intercepts attacks.",
    "A portable electrical shield which automatically intercepts attacks."
  ],
  "type": 2,
  "equipmentType": 5,
  "modules": [],
  "moduleSlots": 0,
  "skillEffects": [
    {
      "id": "shield_belt_interception",
      "activationChance": 70,
      "activationCooldown": 4,
      "type": "Passive",
      "skillName": "Shield Belt Interception"
    }
  ]
}

JavaScript Example

const apiKey = 'YOUR_API_KEY';

// Get all items
async function getAllItems() {
  const response = await fetch('https://api.betweenworlds.net/v2/items', {
    headers: {
      'X-API-Key': apiKey,
    },
  });

  return response.json();
}

// Get specific item
async function getItem(itemName) {
  const params = new URLSearchParams({
    name: itemName,
  });

  const response = await fetch(`https://api.betweenworlds.net/v2/items?${params}`, {
    headers: {
      'X-API-Key': apiKey,
    },
  });

  return response.json();
}

// Usage
getAllItems().then((items) => console.log(items));
getItem('Shield Belt').then((item) => console.log(item));

Item Types

Items have a numeric type field with the following values:

  • 1 - Consumable - Potions, food items, scrolls with various effects
  • 2 - Equipment - Weapons, armour, and wearable items
  • 3 - Material - Crafting components and materials
  • 4 - Quest - Special items for missions and quests
  • 5 - Resource - Raw resources and tradeable goods

Equipment Types

For items with type: 2, the equipmentType field specifies the slot:

  • 1 - Head (helmets, hats, hoods)
  • 2 - Torso (shirts, armour, jackets)
  • 3 - Mainhand (weapons, tools)
  • 5 - Waist (belts)
  • 6 - Legs (pants, shorts, greaves)
  • 7 - Feet (boots, shoes, sandals)
  • 13 - Ship (vehicles)

Error Responses

Status CodeDescription
400 Bad RequestInvalid parameters, unknown item name, or item is hidden from API
405 Method Not AllowedOnly GET requests are supported

Notes

  • Hidden Items: Some items may be hidden from the API and won't appear in responses
  • Populated Data: Items are returned with full details including crafting requirements and related information
  • Name Parameter: Item names are case-sensitive. Make sure to URL-encode item names with spaces
  • All Items: When no name parameter is provided, all non-hidden items are returned

Use Cases

  • Display item catalogs in external tools
  • Build crafting calculators
  • Create item databases and wikis
  • Implement trade value trackers
  • Develop inventory management tools