OpenAlbion API Documentation

website·Indexed 32 days ago

API documentation for retrieving Albion Online data, including endpoints for weapons, armors, accessories, consumables, and their respective stats, spells, and crafting requirements.

Tokens: 3.1K
Snippets: 28
Records: 29
Agent score: 50%

What's inside OpenAlbion

Overview of the OpenAlbion API
The OpenAlbion API provides developers with programmatic access to Albion Online data, including information on weapons, armor, and accessories. It is designed for use in websites, mobile applications, and other third-party projects requiring game-specific data via structured API endpoints, request parameters, and response formats.
https://openalbion.com/

Fetch armor categories

Retrieve information about OpenAlbion's armor categories. Use the type=armor query parameter. The response includes armor categories (e.g., 'Cloth Armor') and their subcategories (e.g., 'Robes').

GET https://api.openalbion.com/api/v3/categories?type=armor

{
    "data": [
        {
            "id": 23,
            "name": "Cloth Armor",
            "type": "armor",
            "subcategories": [
                {
                    "id": 24,
                    "name": "Robes",
                    "type": "armor"
                }
            ]
        }
    ]
}

Fetch weapon categories

Retrieve information about OpenAlbion's weapon categories. Use the type=weapon query parameter. The response includes a list of weapon categories (e.g., 'Warrior Weapons') and their specific subcategories (e.g., 'Axe', 'Sword').

GET https://api.openalbion.com/api/v3/categories?type=weapon

{
    "data": [
        {
            "id": 1,
            "name": "Warrior Weapons",
            "type": "weapon",
            "subcategories": [
                {
                    "id": 2,
                    "name": "Axe",
                    "type": "weapon"
                },
                {
                    "id": 3,
                    "name": "Sword",
                    "type": "weapon"
                }
            ]
        }
    ]
}

Fetch accessory categories

Retrieve information about OpenAlbion's accessory categories. Use the type=accessory query parameter. The primary accessory categories are Cape, Bag, and Mount.

GET https://api.openalbion.com/api/v3/categories?type=accessory

{
    "data": [
        {
            "id": 35,
            "name": "Cape",
            "type": "accessory",
            "subcategories": [
                { "id": 37, "name": "Normal Capes", "type": "accessory" },
                { "id": 38, "name": "Faction Capes", "type": "accessory" }
            ]
        },
        {
            "id": 36,
            "name": "Bag",
            "type": "accessory",
            "subcategories": [
                { "id": 39, "name": "Normal Bags", "type": "accessory" }
            ]
        },
        {
            "id": 40,
            "name": "Mount",
            "type": "accessory",
            "subcategories": [
                { "id": 41, "name": "Armored Horses", "type": "accessory" },
                { "id": 42, "name": "Mules", "type": "accessory" }
            ]
        }
    ]
}

Fetch consumable categories

Retrieve information about OpenAlbion's consumable categories. Use the type=consumable query parameter. The primary consumable categories are Food and Potion.

GET https://api.openalbion.com/api/v3/categories?type=consumable

{
    "data": [
        {
            "id": 52,
            "name": "Foods",
            "type": "consumable",
            "subcategories": [
                { "id": 53, "name": "Omelette", "type": "consumable" },
                { "id": 59, "name": "Roast", "type": "consumable" }
            ]
        },
        {
            "id": 60,
            "name": "Potions",
            "type": "consumable",
            "subcategories": [
                { "id": 61, "name": "Energy", "type": "consumable" },
                { "id": 68, "name": "Focus", "type": "consumable" }
            ]
        }
    ]
}

Retrieve consumable crafting requirements by ID

Use the GET method on the /api/v3/consumable-craftings/consumable/{id} endpoint to retrieve the crafting requirements for a specific consumable. The response returns an array of data objects, each corresponding to a different enchantment level of the item. Each record includes the enchantment level, the item icon, and a crafting object containing the item's properties (tier, item power, identifier) and a list of requirements (ingredient name, quantity, and identifier).

// Example response for a consumable (e.g., Midwater Octopus Salad)
{
    "data": [
        {
            "enchantment": 0,
            "icon": "https://render.albiononline.com/v1/item/...",
            "crafting": {
                "id": 69,
                "per_craft": 1,
                "enchantment": 0,
                "consumable": {
                    "id": 18,
                    "name": "Midwater Octopus Salad",
                    "tier": "4.0",
                    "item_power": 700,
                    "identifier": "T4_MEAL_SALAD_FISH",
                    "icon": "https://render.albiononline.com/v1/item/...",
                    "info": "..."
                },
                "requirements": [
                    {
                        "icon": "https://render.albiononline.com/v1/item/...",
                        "name": "Midwater Octopus",
                        "value": 1,
                        "identifier": "T5_FISH_SALTWATER_ALL_RARE"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/...",
                        "name": "Turnips",
                        "value": 2,
                        "identifier": "T4_TURNIP"
                    }
                ]
            }
        }
    ]
}

Filter accessories by subcategory
Retrieve accessories that belong to a specific subcategory by providing the subcategory_id as a query parameter.
```
GET https://api.openalbion.com/api/v3/accessories?subcategory_id=37
```
https://openalbion.com/accessories
Retrieve all armors from OpenAlbion API
Fetch a complete list of armors available in the system. The response includes armor details such as ID, name, tier, item power, internal identifier, and an icon URL.
```
GET https://api.openalbion.com/api/v3/armors
```
https://openalbion.com/armors
Retrieve spells for a specific piece of armor
Use the GET /api/v3/spells/armor/{armor_id} endpoint to retrieve spells associated with a specific armor ID. The response organizes spells by their slot (e.g., Fifth Slot, Passive) and provides detailed attributes and descriptions.
```
GET https://api.openalbion.com/api/v3/spells/armor/1
```
https://openalbion.com/spells
Filter accessories by tier
Retrieve accessories of a specific tier by providing the tier as a query parameter.
```
GET https://api.openalbion.com/api/v3/accessories?tier=4
```
https://openalbion.com/accessories
Filter accessories by category
Retrieve accessories that belong to a specific category by providing the category_id as a query parameter.
```
GET https://api.openalbion.com/api/v3/accessories?category_id=35
```
https://openalbion.com/accessories
Filter consumables by tier
Retrieve a list of consumables filtered by their tier using the tier query parameter.
```
GET https://api.openalbion.com/api/v3/consumables?tier=4
```
https://openalbion.com/consumables