OpenAlbion

https://openalbion.com
Admin
The OpenAlbion API allows developers to access Albion Online game data, such as information on...
Tokens:21,480
Snippets:59
Trust Score:4.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Example Spell Response (JSON)

Source: https://openalbion.com/spells

An example JSON response for the 'Get Spells by Weapon ID' endpoint. It details the structure of the returned data, including spell names, icons, attributes, and descriptions.

```json
{
    "data": [
        {
            "slot": "First Slot",
            "spells": [
                {
                    "id": 1,
                    "name": "Rending Strike",
                    "slot": "First Slot",
                    "preview": "https://wiki.albiononline.com/data/images/d/d4/Rending_Strike.gif",
                    "icon": "https://render.albiononline.com/v1/spell/Rending Strike.png?size=217&locale=en",
                    "attributes": [
                        {
                            "name": "Energy Cost",
                            "value": "6"
                        },
                        {
                            "name": "Cast Time",
                            "value": "Instant"
                        },
                        {
                            "name": "Range",
                            "value": "3m"
                        },
                        {
                            "name": "Cooldown",
                            "value": "2s"
                        }
                    ],
                    "description": "Attack the targeted enemy, dealing 178/196 physical damage.\nApplies one Rending Bleed Charge.\nEach Rending Bleed Charge deals 83/91 over 6s (stacks up to 3 times).\nIf the maximum amount of stacks is reached, the affected enemies' Healing Received is reduced by 12% for 5s.\n\n",
                    "description_html": "Attack the targeted enemy, dealing <span ><i>178</i>/<i>196</i> physical damage</span>.\n<p>Applies one <b>Rending Bleed Charge</b>.\n</p><p>Each <b>Rending Bleed Charge</b> deals <span ><i>83</i>/<i>91</i></span> over <span >6s</span> (<b>stacks</b> up to <b>3</b> times).\n</p><p>If the <b>maximum amount</b> of <b>stacks</b> is reached, the affected enemies' <span >Healing Received</span> is reduced by <span >12%</span> for <span >5s</span>.\n</p>\n"
                },
                {
                    "id": 2,
                    "name": "Rending Spin",
                    "slot": "First Slot",
                    "preview": null,
                    "icon": "https://render.albiononline.com/v1/spell/Rending Spin.png?size=217&locale=en",
                    "attributes": [
                        {
                            "name": "Energy Cost",
                            "value": "10"
                        },
                        {
                            "name": "Cast Time",
                            "value": "instant"
                        },
                        {
                            "name": "Range",
                            "value": "self"
                        },
                        {
                            "name": "Cooldown",
                            "value": "3s"
                        }
                    ],
                    "description": "Swing the weapon around you dealing physical damage to all enemies in a 6m radius around you. Deals 248 to enemies that are at least 3m away and 149 to enemies that are closer than that. Also inflicts a Rending Bleed to each enemy hit, which lasts for 6s and deals 18 physical damage per second. (Stacks up to 3 times.)\nIf you build up 3 stacks, enemies hit will have their healing received reduced by 20% for 5s.\n\n",
                    "description_html": "Swing the weapon around you dealing physical damage to all enemies in a 6m radius around you. Deals <b>248</b> to enemies that are at least 3m away and <b>149</b> to enemies that are closer than that. Also inflicts a Rending Bleed to each enemy hit, which lasts for 6s and deals <b>18</b> physical damage per second. (Stacks up to 3 times.)\n<p>If you build up 3 stacks, enemies hit will have their healing received reduced by 20% for 5s.\n</p>\n"
                }
            ]
        },
        {
            "slot": "Second Slot",
            "spells": [
                {}
            ]
        },
        {
            "slot": "Third Slot",
            "spells": [
                {}
            ]
        },
        {
            "slot": "Passive",
            "spells": [
                {}
            ]
        }
    ]
}
```

--------------------------------

### GET /api/v3/armors - Get All Armors

Source: https://openalbion.com/armors

Retrieve information about all available armors.

```APIDOC
## GET /api/v3/armors

### Description
Retrieve information about all available armors.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/armors

### Parameters
#### Query Parameters
None

### Request Example
```http
GET https://api.openalbion.com/api/v3/armors
```

### Response
#### Success Response (200)
- **data** (array) - An array of armor objects.
  - **id** (integer) - The unique identifier for the armor.
  - **name** (string) - The name of the armor.
  - **tier** (string) - The tier of the armor (e.g., "2.0").
  - **item_power** (integer) - The item power of the armor.
  - **identifier** (string) - The internal identifier for the armor.
  - **icon** (string) - URL to the icon of the armor.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Novice's Scholar Robe",
            "tier": "2.0",
            "item_power": 300,
            "identifier": "T2_ARMOR_CLOTH_SET1",
            "icon": "https://render.albiononline.com/v1/item/T2_ARMOR_CLOTH_SET1@0.png?quality=0&size=217&locale=en"
        },
        {
            "id": 2,
            "name": "Journeyman's Scholar Robe",
            "tier": "3.0",
            "item_power": 500,
            "identifier": "T3_ARMOR_CLOTH_SET1",
            "icon": "https://render.albiononline.com/v1/item/T3_ARMOR_CLOTH_SET1@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### Example JSON Response for Accessory Stats

Source: https://openalbion.com/accessories-stats

This is an example of the JSON response received when querying accessory statistics. It includes enchantment levels, item icons, and a breakdown of various stats like Item Power, Max Energy, and Energy Regeneration for different qualities of the accessory.

```json
{
    "data": [
        {
            "enchantment": 0,
            "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en",
            "stats": [
                {
                    "id": 1,
                    "quality": "Normal",
                    "enchantment": 0,
                    "accessory": {
                        "id": 1,
                        "name": "Novice's Cape",
                        "tier": "2.0",
                        "item_power": 300,
                        "identifier": "T2_CAPE",
                        "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
                    },
                    "stats": [
                        {
                            "name": "Item Power",
                            "value": "300"
                        },
                        {
                            "name": "Max Energy",
                            "value": "3.6"
                        },
                        {
                            "name": "Energy Regeneration",
                            "value": "0.05/s"
                        }
                    ]
                },
                {
                    "id": 2,
                    "quality": "Good",
                    "enchantment": 0,
                    "accessory": {
                        "id": 1,
                        "name": "Novice's Cape",
                        "tier": "2.0",
                        "item_power": 300,
                        "identifier": "T2_CAPE",
                        "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
                    },
                    "stats": [
                        {
                            "name": "Item Power",
                            "value": "320"
                        },
                        {
                            "name": "Max Energy",
                            "value": "3.9"
                        },
                        {
                            "name": "Energy Regeneration",
                            "value": "0.05/s"
                        }
                    ]
                },
                {
                    "id": 3,
                    "quality": "Outstanding",
                    "enchantment": 0,
                    "accessory": {
                        "id": 1,
                        "name": "Novice's Cape",
                        "tier": "2.0",
                        "item_power": 300,
                        "identifier": "T2_CAPE",
                        "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
                    },
                    "stats": [
                        {
                            "name": "Item Power",
                            "value": "340"
                        },
                        {
                            "name": "Max Energy",
                            "value": "4.2"
                        },
                        {
                            "name": "Energy Regeneration",
                            "value": "0.05/s"
                        }
                    ]
                },
                {
                    "id": 4,
                    "quality": "Excellent",
                    "enchantment": 0,
                    "accessory": {
                        "id": 1,
                        "name": "Novice's Cape",
                        "tier": "2.0",
                        "item_power": 300,
                        "identifier": "T2_CAPE",
                        "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
                    },
                    "stats": [
                        {
                            "name": "Item Power",
                            "value": "360"
                        },
                        {
                            "name": "Max Energy",
                            "value": "4.5"
                        },
                        {
                            "name": "Energy Regeneration",
                            "value": "0.06/s"
                        }
                    ]
                },
                {
                    "id": 5,
                    "quality": "Masterpiece",
                    "enchantment": 0,
                    "accessory": {
                        "id": 1,
                        "name": "Novice's Cape",
                        "tier": "2.0",
                        "item_power": 300,
                        "identifier": "T2_CAPE",
                        "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
                    },
                    "stats": [
                        {
                            "name": "Item Power",
                            "value": "380"
                        },
                        {
                            "name": "Max Energy",
                            "value": "4.8"
                        },
                        {
                            "name": "Energy Regeneration",
                            "value": "0.06/s"
                        }
                    ]
                }
            ]
        }
    ]
}
```

--------------------------------

### Get Spells by Accessory ID (JSON Response)

Source: https://openalbion.com/spells

Example JSON response for the 'Get Spells by Accessory ID' endpoint. It illustrates the data structure for spells linked to accessories, including their ID, name, slot, icon, attributes, and descriptions.

```json
{
    "data": [
        {
            "slot": "Passive",
            "spells": [
                {
                    "id": 360,
                    "name": "Sandstorm",
                    "slot": "Passive",
                    "preview": null,
                    "icon": "https://render.albiononline.com/v1/spell/Sandstorm.png?size=217&locale=en",
                    "attributes": [
                        {
                            "name": "Condition:",
                            "value": "Activates when you use your third-slot ability."
                        },
                        {
                            "name": "Effect",
                            "value": "Create a sandstorm in a 4m radius around you, lasting 6s. Slow all enemies within it by 20%. Decreases Crowd Control Resistance by 53."
                        },
                        {
                            "name": "Cooldown",
                            "value": "58s"
                        }
                    ],
                    "description": "Sandstorm is a passive ability found on the Bridgewatch Cape.\n",
                    "description_html": "Sandstorm is a passive ability found on the <b><a href=\"/wiki/Bridgewatch_Cape\"  title=\"Bridgewatch Cape\">Bridgewatch Cape.</a></b>\n"
                }
            ]
        }
    ]
}
```

--------------------------------

### GET /api/v3/armors - Get Armors By Category

Source: https://openalbion.com/armors

Retrieve information about armors filtered by a specific category.

```APIDOC
## GET /api/v3/armors

### Description
Retrieve information about armors filtered by a specific category.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/armors

### Parameters
#### Query Parameters
- **category_id** (integer) - Required - Filter the armors by category. Example: `23`

### Request Example
```http
GET https://api.openalbion.com/api/v3/armors?category_id=23
```

### Response
#### Success Response (200)
- **data** (array) - An array of armor objects matching the category.
  - **id** (integer) - The unique identifier for the armor.
  - **name** (string) - The name of the armor.
  - **tier** (string) - The tier of the armor (e.g., "2.0").
  - **item_power** (integer) - The item power of the armor.
  - **identifier** (string) - The internal identifier for the armor.
  - **icon** (string) - URL to the icon of the armor.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Novice's Scholar Robe",
            "tier": "2.0",
            "item_power": 300,
            "identifier": "T2_ARMOR_CLOTH_SET1",
            "icon": "https://render.albiononline.com/v1/item/T2_ARMOR_CLOTH_SET1@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### GET /api/v3/armors - Get Armors By Tier

Source: https://openalbion.com/armors

Retrieve information about armors filtered by a specific tier.

```APIDOC
## GET /api/v3/armors

### Description
Retrieve information about armors filtered by a specific tier.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/armors

### Parameters
#### Query Parameters
- **tier** (string) - Required - Filter the armors by tier. Example: `4`

### Request Example
```http
GET https://api.openalbion.com/api/v3/armors?tier=4
```

### Response
#### Success Response (200)
- **data** (array) - An array of armor objects matching the tier.
  - **id** (integer) - The unique identifier for the armor.
  - **name** (string) - The name of the armor.
  - **tier** (string) - The tier of the armor (e.g., "4.0").
  - **item_power** (integer) - The item power of the armor.
  - **identifier** (string) - The internal identifier for the armor.
  - **icon** (string) - URL to the icon of the armor.

#### Response Example
```json
{
    "data": [
        {
            "id": 3,
            "name": "Adept's Cleric Robe",
            "tier": "4.0",
            "item_power": 700,
            "identifier": "T4_ARMOR_CLOTH_SET2",
            "icon": "https://render.albiononline.com/v1/item/T4_ARMOR_CLOTH_SET2@0.png?quality=0&size=217&locale=en"
        },
        {
            "id": 4,
            "name": "Adept's Cultist Robe",
            "tier": "4.0",
            "item_power": 775,
            "identifier": "T4_ARMOR_CLOTH_MORGANA",
            "icon": "https://render.albiononline.com/v1/item/T4_ARMOR_CLOTH_MORGANA@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### GET /api/v3/armors - Get Armors By Subcategory

Source: https://openalbion.com/armors

Retrieve information about armors filtered by a specific subcategory.

```APIDOC
## GET /api/v3/armors

### Description
Retrieve information about armors filtered by a specific subcategory.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/armors

### Parameters
#### Query Parameters
- **subcategory_id** (integer) - Required - Filter the armors by subcategory. Example: `24`

### Request Example
```http
GET https://api.openalbion.com/api/v3/armors?subcategory_id=24
```

### Response
#### Success Response (200)
- **data** (array) - An array of armor objects matching the subcategory.
  - **id** (integer) - The unique identifier for the armor.
  - **name** (string) - The name of the armor.
  - **tier** (string) - The tier of the armor (e.g., "2.0").
  - **item_power** (integer) - The item power of the armor.
  - **identifier** (string) - The internal identifier for the armor.
  - **icon** (string) - URL to the icon of the armor.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Novice's Scholar Robe",
            "tier": "2.0",
            "item_power": 300,
            "identifier": "T2_ARMOR_CLOTH_SET1",
            "icon": "https://render.albiononline.com/v1/item/T2_ARMOR_CLOTH_SET1@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### GET /api/v3/consumables

Source: https://openalbion.com/consumables

Retrieve information about all available consumables.

```APIDOC
## GET /api/v3/consumables

### Description
Retrieve information about all available consumables.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/consumables

### Parameters
#### Query Parameters
None

### Request Example
```http
GET https://api.openalbion.com/api/v3/consumables
```

### Response
#### Success Response (200)
- **data** (array) - An array of consumable objects.
  - **id** (integer) - The unique identifier for the consumable.
  - **name** (string) - The name of the consumable.
  - **tier** (string) - The tier of the consumable (e.g., "3.0").
  - **item_power** (integer) - The item power value of the consumable.
  - **identifier** (string) - A unique string identifier for the item.
  - **icon** (string) - URL to the item's icon.
  - **info** (string) - Detailed information about the consumable.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Avalonian Chicken Omelette",
            "tier": "3.0",
            "item_power": 500,
            "identifier": "T3_MEAL_OMELETTE_AVALON",
            "icon": "https://render.albiononline.com/v1/item/T3_MEAL_OMELETTE_AVALON@0.png?quality=0&size=217&locale=en",
            "info": "Players may craft Avalonian Chicken Omelette at the Cook\nAvalonian Chicken Omelette may add nutrition to crafting stations\nPlayers may only have one type of Food active at one time\nEffects of Avalonian Chicken Omelette last for 30 minutes\nAvalonian Chicken Omelette per craft: 10\n"
        },
        {
            "id": 2,
            "name": "Avalonian Goose Omelette",
            "tier": "5.0",
            "item_power": 800,
            "identifier": "T5_MEAL_OMELETTE_AVALON",
            "icon": "https://render.albiononline.com/v1/item/T5_MEAL_OMELETTE_AVALON@0.png?quality=0&size=217&locale=en",
            "info": "Players may craft Avalonian Goose Omelette at the Cook\nAvalonian Goose Omelette may add nutrition to crafting stations\nPlayers may only have one type of Food active at one time\nEffects of Avalonian Goose Omelette last for 30 minutes\nAvalonian Goose Omelette per craft: 10\n"
        }
    ]
}
```
```

--------------------------------

### Get Spells by Armor ID (JSON Response)

Source: https://openalbion.com/spells

Example JSON response for the 'Get Spells by Armor ID' endpoint. It shows the structure of the returned data, including spell details like ID, name, slot, icon, attributes, and descriptions.

```json
{
    "data": [
        {
            "slot": "Fifth Slot",
            "spells": [
                {
                    "id": 261,
                    "name": "Mend Wounds",
                    "slot": "Fifth Slot",
                    "preview": null,
                    "icon": "https://render.albiononline.com/v1/spell/OUTOFCOMBATHEAL.png?size=217&locale=en",
                    "attributes": [
                        {
                            "name": "Energy Cost",
                            "value": "0"
                        },
                        {
                            "name": "Cast Time",
                            "value": "channeled"
                        },
                        {
                            "name": "Range",
                            "value": "self"
                        },
                        {
                            "name": "Cooldown",
                            "value": "30s"
                        }
                    ],
                    "description": "While not engaged in combat, rest while channeling for 12s.\nRestore 6% of your Max Health (not affected by your Healing Cast modifier) and 5% of your Max Energy every 1s.\n\n",
                    "description_html": "While <b>not</b> engaged in <b>combat</b>, rest while <b>channeling</b> for <b>12s</b>.\n<p>Restore <span >6%</span> of your <span >Max Health</span> (not affected by your Healing Cast modifier) and <b>5%</b> of your <b>Max Energy</b> every <b>1s</b>.\n</p>\n"
                },
                {...}
            ]
        },
        {
            "slot": "Passive",
            "spells": [
                {...}
            ]
        }
    ]
}
```

--------------------------------

### Get Accessories by Category (HTTP)

Source: https://openalbion.com/accessories

Retrieves accessories filtered by a specific category. Requires the `category_id` query parameter. The response format is identical to the 'Get All Accessories' endpoint, but limited to the specified category.

```HTTP
GET https://api.openalbion.com/api/v3/accessories?category_id=35
```

--------------------------------

### Get All Accessories

Source: https://openalbion.com/accessories

Retrieves a list of all available accessories. This is the base endpoint for accessory data.

```APIDOC
## GET /api/v3/accessories

### Description
Retrieve information about all accessories.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/accessories

### Parameters
#### Query Parameters
- `category_id` (integer) - Optional - Filter the accessories by category.
- `subcategory_id` (integer) - Optional - Filter the accessories by subcategory.
- `tier` (number) - Optional - Filter the accessories by tier.

### Request Example
```http
GET https://api.openalbion.com/api/v3/accessories
```

### Response
#### Success Response (200)
- `data` (array) - An array of accessory objects.
  - `id` (integer) - The unique identifier for the accessory.
  - `name` (string) - The name of the accessory.
  - `tier` (string) - The tier of the accessory (e.g., "2.0").
  - `item_power` (integer) - The item power of the accessory.
  - `identifier` (string) - The internal identifier for the accessory.
  - `icon` (string) - The URL to the accessory's icon.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Novice's Cape",
            "tier": "2.0",
            "item_power": 300,
            "identifier": "T2_CAPE",
            "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
        },
        {
            "id": 2,
            "name": "Journeyman's Cape",
            "tier": "3.0",
            "item_power": 500,
            "identifier": "T3_CAPE",
            "icon": "https://render.albiononline.com/v1/item/T3_CAPE@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### Get Accessory Categories

Source: https://openalbion.com/categories

Retrieves categories for accessories, such as capes, bags, and mounts, from the OpenAlbion API. This is achieved by making a GET request to the categories endpoint with the 'type' parameter set to 'accessory'.

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

--------------------------------

### GET /api/v3/categories

Source: https://openalbion.com/categories

Retrieve information about OpenAlbion's categories. This endpoint can be filtered by type to get specific category data.

```APIDOC
## GET /api/v3/categories

### Description
Retrieve information about OpenAlbion's categories. This endpoint can be filtered by type to get specific category data.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/categories

### Parameters
#### Query Parameters
- **type** (string) - Required - Filter the categories by type. Example: `weapon`, `armor`, `accessory`, `consumable`

### Request Example
```http
GET https://api.openalbion.com/api/v3/categories?type=weapon
```

### Response
#### Success Response (200)
- **data** (array) - An array of category objects.
  - **id** (integer) - The unique identifier for the category.
  - **name** (string) - The name of the category.
  - **type** (string) - The type of the category (e.g., `weapon`, `armor`).
  - **subcategories** (array) - An array of subcategory objects.
    - **id** (integer) - The unique identifier for the subcategory.
    - **name** (string) - The name of the subcategory.
    - **type** (string) - The type of the subcategory.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Warrior Weapons",
            "type": "weapon",
            "subcategories": [
                {
                    "id": 2,
                    "name": "Axe",
                    "type": "weapon"
                },
                {
                    "id": 3,
                    "name": "Sword",
                    "type": "weapon"
                },
                {"..."}
            ]
        },
        {"..."}
    ]
}
```
```

--------------------------------

### Get Accessories by Subcategory (HTTP)

Source: https://openalbion.com/accessories

Retrieves accessories filtered by a specific subcategory. Requires the `subcategory_id` query parameter. The response includes accessory details, similar to the general 'Get All Accessories' endpoint, but restricted to the given subcategory.

```HTTP
GET https://api.openalbion.com/api/v3/accessories?subcategory_id=37
```

--------------------------------

### Get Accessories By Subcategory

Source: https://openalbion.com/accessories

Retrieves accessories filtered by a specific subcategory ID.

```APIDOC
## GET /api/v3/accessories?subcategory_id={subcategory_id}

### Description
Retrieve information about accessories filtered by a specific subcategory.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/accessories

### Parameters
#### Query Parameters
- **subcategory_id** (integer) - Required - Filter the accessories by subcategory. Example: `37`

### Request Example
```http
GET https://api.openalbion.com/api/v3/accessories?subcategory_id=37
```

### Response
#### Success Response (200)
- `data` (array) - An array of accessory objects matching the subcategory.
  - `id` (integer) - The unique identifier for the accessory.
  - `name` (string) - The name of the accessory.
  - `tier` (string) - The tier of the accessory (e.g., "2.0").
  - `item_power` (integer) - The item power of the accessory.
  - `identifier` (string) - The internal identifier for the accessory.
  - `icon` (string) - The URL to the accessory's icon.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Novice's Cape",
            "tier": "2.0",
            "item_power": 300,
            "identifier": "T2_CAPE",
            "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### Get Accessory Stats by Accessory ID (HTTP Request)

Source: https://openalbion.com/accessories-stats

This snippet shows the HTTP GET request to retrieve accessory statistics. It requires a valid accessory ID as a path parameter. The response will contain detailed stats for the specified accessory.

```http
GET https://api.openalbion.com/api/v3/accessory-stats/accessory/1
```

--------------------------------

### Get Consumable Craftings by Consumable ID (HTTP)

Source: https://openalbion.com/consumable-craftings

This snippet shows how to make an HTTP GET request to retrieve crafting information for a specific consumable. The request requires the consumable's ID as a path parameter. The response includes details about the crafting process, such as enchantment levels, icons, and the list of required ingredients.

```http
GET https://api.openalbion.com/api/v3/consumable-craftings/consumable/18
```

--------------------------------

### Get Armor Categories

Source: https://openalbion.com/categories

Fetches all categories associated with armor from the OpenAlbion API. The request is a simple GET to the categories endpoint with a 'type' query parameter set to 'armor'.

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

--------------------------------

### Get Accessories By Tier

Source: https://openalbion.com/accessories

Retrieves accessories filtered by a specific tier.

```APIDOC
## GET /api/v3/accessories?tier={tier}

### Description
Retrieve information about accessories filtered by a specific tier.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/accessories

### Parameters
#### Query Parameters
- **tier** (number) - Required - Filter the accessories by tier. Example: `4`

### Request Example
```http
GET https://api.openalbion.com/api/v3/accessories?tier=4
```

### Response
#### Success Response (200)
- `data` (array) - An array of accessory objects matching the tier.
  - `id` (integer) - The unique identifier for the accessory.
  - `name` (string) - The name of the accessory.
  - `tier` (string) - The tier of the accessory (e.g., "4.0").
  - `item_power` (integer) - The item power of the accessory.
  - `identifier` (string) - The internal identifier for the accessory.
  - `icon` (string) - The URL to the accessory's icon.

#### Response Example
```json
{
    "data": [
        {
            "id": 3,
            "name": "Adept's Bridgewatch Cape",
            "tier": "4.0",
            "item_power": 700,
            "identifier": "T4_CAPEITEM_FW_BRIDGEWATCH",
            "icon": "https://render.albiononline.com/v1/item/T4_CAPEITEM_FW_BRIDGEWATCH@0.png?quality=0&size=217&locale=en"
        },
        {
            "id": 4,
            "name": "Adept's Caerleon Cape",
            "tier": "4.0",
            "item_power": 700,
            "identifier": "T4_CAPEITEM_FW_CAERLEON",
            "icon": "https://render.albiononline.com/v1/item/T4_CAPEITEM_FW_CAERLEON@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### Get Accessories By Category

Source: https://openalbion.com/accessories

Retrieves accessories filtered by a specific category ID.

```APIDOC
## GET /api/v3/accessories?category_id={category_id}

### Description
Retrieve information about accessories filtered by a specific category.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/accessories

### Parameters
#### Query Parameters
- **category_id** (integer) - Required - Filter the accessories by category. Example: `35`

### Request Example
```http
GET https://api.openalbion.com/api/v3/accessories?category_id=35
```

### Response
#### Success Response (200)
- `data` (array) - An array of accessory objects matching the category.
  - `id` (integer) - The unique identifier for the accessory.
  - `name` (string) - The name of the accessory.
  - `tier` (string) - The tier of the accessory (e.g., "2.0").
  - `item_power` (integer) - The item power of the accessory.
  - `identifier` (string) - The internal identifier for the accessory.
  - `icon` (string) - The URL to the accessory's icon.

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Novice's Cape",
            "tier": "2.0",
            "item_power": 300,
            "identifier": "T2_CAPE",
            "icon": "https://render.albiononline.com/v1/item/T2_CAPE@0.png?quality=0&size=217&locale=en"
        }
    ]
}
```
```

--------------------------------

### GET Consumables by Tier (HTTP)

Source: https://openalbion.com/consumables

This snippet demonstrates how to make an HTTP GET request to the Open Albion API to retrieve consumables filtered by a specific tier. It requires the base API URL and a 'tier' query parameter. The response is a JSON object containing an array of consumable items matching the specified tier.

```http
GET https://api.openalbion.com/api/v3/consumables?tier=4
```

--------------------------------

### GET /api/v3/consumable-craftings/consumable/{consumable_id}

Source: https://openalbion.com/consumable-craftings

Retrieve information about consumable craftings by specifying the consumable ID.

```APIDOC
## GET /api/v3/consumable-craftings/consumable/{consumable_id}

### Description
Retrieve information about consumable craftings by consumable.

### Method
GET

### Endpoint
https://api.openalbion.com/api/v3/consumable-craftings/consumable/{consumable_id}

### Parameters
#### Path Parameters
- **consumable_id** (integer) - Required - The ID of the consumable to retrieve craftings for.

### Request Example
```
GET https://api.openalbion.com/api/v3/consumable-craftings/consumable/18
```

### Response
#### Success Response (200)
- **data** (array) - An array of consumable crafting objects.
  - **enchantment** (integer) - The enchantment level of the crafting.
  - **icon** (string) - The URL of the icon for the crafted item.
  - **crafting** (object) - Details about the crafting process.
    - **id** (integer) - The ID of the crafting.
    - **per_craft** (integer) - The number of items crafted per craft.
    - **enchantment** (integer) - The enchantment level of the crafting.
    - **consumable** (object) - Details about the consumable item.
      - **id** (integer) - The ID of the consumable.
      - **name** (string) - The name of the consumable.
      - **tier** (string) - The tier of the consumable.
      - **item_power** (integer) - The item power of the consumable.
      - **identifier** (string) - The identifier of the consumable.
      - **icon** (string) - The URL of the icon for the consumable.
      - **info** (string) - Additional information about the consumable.
    - **requirements** (array) - An array of crafting requirements.
      - **icon** (string) - The URL of the icon for the requirement item.
      - **name** (string) - The name of the requirement item.
      - **value** (integer) - The quantity of the requirement item needed.
      - **identifier** (string) - The identifier of the requirement item.

#### Response Example
```json
{
    "data": [
        {
            "enchantment": 0,
            "icon": "https://render.albiononline.com/v1/item/T4_MEAL_SALAD_FISH@0.png?quality=0&size=217&locale=en",
            "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/T4_MEAL_SALAD_FISH@0.png?quality=0&size=217&locale=en",
                    "info": "Players may craft Midwater Octopus Salad at the Cook\nMidwater Octopus Salad may add nutrition to crafting stations\nPlayers may only have one type of Food active at one time\nEffects of Midwater Octopus Salad last for 2 minutes\nMidwater Octopus Salad per craft: 1\n"
                },
                "requirements": [
                    {
                        "icon": "https://render.albiononline.com/v1/item/T5_FISH_SALTWATER_ALL_RARE@0.png?quality=0&size=217&locale=en",
                        "name": "Midwater Octopus",
                        "value": 1,
                        "identifier": "T5_FISH_SALTWATER_ALL_RARE"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_TURNIP@0.png?quality=0&size=217&locale=en",
                        "name": "Turnips",
                        "value": 2,
                        "identifier": "T4_TURNIP"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_BURDOCK@0.png?quality=0&size=217&locale=en",
                        "name": "Crenellated Burdock",
                        "value": 2,
                        "identifier": "T4_BURDOCK"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_MEAT@0.png?quality=0&size=217&locale=en",
                        "name": "Raw Goat",
                        "value": 2,
                        "identifier": "T4_MEAT"
                    }
                ]
            }
        },
        {
            "enchantment": 1,
            "icon": "https://render.albiononline.com/v1/item/T4_MEAL_SALAD_FISH@1.png?quality=0&size=217&locale=en",
            "crafting": {
                "id": 70,
                "per_craft": 1,
                "enchantment": 1,
                "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/T4_MEAL_SALAD_FISH@0.png?quality=0&size=217&locale=en",
                    "info": "Players may craft Midwater Octopus Salad at the Cook\nMidwater Octopus Salad may add nutrition to crafting stations\nPlayers may only have one type of Food active at one time\nEffects of Midwater Octopus Salad last for 2 minutes\nMidwater Octopus Salad per craft: 1\n"
                },
                "requirements": [
                    {
                        "icon": "https://render.albiononline.com/v1/item/T5_FISH_SALTWATER_ALL_RARE@0.png?quality=0&size=217&locale=en",
                        "name": "Midwater Octopus",
                        "value": 1,
                        "identifier": "T5_FISH_SALTWATER_ALL_RARE"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_TURNIP@0.png?quality=0&size=217&locale=en",
                        "name": "Turnips",
                        "value": 2,
                        "identifier": "T4_TURNIP"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_BURDOCK@0.png?quality=0&size=217&locale=en",
                        "name": "Crenellated Burdock",
                        "value": 2,
                        "identifier": "T4_BURDOCK"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_MEAT@0.png?quality=0&size=217&locale=en",
                        "name": "Raw Goat",
                        "value": 2,
                        "identifier": "T4_MEAT"
                    },
                    {
                        "icon": "https://render.albiononline.com/v1/item/T4_MEAL_SALAD_FISH@0.png?quality=0&size=217&locale=en",
                        "name": "Midwater Octopus Salad",
                        "value": 1,
                        "identifier": "T4_MEAL_SALAD_FISH"
                    }
                ]
            }
        }
    ]
}
```
```
Tokens:
Raw