#Skills API

The Skills API provides access to all in-game skills, including their descriptions, effects, requirements, and usage information.

#Endpoint

GET /v2/skills

#Authentication

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

#Query Parameters

#Response

#Skill Object

{
  name: string;
  description: string;
  cooldown: number; // Turns before skill can be used again
  charges: number; // -1 for unlimited, 0+ for limited uses
  passive: boolean; // true if always active, false if manually activated
  imageUrl: string; // Cloudinary image URL
  canTargetSelf: boolean; // Whether the skill can target the user
  mustTargetSelf: boolean; // Whether the skill must target only the user
}

#Examples

#Get All Skills

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

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

Response:

[
  {
    "name": "Attack",
    "description": "Bonk for a bit of damage.",
    "cooldown": 0,
    "charges": -1,
    "passive": false,
    "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1611174443/skills/yellow/yellow_41_wctrco.webp",
    "canTargetSelf": false,
    "mustTargetSelf": false
  },
  {
    "name": "Heal",
    "description": "The power of science compels you... to HEAL!",
    "cooldown": 3,
    "charges": 3,
    "passive": false,
    "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1611174447/skills/green/green_20_zzrssq.webp",
    "canTargetSelf": true,
    "mustTargetSelf": false
  },
  {
    "name": "Fleet Feet",
    "description": "You have a higher chance of acting first.",
    "cooldown": 0,
    "charges": -1,
    "passive": true,
    "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1619715785/flat-skill-icons/g_14_nq8wu2.webp",
    "canTargetSelf": false,
    "mustTargetSelf": false
  }
]

#Get Specific Skill

curl -H "X-API-Key: YOUR_API_KEY" \
     "https://api.betweenworlds.net/v2/skills?name=Aimed%20Shot"

Response:

{
  "name": "Aimed Shot",
  "description": "Take your aim and deal 150% damage.",
  "cooldown": 4,
  "charges": -1,
  "passive": false,
  "imageUrl": "https://res.cloudinary.com/between-worlds/image/upload/v1618426424/sci-fiskilliconspack/r_13_ewtxxs.webp",
  "canTargetSelf": false,
  "mustTargetSelf": false
}

#JavaScript Example

const apiKey = 'YOUR_API_KEY';

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

  return response.json();
}

// Get specific skill
async function getSkill(skillName) {
  const url = `https://api.betweenworlds.net/v2/skills?name=${encodeURIComponent(skillName)}`;
  const response = await fetch(url, {
    headers: {
      'X-API-Key': apiKey,
    },
  });

  return response.json();
}

// Usage
getAllSkills().then((skills) => console.log(skills));
getSkill('Aimed Shot').then((skill) => console.log(skill));

#Skill Types

Skills are divided into two main categories based on the passive field:

#Active Skills (passive: false)

Skills that must be manually activated during combat:

• Combat Skills - Attack, Aimed Shot, Flex
• Support Skills - Heal, Recovery, Healing Aura
• Defensive Skills - Block, Flee
• Utility Skills - Skip, Dialogue, Repair
• Summon Skills - Deploy Healing Drone MK1, Spawn Cleaning Bot

#Passive Skills (passive: true)

Skills that are always active and provide constant bonuses:

• Fleet Feet - Higher initiative chance
• Heavy Hands - Lower initiative, increased damage
• Raticide - Bonus damage against rats
• Minor/Major Combat Proficiency - Increased damage
• Minor/Major Healer Proficiency - Increased healing
• Witch's Wisdom - Increased heal charges and healing power

#Skill Properties

#Cooldown

Number of turns before a skill can be used again after activation. A cooldown of 0 means the skill can be used every turn.

#Charges

Number of times a skill can be used:

• -1 - Unlimited uses
• 0+ - Limited number of uses (e.g., 3 charges means usable 3 times)

#Passive

Boolean indicating if the skill is passive:

• true - Always active, provides constant bonuses
• false - Must be manually activated during combat

#Targeting

Two boolean fields control targeting behavior:

• canTargetSelf - Whether the skill can be used on yourself
• mustTargetSelf - Whether the skill can only be used on yourself

Examples:

• canTargetSelf: true, mustTargetSelf: false - Can target self or others (e.g., Heal)
• canTargetSelf: true, mustTargetSelf: true - Must target self (e.g., Block, Flee)
• canTargetSelf: false, mustTargetSelf: false - Can only target others (e.g., Attack)

#Image URL

Cloudinary URL for the skill's icon image.

#Error Responses

#Notes

• Hidden Skills: Some skills may be hidden from the API and won't appear in responses
• Name Parameter: Skill names are case-sensitive. Make sure to URL-encode skill names with spaces
• All Skills: When no name parameter is provided, all non-hidden skills are returned

#Use Cases

• Build skill calculators and planners
• Create skill trees and progression guides
• Display skill information in external tools
• Develop character build tools
• Implement damage calculators