# IMMO API

## GET /dungeons

> Dungeons

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/dungeons":{"get":{"summary":"Dungeons","tags":["IMMO API"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dungeons"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Dungeons":{"type":"object","required":["dungeons","endpoint_updates_at"],"properties":{"dungeons":{"type":"array","items":{"$ref":"#/components/schemas/Dungeon"}},"endpoint_updates_at":{"type":"string"}}},"Dungeon":{"type":"object","required":["id","name","description","image_url","level_required","difficulty","length","cost","shards","completion_requirement","location","loot","experience"],"properties":{"id":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"},"level_required":{"type":"number"},"difficulty":{"type":"number"},"length":{"type":"number"},"cost":{"type":"number"},"shards":{"type":"number"},"completion_requirement":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"loot":{"type":"array","items":{"$ref":"#/components/schemas/LootDrop"}},"experience":{"type":"object","required":["skills"],"properties":{"skills":{"type":"object","required":["combat","dungeoneering"],"properties":{"combat":{"type":"number"},"dungeoneering":{"type":"number"}}}}}}},"Location":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}},"LootDrop":{"type":"object","required":["hashed_item_id","name","image_url","quality","quantity","chance"],"properties":{"hashed_item_id":{"type":"string"},"name":{"type":"string"},"image_url":{"type":"string"},"quality":{"type":"string"},"quantity":{"type":"number"},"chance":{"type":"number"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```

## GET /enemies

> Enemies

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/enemies":{"get":{"summary":"Enemies","tags":["IMMO API"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Enemies"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Enemies":{"type":"object","required":["enemies","endpoint_updates_at"],"properties":{"enemies":{"type":"array","items":{"$ref":"#/components/schemas/Enemy"}},"endpoint_updates_at":{"type":"string"}}},"Enemy":{"type":"object","required":["id","name","image_url","level","experience","health","chance_of_loot","location","loot"],"properties":{"id":{"type":"number"},"name":{"type":"string"},"image_url":{"type":"string"},"level":{"type":"number"},"experience":{"type":"number"},"health":{"type":"number"},"chance_of_loot":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"loot":{"type":"array","items":{"$ref":"#/components/schemas/LootDrop"}}}},"Location":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}},"LootDrop":{"type":"object","required":["hashed_item_id","name","image_url","quality","quantity","chance"],"properties":{"hashed_item_id":{"type":"string"},"name":{"type":"string"},"image_url":{"type":"string"},"quality":{"type":"string"},"quantity":{"type":"number"},"chance":{"type":"number"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```

## GET /worldboss

> WorldBoss

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/worldboss":{"get":{"summary":"WorldBoss","tags":["IMMO API"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorldBoss"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"WorldBoss":{"type":"object","required":["world_bosses","endpoint_updates_at"],"properties":{"world_bosses":{"type":"array","items":{"$ref":"#/components/schemas/WorldBossEntry"}},"endpoint_updates_at":{"type":"string"}}},"WorldBossEntry":{"type":"object","required":["id","name","image_url","level","location","loot","status","battle_starts_at","battle_ends_at"],"properties":{"id":{"type":"number"},"name":{"type":"string"},"image_url":{"type":"string"},"level":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"loot":{"type":"array","items":{"$ref":"#/components/schemas/LootDrop"}},"status":{"type":"string","enum":["READY_FOR_LOBBY","IN_PROGRESS","RESPAWNING"]},"battle_starts_at":{"type":"string"},"battle_ends_at":{"type":"string"}}},"Location":{"type":"object","required":["id","name"],"properties":{"id":{"type":"number"},"name":{"type":"string"}}},"LootDrop":{"type":"object","required":["hashed_item_id","name","image_url","quality","quantity","chance"],"properties":{"hashed_item_id":{"type":"string"},"name":{"type":"string"},"image_url":{"type":"string"},"quality":{"type":"string"},"quantity":{"type":"number"},"chance":{"type":"number"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```

## GET /shrine

> Shrine

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/shrine":{"get":{"summary":"Shrine","tags":["IMMO API"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shrine"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Shrine":{"type":"object","required":["progress","endpoint_updates_at"],"properties":{"progress":{"type":"array","items":{"type":"object","required":["id","tier","effects","current_value","target_value","target_remaining","percentage","goal_reached_at","is_active","in_progress","can_activate"],"properties":{"id":{"type":"number"},"tier":{"type":"object","required":["key","name"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}},"effects":{"type":"array","items":{"type":"object","required":["target","attribute","value","value_type"],"properties":{"target":{"type":"string"},"attribute":{"type":"string"},"value":{"type":"number"},"value_type":{"type":"string"}}}},"current_value":{"type":"number"},"target_value":{"type":"number"},"target_remaining":{"type":"number"},"percentage":{"type":"number"},"goal_reached_at":{"type":"string","nullable":true},"is_active":{"type":"boolean"},"in_progress":{"type":"boolean"},"can_activate":{"type":"boolean"}}}},"endpoint_updates_at":{"type":"string"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```

## GET /Items

> Items

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/Items":{"get":{"summary":"Items","tags":["IMMO API"],"parameters":[{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Items":{"type":"object","required":["date","items","pagination"],"properties":{"date":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"pagination":{"type":"object","required":["current_page","last_page","per_page","total","from","to"],"properties":{"current_page":{"type":"number"},"last_page":{"type":"number"},"per_page":{"type":"number"},"total":{"type":"number"},"from":{"type":"number"},"to":{"type":"number"}}}}},"Item":{"type":"object","required":["hashed_id","name","image_url","type","quality","vendor_price","is_tradeable","max_tier"],"properties":{"hashed_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"},"type":{"type":"string"},"quality":{"type":"string"},"vendor_price":{"type":"number"},"is_tradeable":{"type":"boolean"},"max_tier":{"type":"number"},"pet":{"type":"object","required":["hashed_id","name","description","image_url"],"properties":{"hashed_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"requirements":{"type":"object","properties":{"combat":{"type":"number"},"strength":{"type":"number"},"defence":{"type":"number"},"mining":{"type":"number"},"fishing":{"type":"number"},"woodcutting":{"type":"number"},"dexterity":{"type":"number"}}},"stats":{"type":"object","properties":{"agility":{"type":"number"},"accuracy":{"type":"number"},"attack_power":{"type":"number"},"critical_damage":{"type":"number"},"critical_chance":{"type":"number"},"protection":{"type":"number"},"movement_speed":{"type":"number"}}},"effects":{"type":"array","items":{"type":"object","required":["value","target","attribute","value_type"],"properties":{"value":{"type":"number"},"target":{"type":"string"},"attribute":{"type":"string"},"value_type":{"type":"string"}}}},"tier_modifiers":{"type":"object","properties":{"agility":{"type":"number"},"accuracy":{"type":"number"},"attack_power":{"type":"number"},"critical_damage":{"type":"number"},"protection":{"type":"number"}}},"recipe":{"type":"object","required":["skill","level_required","experience","materials","result"],"properties":{"skill":{"type":"string"},"level_required":{"type":"number"},"max_uses":{"type":"number"},"experience":{"type":"object","required":["stats","skills"],"properties":{"stats":{"type":"object","properties":{"speed":{"type":"number"},"strength":{"type":"number"}}},"skills":{"type":"object","properties":{"alchemy":{"type":"number"},"forge":{"type":"number"}}}}},"materials":{"type":"array","items":{"type":"object","required":["hashed_item_id","item_name","quantity"],"properties":{"hashed_item_id":{"type":"string"},"item_name":{"type":"string"},"quantity":{"type":"number"}}}},"result":{"type":"object","required":["hashed_item_id","item_name"],"properties":{"hashed_item_id":{"type":"string"},"item_name":{"type":"string"}}}}},"upgrade_requirements":{"type":"array","items":{"type":"object","required":["item_id","quantity"],"properties":{"item_id":{"type":"number"},"quantity":{"type":"number"}}}},"health_restore":{"type":"number"},"hunger_restore":{"type":"number"},"where_to_find":{"type":"object","properties":{"dungeons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"enemies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"level":{"type":"number"}}}},"world_bosses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```

## GET /inspect

> Inspect

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/inspect":{"get":{"summary":"Inspect","tags":["IMMO API"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inspect"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Inspect":{"type":"object","required":["item"],"properties":{"item":{"$ref":"#/components/schemas/Item"}}},"Item":{"type":"object","required":["hashed_id","name","image_url","type","quality","vendor_price","is_tradeable","max_tier"],"properties":{"hashed_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"},"type":{"type":"string"},"quality":{"type":"string"},"vendor_price":{"type":"number"},"is_tradeable":{"type":"boolean"},"max_tier":{"type":"number"},"pet":{"type":"object","required":["hashed_id","name","description","image_url"],"properties":{"hashed_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"requirements":{"type":"object","properties":{"combat":{"type":"number"},"strength":{"type":"number"},"defence":{"type":"number"},"mining":{"type":"number"},"fishing":{"type":"number"},"woodcutting":{"type":"number"},"dexterity":{"type":"number"}}},"stats":{"type":"object","properties":{"agility":{"type":"number"},"accuracy":{"type":"number"},"attack_power":{"type":"number"},"critical_damage":{"type":"number"},"critical_chance":{"type":"number"},"protection":{"type":"number"},"movement_speed":{"type":"number"}}},"effects":{"type":"array","items":{"type":"object","required":["value","target","attribute","value_type"],"properties":{"value":{"type":"number"},"target":{"type":"string"},"attribute":{"type":"string"},"value_type":{"type":"string"}}}},"tier_modifiers":{"type":"object","properties":{"agility":{"type":"number"},"accuracy":{"type":"number"},"attack_power":{"type":"number"},"critical_damage":{"type":"number"},"protection":{"type":"number"}}},"recipe":{"type":"object","required":["skill","level_required","experience","materials","result"],"properties":{"skill":{"type":"string"},"level_required":{"type":"number"},"max_uses":{"type":"number"},"experience":{"type":"object","required":["stats","skills"],"properties":{"stats":{"type":"object","properties":{"speed":{"type":"number"},"strength":{"type":"number"}}},"skills":{"type":"object","properties":{"alchemy":{"type":"number"},"forge":{"type":"number"}}}}},"materials":{"type":"array","items":{"type":"object","required":["hashed_item_id","item_name","quantity"],"properties":{"hashed_item_id":{"type":"string"},"item_name":{"type":"string"},"quantity":{"type":"number"}}}},"result":{"type":"object","required":["hashed_item_id","item_name"],"properties":{"hashed_item_id":{"type":"string"},"item_name":{"type":"string"}}}}},"upgrade_requirements":{"type":"array","items":{"type":"object","required":["item_id","quantity"],"properties":{"item_id":{"type":"number"},"quantity":{"type":"number"}}}},"health_restore":{"type":"number"},"hunger_restore":{"type":"number"},"where_to_find":{"type":"object","properties":{"dungeons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}},"enemies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"level":{"type":"number"}}}},"world_bosses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```

## GET /market

> Market

```json
{"openapi":"3.0.3","info":{"title":"IdleMMO API","version":"1.0.3"},"tags":[{"name":"IMMO API"}],"servers":[{"url":"https://immo.soyab.uk"}],"paths":{"/market":{"get":{"summary":"Market","tags":["IMMO API"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"tier","in":"query","required":true,"schema":{"type":"integer","minimum":1}},{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["orders","listings"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Market":{"oneOf":[{"$ref":"#/components/schemas/MarketOrders"},{"$ref":"#/components/schemas/MarketListings"}]},"MarketOrders":{"type":"object","required":["history_data","latest_sold","type","endpoint_updates_at"],"description":"Market Orders","properties":{"history_data":{"type":"array","items":{"$ref":"#/components/schemas/MarketHistoryEntry"}},"latest_sold":{"type":"array","items":{"$ref":"#/components/schemas/LatestSoldOrder"}},"type":{"type":"string"},"endpoint_updates_at":{"type":"string"}}},"MarketHistoryEntry":{"type":"object","required":["date","average_price","total_sold"],"properties":{"date":{"type":"string"},"average_price":{"type":"number"},"total_sold":{"type":"number"}}},"LatestSoldOrder":{"allOf":[{"$ref":"#/components/schemas/LatestSoldListing"},{"type":"object","required":["id"],"properties":{"id":{"type":"number"}}}]},"LatestSoldListing":{"type":"object","required":["item","tier","quantity","price_per_item","total_price","sold_at"],"properties":{"item":{"$ref":"#/components/schemas/ItemRef"},"tier":{"type":"number"},"quantity":{"type":"number"},"price_per_item":{"type":"number"},"total_price":{"type":"number"},"sold_at":{"type":"string"}}},"ItemRef":{"type":"object","required":["hashed_id","name","image_url"],"properties":{"hashed_id":{"type":"string"},"name":{"type":"string"},"image_url":{"type":"string"}}},"MarketListings":{"type":"object","required":["history_data","latest_sold","type","endpoint_updates_at"],"description":"Market Listings","properties":{"history_data":{"type":"array","items":{"$ref":"#/components/schemas/MarketHistoryEntry"}},"latest_sold":{"type":"array","items":{"$ref":"#/components/schemas/LatestSoldListing"}},"type":{"type":"string"},"endpoint_updates_at":{"type":"string"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://immo-docs.soyab.uk/reference/immo-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.